package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2023-07-01/deploymentoperations Documentation

The deploymentoperations SDK allows for interaction with the Azure Resource Manager Service resources (API Version 2023-07-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2023-07-01/deploymentoperations"

Client Initialization

client := deploymentoperations.NewDeploymentOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeploymentOperationsClient.Get

ctx := context.TODO()
id := deploymentoperations.NewResourceGroupDeploymentOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "deploymentValue", "operationIdValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DeploymentOperationsClient.GetAtManagementGroupScope

ctx := context.TODO()
id := deploymentoperations.NewProviders2DeploymentOperationID("groupIdValue", "deploymentValue", "operationIdValue")

read, err := client.GetAtManagementGroupScope(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DeploymentOperationsClient.GetAtScope

ctx := context.TODO()
id := deploymentoperations.NewScopedOperationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "deploymentValue", "operationIdValue")

read, err := client.GetAtScope(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DeploymentOperationsClient.GetAtSubscriptionScope

ctx := context.TODO()
id := deploymentoperations.NewDeploymentOperationID("12345678-1234-9876-4563-123456789012", "deploymentValue", "operationIdValue")

read, err := client.GetAtSubscriptionScope(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DeploymentOperationsClient.GetAtTenantScope

ctx := context.TODO()
id := deploymentoperations.NewOperationID("deploymentValue", "operationIdValue")

read, err := client.GetAtTenantScope(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DeploymentOperationsClient.List

ctx := context.TODO()
id := deploymentoperations.NewResourceGroupDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "deploymentValue")

// alternatively `client.List(ctx, id, deploymentoperations.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, deploymentoperations.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DeploymentOperationsClient.ListAtManagementGroupScope

ctx := context.TODO()
id := deploymentoperations.NewProviders2DeploymentID("groupIdValue", "deploymentValue")

// alternatively `client.ListAtManagementGroupScope(ctx, id, deploymentoperations.DefaultListAtManagementGroupScopeOperationOptions())` can be used to do batched pagination
items, err := client.ListAtManagementGroupScopeComplete(ctx, id, deploymentoperations.DefaultListAtManagementGroupScopeOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DeploymentOperationsClient.ListAtScope

ctx := context.TODO()
id := deploymentoperations.NewScopedDeploymentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "deploymentValue")

// alternatively `client.ListAtScope(ctx, id, deploymentoperations.DefaultListAtScopeOperationOptions())` can be used to do batched pagination
items, err := client.ListAtScopeComplete(ctx, id, deploymentoperations.DefaultListAtScopeOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DeploymentOperationsClient.ListAtSubscriptionScope

ctx := context.TODO()
id := deploymentoperations.NewProviderDeploymentID("12345678-1234-9876-4563-123456789012", "deploymentValue")

// alternatively `client.ListAtSubscriptionScope(ctx, id, deploymentoperations.DefaultListAtSubscriptionScopeOperationOptions())` can be used to do batched pagination
items, err := client.ListAtSubscriptionScopeComplete(ctx, id, deploymentoperations.DefaultListAtSubscriptionScopeOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DeploymentOperationsClient.ListAtTenantScope

ctx := context.TODO()
id := deploymentoperations.NewDeploymentID("deploymentValue")

// alternatively `client.ListAtTenantScope(ctx, id, deploymentoperations.DefaultListAtTenantScopeOperationOptions())` can be used to do batched pagination
items, err := client.ListAtTenantScopeComplete(ctx, id, deploymentoperations.DefaultListAtTenantScopeOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewDeploymentID returns a new DeploymentId struct.
NewDeploymentOperationID returns a new DeploymentOperationId struct.
No description provided by the author
NewOperationID returns a new OperationId struct.
NewProviderDeploymentID returns a new ProviderDeploymentId struct.
NewProviders2DeploymentID returns a new Providers2DeploymentId struct.
NewProviders2DeploymentOperationID returns a new Providers2DeploymentOperationId struct.
NewResourceGroupDeploymentID returns a new ResourceGroupDeploymentId struct.
NewResourceGroupDeploymentOperationID returns a new ResourceGroupDeploymentOperationId struct.
NewScopedDeploymentID returns a new ScopedDeploymentId struct.
NewScopedOperationID returns a new ScopedOperationId struct.
ParseDeploymentID parses 'input' into a DeploymentId.
ParseDeploymentIDInsensitively parses 'input' case-insensitively into a DeploymentId note: this method should only be used for API response data and not user input.
ParseDeploymentOperationID parses 'input' into a DeploymentOperationId.
ParseDeploymentOperationIDInsensitively parses 'input' case-insensitively into a DeploymentOperationId note: this method should only be used for API response data and not user input.
ParseOperationID parses 'input' into a OperationId.
ParseOperationIDInsensitively parses 'input' case-insensitively into a OperationId note: this method should only be used for API response data and not user input.
ParseProviderDeploymentID parses 'input' into a ProviderDeploymentId.
ParseProviderDeploymentIDInsensitively parses 'input' case-insensitively into a ProviderDeploymentId note: this method should only be used for API response data and not user input.
ParseProviders2DeploymentID parses 'input' into a Providers2DeploymentId.
ParseProviders2DeploymentIDInsensitively parses 'input' case-insensitively into a Providers2DeploymentId note: this method should only be used for API response data and not user input.
ParseProviders2DeploymentOperationID parses 'input' into a Providers2DeploymentOperationId.
ParseProviders2DeploymentOperationIDInsensitively parses 'input' case-insensitively into a Providers2DeploymentOperationId note: this method should only be used for API response data and not user input.
ParseResourceGroupDeploymentID parses 'input' into a ResourceGroupDeploymentId.
ParseResourceGroupDeploymentIDInsensitively parses 'input' case-insensitively into a ResourceGroupDeploymentId note: this method should only be used for API response data and not user input.
ParseResourceGroupDeploymentOperationID parses 'input' into a ResourceGroupDeploymentOperationId.
ParseResourceGroupDeploymentOperationIDInsensitively parses 'input' case-insensitively into a ResourceGroupDeploymentOperationId note: this method should only be used for API response data and not user input.
ParseScopedDeploymentID parses 'input' into a ScopedDeploymentId.
ParseScopedDeploymentIDInsensitively parses 'input' case-insensitively into a ScopedDeploymentId note: this method should only be used for API response data and not user input.
ParseScopedOperationID parses 'input' into a ScopedOperationId.
ParseScopedOperationIDInsensitively parses 'input' case-insensitively into a ScopedOperationId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateDeploymentID checks that 'input' can be parsed as a Deployment ID.
ValidateDeploymentOperationID checks that 'input' can be parsed as a Deployment Operation ID.
ValidateOperationID checks that 'input' can be parsed as a Operation ID.
ValidateProviderDeploymentID checks that 'input' can be parsed as a Provider Deployment ID.
ValidateProviders2DeploymentID checks that 'input' can be parsed as a Providers 2 Deployment ID.
ValidateProviders2DeploymentOperationID checks that 'input' can be parsed as a Providers 2 Deployment Operation ID.
ValidateResourceGroupDeploymentID checks that 'input' can be parsed as a Resource Group Deployment ID.
ValidateResourceGroupDeploymentOperationID checks that 'input' can be parsed as a Resource Group Deployment Operation ID.
ValidateScopedDeploymentID checks that 'input' can be parsed as a Scoped Deployment ID.
ValidateScopedOperationID checks that 'input' can be parsed as a Scoped Operation ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

DeploymentId is a struct representing the Resource ID for a Deployment.
No description provided by the author
DeploymentOperationId is a struct representing the Resource ID for a Deployment Operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OperationId is a struct representing the Resource ID for a Operation.
ProviderDeploymentId is a struct representing the Resource ID for a Provider Deployment.
Providers2DeploymentId is a struct representing the Resource ID for a Providers 2 Deployment.
Providers2DeploymentOperationId is a struct representing the Resource ID for a Providers 2 Deployment Operation.
ResourceGroupDeploymentId is a struct representing the Resource ID for a Resource Group Deployment.
ResourceGroupDeploymentOperationId is a struct representing the Resource ID for a Resource Group Deployment Operation.
ScopedDeploymentId is a struct representing the Resource ID for a Scoped Deployment.
ScopedOperationId is a struct representing the Resource ID for a Scoped Operation.
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author