github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-10-01/deployments Documentation

The deployments SDK allows for interaction with the Azure Resource Manager Service resources (API Version 2020-10-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-10-01/deployments"

Client Initialization

client := deployments.NewDeploymentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeploymentsClient.CalculateTemplateHash

ctx := context.TODO()
var payload interface{}

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

Example Usage: DeploymentsClient.Cancel

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

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

Example Usage: DeploymentsClient.CancelAtManagementGroupScope

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

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

Example Usage: DeploymentsClient.CancelAtScope

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

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

Example Usage: DeploymentsClient.CancelAtSubscriptionScope

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

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

Example Usage: DeploymentsClient.CancelAtTenantScope

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

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

Example Usage: DeploymentsClient.CheckExistence

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

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

Example Usage: DeploymentsClient.CheckExistenceAtManagementGroupScope

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

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

Example Usage: DeploymentsClient.CheckExistenceAtScope

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

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

Example Usage: DeploymentsClient.CheckExistenceAtSubscriptionScope

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

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

Example Usage: DeploymentsClient.CheckExistenceAtTenantScope

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

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

Example Usage: DeploymentsClient.CreateOrUpdate

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

payload := deployments.Deployment{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.CreateOrUpdateAtManagementGroupScope

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

payload := deployments.ScopedDeployment{
	// ...
}


if err := client.CreateOrUpdateAtManagementGroupScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.CreateOrUpdateAtScope

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

payload := deployments.Deployment{
	// ...
}


if err := client.CreateOrUpdateAtScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.CreateOrUpdateAtSubscriptionScope

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

payload := deployments.Deployment{
	// ...
}


if err := client.CreateOrUpdateAtSubscriptionScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.CreateOrUpdateAtTenantScope

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

payload := deployments.ScopedDeployment{
	// ...
}


if err := client.CreateOrUpdateAtTenantScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.Delete

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

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.DeleteAtManagementGroupScope

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

if err := client.DeleteAtManagementGroupScopeThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.DeleteAtScope

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

if err := client.DeleteAtScopeThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.DeleteAtSubscriptionScope

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

if err := client.DeleteAtSubscriptionScopeThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.DeleteAtTenantScope

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

if err := client.DeleteAtTenantScopeThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.ExportTemplate

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

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

Example Usage: DeploymentsClient.ExportTemplateAtManagementGroupScope

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

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

Example Usage: DeploymentsClient.ExportTemplateAtScope

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

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

Example Usage: DeploymentsClient.ExportTemplateAtSubscriptionScope

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

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

Example Usage: DeploymentsClient.ExportTemplateAtTenantScope

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

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

Example Usage: DeploymentsClient.Get

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

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: DeploymentsClient.GetAtManagementGroupScope

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

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: DeploymentsClient.GetAtScope

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

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: DeploymentsClient.GetAtSubscriptionScope

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

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: DeploymentsClient.GetAtTenantScope

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

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: DeploymentsClient.ListAtManagementGroupScope

ctx := context.TODO()
id := commonids.NewManagementGroupID("groupIdValue")

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

Example Usage: DeploymentsClient.ListAtScope

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: DeploymentsClient.ListAtSubscriptionScope

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: DeploymentsClient.ListAtTenantScope

ctx := context.TODO()


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

Example Usage: DeploymentsClient.ListByResourceGroup

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

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

Example Usage: DeploymentsClient.Validate

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

payload := deployments.Deployment{
	// ...
}


if err := client.ValidateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.ValidateAtManagementGroupScope

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

payload := deployments.ScopedDeployment{
	// ...
}


if err := client.ValidateAtManagementGroupScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.ValidateAtScope

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

payload := deployments.Deployment{
	// ...
}


if err := client.ValidateAtScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.ValidateAtSubscriptionScope

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

payload := deployments.Deployment{
	// ...
}


if err := client.ValidateAtSubscriptionScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.ValidateAtTenantScope

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

payload := deployments.ScopedDeployment{
	// ...
}


if err := client.ValidateAtTenantScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.WhatIf

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

payload := deployments.DeploymentWhatIf{
	// ...
}


if err := client.WhatIfThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.WhatIfAtManagementGroupScope

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

payload := deployments.ScopedDeploymentWhatIf{
	// ...
}


if err := client.WhatIfAtManagementGroupScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.WhatIfAtSubscriptionScope

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

payload := deployments.DeploymentWhatIf{
	// ...
}


if err := client.WhatIfAtSubscriptionScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DeploymentsClient.WhatIfAtTenantScope

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

payload := deployments.ScopedDeploymentWhatIf{
	// ...
}


if err := client.WhatIfAtTenantScopeThenPoll(ctx, id, payload); err != nil {
	// handle the error
}