armresources

package module
v2.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 27, 2025 License: MIT Imports: 15 Imported by: 0

README

Azure Resources Module for Go

The armresources module provides operations for working with Azure Resources.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Resources module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources/v2

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Resources. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Resources module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armresources.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armresources.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

More sample code

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Resources label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIProfile 

type APIProfile struct {
	// READ-ONLY; The API version.
	APIVersion *string

	// READ-ONLY; The profile version.
	ProfileVersion *string
}

func (APIProfile) MarshalJSON 

func (a APIProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIProfile.

func (*APIProfile) UnmarshalJSON 

func (a *APIProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIProfile.

type Alias 

type Alias struct {
	// The default path for an alias.
	DefaultPath *string

	// The default pattern for an alias.
	DefaultPattern *AliasPattern

	// The alias name.
	Name *string

	// The paths for an alias.
	Paths []*AliasPath

	// The type of the alias.
	Type *AliasType

	// READ-ONLY; The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata
	DefaultMetadata *AliasPathMetadata
}

Alias - The alias type.

func (Alias) MarshalJSON 

func (a Alias) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Alias.

func (*Alias) UnmarshalJSON 

func (a *Alias) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Alias.

type AliasPath 

type AliasPath struct {
	// The API versions.
	APIVersions []*string

	// The path of an alias.
	Path *string

	// The pattern for an alias path.
	Pattern *AliasPattern

	// READ-ONLY; The metadata of the alias path. If missing, fall back to the default metadata of the alias.
	Metadata *AliasPathMetadata
}

AliasPath - The type of the paths for alias.

func (AliasPath) MarshalJSON 

func (a AliasPath) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AliasPath.

func (*AliasPath) UnmarshalJSON 

func (a *AliasPath) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AliasPath.

type AliasPathAttributes 

type AliasPathAttributes string

AliasPathAttributes - The attributes of the token that the alias path is referring to. 

const (
	// AliasPathAttributesModifiable - The token that the alias path is referring to is modifiable by policies with 'modify' effect.
	AliasPathAttributesModifiable AliasPathAttributes = "Modifiable"
	// AliasPathAttributesNone - The token that the alias path is referring to has no attributes.
	AliasPathAttributesNone AliasPathAttributes = "None"
)

func PossibleAliasPathAttributesValues 

func PossibleAliasPathAttributesValues() []AliasPathAttributes

PossibleAliasPathAttributesValues returns the possible values for the AliasPathAttributes const type.

type AliasPathMetadata 

type AliasPathMetadata struct {
	// READ-ONLY; The attributes of the token that the alias path is referring to.
	Attributes *AliasPathAttributes

	// READ-ONLY; The type of the token that the alias path is referring to.
	Type *AliasPathTokenType
}

func (AliasPathMetadata) MarshalJSON 

func (a AliasPathMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AliasPathMetadata.

func (*AliasPathMetadata) UnmarshalJSON 

func (a *AliasPathMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AliasPathMetadata.

type AliasPathTokenType 

type AliasPathTokenType string

AliasPathTokenType - The type of the token that the alias path is referring to. 

const (
	// AliasPathTokenTypeAny - The token type can be anything.
	AliasPathTokenTypeAny AliasPathTokenType = "Any"
	// AliasPathTokenTypeArray - The token type is array.
	AliasPathTokenTypeArray AliasPathTokenType = "Array"
	// AliasPathTokenTypeBoolean - The token type is boolean.
	AliasPathTokenTypeBoolean AliasPathTokenType = "Boolean"
	// AliasPathTokenTypeInteger - The token type is integer.
	AliasPathTokenTypeInteger AliasPathTokenType = "Integer"
	// AliasPathTokenTypeNotSpecified - The token type is not specified.
	AliasPathTokenTypeNotSpecified AliasPathTokenType = "NotSpecified"
	// AliasPathTokenTypeNumber - The token type is number.
	AliasPathTokenTypeNumber AliasPathTokenType = "Number"
	// AliasPathTokenTypeObject - The token type is object.
	AliasPathTokenTypeObject AliasPathTokenType = "Object"
	// AliasPathTokenTypeString - The token type is string.
	AliasPathTokenTypeString AliasPathTokenType = "String"
)

func PossibleAliasPathTokenTypeValues 

func PossibleAliasPathTokenTypeValues() []AliasPathTokenType

PossibleAliasPathTokenTypeValues returns the possible values for the AliasPathTokenType const type.

type AliasPattern 

type AliasPattern struct {
	// The alias pattern phrase.
	Phrase *string

	// The type of alias pattern
	Type *AliasPatternType

	// The alias pattern variable.
	Variable *string
}

AliasPattern - The type of the pattern for an alias path.

func (AliasPattern) MarshalJSON 

func (a AliasPattern) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AliasPattern.

func (*AliasPattern) UnmarshalJSON 

func (a *AliasPattern) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AliasPattern.

type AliasPatternType 

type AliasPatternType string

AliasPatternType - The type of alias pattern 

const (
	// AliasPatternTypeExtract - Extract is the only allowed value.
	AliasPatternTypeExtract AliasPatternType = "Extract"
	// AliasPatternTypeNotSpecified - NotSpecified is not allowed.
	AliasPatternTypeNotSpecified AliasPatternType = "NotSpecified"
)

func PossibleAliasPatternTypeValues 

func PossibleAliasPatternTypeValues() []AliasPatternType

PossibleAliasPatternTypeValues returns the possible values for the AliasPatternType const type.

type AliasType 

type AliasType string

AliasType - The type of the alias. 

const (
	// AliasTypeMask - Alias value is secret.
	AliasTypeMask AliasType = "Mask"
	// AliasTypeNotSpecified - Alias type is unknown (same as not providing alias type).
	AliasTypeNotSpecified AliasType = "NotSpecified"
	// AliasTypePlainText - Alias value is not secret.
	AliasTypePlainText AliasType = "PlainText"
)

func PossibleAliasTypeValues 

func PossibleAliasTypeValues() []AliasType

PossibleAliasTypeValues returns the possible values for the AliasType const type.

type BasicDependency 

type BasicDependency struct {
	// The ID of the dependency.
	ID *string

	// The dependency resource name.
	ResourceName *string

	// The dependency resource type.
	ResourceType *string
}

BasicDependency - Deployment dependency information.

func (BasicDependency) MarshalJSON 

func (b BasicDependency) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BasicDependency.

func (*BasicDependency) UnmarshalJSON 

func (b *BasicDependency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BasicDependency.

type ChangeType 

type ChangeType string

ChangeType - Type of change that will be made to the resource when the deployment is executed. 

const (
	// ChangeTypeCreate - The resource does not exist in the current state but is present in the desired state. The resource will
	// be created when the deployment is executed.
	ChangeTypeCreate ChangeType = "Create"
	// ChangeTypeDelete - The resource exists in the current state and is missing from the desired state. The resource will be
	// deleted when the deployment is executed.
	ChangeTypeDelete ChangeType = "Delete"
	// ChangeTypeDeploy - The resource exists in the current state and the desired state and will be redeployed when the deployment
	// is executed. The properties of the resource may or may not change.
	ChangeTypeDeploy ChangeType = "Deploy"
	// ChangeTypeIgnore - The resource exists in the current state and is missing from the desired state. The resource will not
	// be deployed or modified when the deployment is executed.
	ChangeTypeIgnore ChangeType = "Ignore"
	// ChangeTypeModify - The resource exists in the current state and the desired state and will be redeployed when the deployment
	// is executed. The properties of the resource will change.
	ChangeTypeModify ChangeType = "Modify"
	// ChangeTypeNoChange - The resource exists in the current state and the desired state and will be redeployed when the deployment
	// is executed. The properties of the resource will not change.
	ChangeTypeNoChange ChangeType = "NoChange"
	// ChangeTypeUnsupported - The resource is not supported by What-If.
	ChangeTypeUnsupported ChangeType = "Unsupported"
)

func PossibleChangeTypeValues 

func PossibleChangeTypeValues() []ChangeType

PossibleChangeTypeValues returns the possible values for the ChangeType const type.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client contains the methods for the Resources group. Don't use this type directly, use NewClient() instead.

func NewClient 

func NewClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*Client, error)

NewClient creates a new instance of Client with the specified values.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*Client) BeginCreateOrUpdate 

func (client *Client) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, parameters GenericResource, options *ClientBeginCreateOrUpdateOptions) (*runtime.Poller[ClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group for the resource. The name is case insensitive.
  • resourceProviderNamespace - The namespace of the resource provider.
  • parentResourcePath - The parent resource identity.
  • resourceType - The resource type of the resource to create.
  • resourceName - The name of the resource to create.
  • apiVersion - The API version to use for the operation.
  • parameters - Parameters for creating or updating the resource.
  • options - ClientBeginCreateOrUpdateOptions contains the optional parameters for the Client.BeginCreateOrUpdate method.

func (*Client) BeginCreateOrUpdateByID 

func (client *Client) BeginCreateOrUpdateByID(ctx context.Context, resourceID string, apiVersion string, parameters GenericResource, options *ClientBeginCreateOrUpdateByIDOptions) (*runtime.Poller[ClientCreateOrUpdateByIDResponse], error)

BeginCreateOrUpdateByID - Create a resource by ID. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceID - The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
  • apiVersion - The API version to use for the operation.
  • parameters - Create or update resource parameters.
  • options - ClientBeginCreateOrUpdateByIDOptions contains the optional parameters for the Client.BeginCreateOrUpdateByID method.

func (*Client) BeginDelete 

func (client *Client) BeginDelete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, options *ClientBeginDeleteOptions) (*runtime.Poller[ClientDeleteResponse], error)

BeginDelete - Deletes a resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group that contains the resource to delete. The name is case insensitive.
  • resourceProviderNamespace - The namespace of the resource provider.
  • parentResourcePath - The parent resource identity.
  • resourceType - The resource type.
  • resourceName - The name of the resource to delete.
  • apiVersion - The API version to use for the operation.
  • options - ClientBeginDeleteOptions contains the optional parameters for the Client.BeginDelete method.

func (*Client) BeginDeleteByID 

func (client *Client) BeginDeleteByID(ctx context.Context, resourceID string, apiVersion string, options *ClientBeginDeleteByIDOptions) (*runtime.Poller[ClientDeleteByIDResponse], error)

BeginDeleteByID - Deletes a resource by ID. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceID - The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
  • apiVersion - The API version to use for the operation.
  • options - ClientBeginDeleteByIDOptions contains the optional parameters for the Client.BeginDeleteByID method.

func (*Client) BeginMoveResources 

func (client *Client) BeginMoveResources(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo, options *ClientBeginMoveResourcesOptions) (*runtime.Poller[ClientMoveResourcesResponse], error)

BeginMoveResources - The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • sourceResourceGroupName - The name of the resource group from the source subscription containing the resources to be moved.
  • parameters - Parameters for moving resources.
  • options - ClientBeginMoveResourcesOptions contains the optional parameters for the Client.BeginMoveResources method.

func (*Client) BeginUpdate 

func (client *Client) BeginUpdate(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, parameters GenericResource, options *ClientBeginUpdateOptions) (*runtime.Poller[ClientUpdateResponse], error)

BeginUpdate - Updates a resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group for the resource. The name is case insensitive.
  • resourceProviderNamespace - The namespace of the resource provider.
  • parentResourcePath - The parent resource identity.
  • resourceType - The resource type of the resource to update.
  • resourceName - The name of the resource to update.
  • apiVersion - The API version to use for the operation.
  • parameters - Parameters for updating the resource.
  • options - ClientBeginUpdateOptions contains the optional parameters for the Client.BeginUpdate method.

func (*Client) BeginUpdateByID 

func (client *Client) BeginUpdateByID(ctx context.Context, resourceID string, apiVersion string, parameters GenericResource, options *ClientBeginUpdateByIDOptions) (*runtime.Poller[ClientUpdateByIDResponse], error)

BeginUpdateByID - Updates a resource by ID. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceID - The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
  • apiVersion - The API version to use for the operation.
  • parameters - Update resource parameters.
  • options - ClientBeginUpdateByIDOptions contains the optional parameters for the Client.BeginUpdateByID method.

func (*Client) BeginValidateMoveResources 

func (client *Client) BeginValidateMoveResources(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo, options *ClientBeginValidateMoveResourcesOptions) (*runtime.Poller[ClientValidateMoveResourcesResponse], error)

BeginValidateMoveResources - This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • sourceResourceGroupName - The name of the resource group from the source subscription containing the resources to be validated for move.
  • parameters - Parameters for moving resources.
  • options - ClientBeginValidateMoveResourcesOptions contains the optional parameters for the Client.BeginValidateMoveResources method.

func (*Client) CheckExistence 

func (client *Client) CheckExistence(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, options *ClientCheckExistenceOptions) (ClientCheckExistenceResponse, error)

CheckExistence - Checks whether a resource exists.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group containing the resource to check. The name is case insensitive.
  • resourceProviderNamespace - The resource provider of the resource to check.
  • parentResourcePath - The parent resource identity.
  • resourceType - The resource type.
  • resourceName - The name of the resource to check whether it exists.
  • apiVersion - The API version to use for the operation.
  • options - ClientCheckExistenceOptions contains the optional parameters for the Client.CheckExistence method.

func (*Client) CheckExistenceByID 

func (client *Client) CheckExistenceByID(ctx context.Context, resourceID string, apiVersion string, options *ClientCheckExistenceByIDOptions) (ClientCheckExistenceByIDResponse, error)

CheckExistenceByID - Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource.

Generated from API version 2024-11-01

  • resourceID - The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
  • apiVersion - The API version to use for the operation.
  • options - ClientCheckExistenceByIDOptions contains the optional parameters for the Client.CheckExistenceByID method.

func (*Client) Get 

func (client *Client) Get(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, options *ClientGetOptions) (ClientGetResponse, error)

Get - Gets a resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group containing the resource to get. The name is case insensitive.
  • resourceProviderNamespace - The namespace of the resource provider.
  • parentResourcePath - The parent resource identity.
  • resourceType - The resource type of the resource.
  • resourceName - The name of the resource to get.
  • apiVersion - The API version to use for the operation.
  • options - ClientGetOptions contains the optional parameters for the Client.Get method.

func (*Client) GetByID 

func (client *Client) GetByID(ctx context.Context, resourceID string, apiVersion string, options *ClientGetByIDOptions) (ClientGetByIDResponse, error)

GetByID - Gets a resource by ID. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceID - The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
  • apiVersion - The API version to use for the operation.
  • options - ClientGetByIDOptions contains the optional parameters for the Client.GetByID method.

func (*Client) NewListByResourceGroupPager 

func (client *Client) NewListByResourceGroupPager(resourceGroupName string, options *ClientListByResourceGroupOptions) *runtime.Pager[ClientListByResourceGroupResponse]

NewListByResourceGroupPager - Get all the resources for a resource group.

Generated from API version 2024-11-01

  • resourceGroupName - The resource group with the resources to get.
  • options - ClientListByResourceGroupOptions contains the optional parameters for the Client.NewListByResourceGroupPager method.

func (*Client) NewListPager 

func (client *Client) NewListPager(options *ClientListOptions) *runtime.Pager[ClientListResponse]

NewListPager - Get all the resources in a subscription.

Generated from API version 2024-11-01

  • options - ClientListOptions contains the optional parameters for the Client.NewListPager method.

type ClientBeginCreateOrUpdateByIDOptions 

type ClientBeginCreateOrUpdateByIDOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginCreateOrUpdateByIDOptions contains the optional parameters for the Client.BeginCreateOrUpdateByID method.

type ClientBeginCreateOrUpdateOptions 

type ClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginCreateOrUpdateOptions contains the optional parameters for the Client.BeginCreateOrUpdate method.

type ClientBeginDeleteByIDOptions 

type ClientBeginDeleteByIDOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginDeleteByIDOptions contains the optional parameters for the Client.BeginDeleteByID method.

type ClientBeginDeleteOptions 

type ClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginDeleteOptions contains the optional parameters for the Client.BeginDelete method.

type ClientBeginMoveResourcesOptions 

type ClientBeginMoveResourcesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginMoveResourcesOptions contains the optional parameters for the Client.BeginMoveResources method.

type ClientBeginUpdateByIDOptions 

type ClientBeginUpdateByIDOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginUpdateByIDOptions contains the optional parameters for the Client.BeginUpdateByID method.

type ClientBeginUpdateOptions 

type ClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginUpdateOptions contains the optional parameters for the Client.BeginUpdate method.

type ClientBeginValidateMoveResourcesOptions 

type ClientBeginValidateMoveResourcesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginValidateMoveResourcesOptions contains the optional parameters for the Client.BeginValidateMoveResources method.

type ClientCheckExistenceByIDOptions 

type ClientCheckExistenceByIDOptions struct {
}

ClientCheckExistenceByIDOptions contains the optional parameters for the Client.CheckExistenceByID method.

type ClientCheckExistenceByIDResponse 

type ClientCheckExistenceByIDResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

ClientCheckExistenceByIDResponse contains the response from method Client.CheckExistenceByID.

type ClientCheckExistenceOptions 

type ClientCheckExistenceOptions struct {
}

ClientCheckExistenceOptions contains the optional parameters for the Client.CheckExistence method.

type ClientCheckExistenceResponse 

type ClientCheckExistenceResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

ClientCheckExistenceResponse contains the response from method Client.CheckExistence.

type ClientCreateOrUpdateByIDResponse 

type ClientCreateOrUpdateByIDResponse struct {
	// Resource information.
	GenericResource
}

ClientCreateOrUpdateByIDResponse contains the response from method Client.BeginCreateOrUpdateByID.

type ClientCreateOrUpdateResponse 

type ClientCreateOrUpdateResponse struct {
	// Resource information.
	GenericResource
}

ClientCreateOrUpdateResponse contains the response from method Client.BeginCreateOrUpdate.

type ClientDeleteByIDResponse 

type ClientDeleteByIDResponse struct {
}

ClientDeleteByIDResponse contains the response from method Client.BeginDeleteByID.

type ClientDeleteResponse 

type ClientDeleteResponse struct {
}

ClientDeleteResponse contains the response from method Client.BeginDelete.

type ClientFactory 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewClient 

func (c *ClientFactory) NewClient() *Client

NewClient creates a new instance of Client.

func (*ClientFactory) NewDeploymentOperationsClient 

func (c *ClientFactory) NewDeploymentOperationsClient() *DeploymentOperationsClient

NewDeploymentOperationsClient creates a new instance of DeploymentOperationsClient.

func (*ClientFactory) NewDeploymentsClient 

func (c *ClientFactory) NewDeploymentsClient() *DeploymentsClient

NewDeploymentsClient creates a new instance of DeploymentsClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewProviderResourceTypesClient 

func (c *ClientFactory) NewProviderResourceTypesClient() *ProviderResourceTypesClient

NewProviderResourceTypesClient creates a new instance of ProviderResourceTypesClient.

func (*ClientFactory) NewProvidersClient 

func (c *ClientFactory) NewProvidersClient() *ProvidersClient

NewProvidersClient creates a new instance of ProvidersClient.

func (*ClientFactory) NewResourceGroupsClient 

func (c *ClientFactory) NewResourceGroupsClient() *ResourceGroupsClient

NewResourceGroupsClient creates a new instance of ResourceGroupsClient.

func (*ClientFactory) NewTagsClient 

func (c *ClientFactory) NewTagsClient() *TagsClient

NewTagsClient creates a new instance of TagsClient.

type ClientGetByIDOptions 

type ClientGetByIDOptions struct {
}

ClientGetByIDOptions contains the optional parameters for the Client.GetByID method.

type ClientGetByIDResponse 

type ClientGetByIDResponse struct {
	// Resource information.
	GenericResource
}

ClientGetByIDResponse contains the response from method Client.GetByID.

type ClientGetOptions 

type ClientGetOptions struct {
}

ClientGetOptions contains the optional parameters for the Client.Get method.

type ClientGetResponse 

type ClientGetResponse struct {
	// Resource information.
	GenericResource
}

ClientGetResponse contains the response from method Client.Get.

type ClientListByResourceGroupOptions 

type ClientListByResourceGroupOptions struct {
	// Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime
	// and provisioningState. For example, $expand=createdTime,changedTime.
	Expand *string

	// The filter to apply on the operation.
	// The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity,
	// identity/principalId, plan, plan/publisher, plan/product, plan/name,
	// plan/version, and plan/promotionCode.
	// For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
	// You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
	// For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
	// You can link more than one substringof together by adding and/or operators.
	// You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1'
	// and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for
	// each resource are not returned in the results.
	// You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType,
	// plan and plan/publisher and plan/name, identity and identity/principalId.
	Filter *string

	// The number of results to return. If null is passed, returns all resources.
	Top *int32
}

ClientListByResourceGroupOptions contains the optional parameters for the Client.NewListByResourceGroupPager method.

type ClientListByResourceGroupResponse 

type ClientListByResourceGroupResponse struct {
	// List of resource groups.
	ResourceListResult
}

ClientListByResourceGroupResponse contains the response from method Client.NewListByResourceGroupPager.

type ClientListOptions 

type ClientListOptions struct {
	// Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime
	// and provisioningState. For example, $expand=createdTime,changedTime.
	Expand *string

	// The filter to apply on the operation.
	// Filter comparison operators include eq (equals) and ne (not equals) and may be used with the following properties: location,
	// resourceType, name, resourceGroup, identity, identity/principalId, plan,
	// plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
	// For example, to filter by a resource type, use $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
	// substringof(value, property) can be used to filter for substrings of the following currently-supported properties: name
	// and resourceGroup
	// For example, to get all resources with 'demo' anywhere in the resource name, use $filter=substringof('demo', name)
	// Multiple substring operations can also be combined using and/or operators.
	// Note that any truncated number of results queried via $top may also not be compatible when using a filter.
	// Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use $filter=tagName
	// eq 'tag1' and tagValue eq 'Value1'. Note that when resources are filtered by tag
	// name and value, the original tags for each resource will not be returned in the results. Any list of additional properties
	// queried via $expand may also not be compatible when filtering by tag
	// names/values.
	// For tag names only, resources can be filtered by prefix using the following syntax: $filter=startswith(tagName, 'depart').
	// This query will return all resources with a tag name prefixed by the phrase
	// depart (i.e.department, departureDate, departureTime, etc.)
	// Note that some properties can be combined when filtering resources, which include the following: substringof() and/or resourceType,
	// plan and plan/publisher and plan/name, and identity and
	// identity/principalId.
	Filter *string

	// The number of recommendations per page if a paged version of this API is being used.
	Top *int32
}

ClientListOptions contains the optional parameters for the Client.NewListPager method.

type ClientListResponse 

type ClientListResponse struct {
	// List of resource groups.
	ResourceListResult
}

ClientListResponse contains the response from method Client.NewListPager.

type ClientMoveResourcesResponse 

type ClientMoveResourcesResponse struct {
}

ClientMoveResourcesResponse contains the response from method Client.BeginMoveResources.

type ClientUpdateByIDResponse 

type ClientUpdateByIDResponse struct {
	// Resource information.
	GenericResource
}

ClientUpdateByIDResponse contains the response from method Client.BeginUpdateByID.

type ClientUpdateResponse 

type ClientUpdateResponse struct {
	// Resource information.
	GenericResource
}

ClientUpdateResponse contains the response from method Client.BeginUpdate.

type ClientValidateMoveResourcesResponse 

type ClientValidateMoveResourcesResponse struct {
}

ClientValidateMoveResourcesResponse contains the response from method Client.BeginValidateMoveResources.

type DebugSetting 

type DebugSetting struct {
	// Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent,
	// or both requestContent and responseContent separated by a comma. The default is
	// none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging
	// information about the request or response, you could potentially expose
	// sensitive data that is retrieved through the deployment operations.
	DetailLevel *string
}

DebugSetting - The debug setting.

func (DebugSetting) MarshalJSON 

func (d DebugSetting) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DebugSetting.

func (*DebugSetting) UnmarshalJSON 

func (d *DebugSetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DebugSetting.

type Dependency 

type Dependency struct {
	// The list of dependencies.
	DependsOn []*BasicDependency

	// The ID of the dependency.
	ID *string

	// The dependency resource name.
	ResourceName *string

	// The dependency resource type.
	ResourceType *string
}

Dependency - Deployment dependency information.

func (Dependency) MarshalJSON 

func (d Dependency) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Dependency.

func (*Dependency) UnmarshalJSON 

func (d *Dependency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Dependency.

type Deployment 

type Deployment struct {
	// REQUIRED; The deployment properties.
	Properties *DeploymentProperties

	// The location to store the deployment data.
	Location *string

	// Deployment tags
	Tags map[string]*string
}

Deployment operation parameters.

func (Deployment) MarshalJSON 

func (d Deployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Deployment.

func (*Deployment) UnmarshalJSON 

func (d *Deployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Deployment.

type DeploymentDiagnosticsDefinition 

type DeploymentDiagnosticsDefinition struct {
	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; Denotes the additional response level.
	Level *Level

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error target.
	Target *string
}

func (DeploymentDiagnosticsDefinition) MarshalJSON 

func (d DeploymentDiagnosticsDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentDiagnosticsDefinition.

func (*DeploymentDiagnosticsDefinition) UnmarshalJSON 

func (d *DeploymentDiagnosticsDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentDiagnosticsDefinition.

type DeploymentExportResult 

type DeploymentExportResult struct {
	// The template content.
	Template any
}

DeploymentExportResult - The deployment export result.

func (DeploymentExportResult) MarshalJSON 

func (d DeploymentExportResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentExportResult.

func (*DeploymentExportResult) UnmarshalJSON 

func (d *DeploymentExportResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentExportResult.

type DeploymentExtended 

type DeploymentExtended struct {
	// the location of the deployment.
	Location *string

	// Deployment properties.
	Properties *DeploymentPropertiesExtended

	// Deployment tags
	Tags map[string]*string

	// READ-ONLY; The ID of the deployment.
	ID *string

	// READ-ONLY; The name of the deployment.
	Name *string

	// READ-ONLY; The type of the deployment.
	Type *string
}

DeploymentExtended - Deployment information.

func (DeploymentExtended) MarshalJSON 

func (d DeploymentExtended) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentExtended.

func (*DeploymentExtended) UnmarshalJSON 

func (d *DeploymentExtended) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentExtended.

type DeploymentExtendedFilter 

type DeploymentExtendedFilter struct {
	// The provisioning state.
	ProvisioningState *string
}

DeploymentExtendedFilter - Deployment filter.

func (DeploymentExtendedFilter) MarshalJSON 

func (d DeploymentExtendedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentExtendedFilter.

func (*DeploymentExtendedFilter) UnmarshalJSON 

func (d *DeploymentExtendedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentExtendedFilter.

type DeploymentListResult 

type DeploymentListResult struct {
	// An array of deployments.
	Value []*DeploymentExtended

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

DeploymentListResult - List of deployments.

func (DeploymentListResult) MarshalJSON 

func (d DeploymentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentListResult.

func (*DeploymentListResult) UnmarshalJSON 

func (d *DeploymentListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentListResult.

type DeploymentMode 

type DeploymentMode string

DeploymentMode - The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. 

const (
	DeploymentModeComplete    DeploymentMode = "Complete"
	DeploymentModeIncremental DeploymentMode = "Incremental"
)

func PossibleDeploymentModeValues 

func PossibleDeploymentModeValues() []DeploymentMode

PossibleDeploymentModeValues returns the possible values for the DeploymentMode const type.

type DeploymentOperation 

type DeploymentOperation struct {
	// Deployment properties.
	Properties *DeploymentOperationProperties

	// READ-ONLY; Full deployment operation ID.
	ID *string

	// READ-ONLY; Deployment operation ID.
	OperationID *string
}

DeploymentOperation - Deployment operation information.

func (DeploymentOperation) MarshalJSON 

func (d DeploymentOperation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentOperation.

func (*DeploymentOperation) UnmarshalJSON 

func (d *DeploymentOperation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentOperation.

type DeploymentOperationProperties 

type DeploymentOperationProperties struct {
	// READ-ONLY; The duration of the operation.
	Duration *string

	// READ-ONLY; The name of the current provisioning operation.
	ProvisioningOperation *ProvisioningOperation

	// READ-ONLY; The state of the provisioning.
	ProvisioningState *string

	// READ-ONLY; The HTTP request message.
	Request *HTTPMessage

	// READ-ONLY; The HTTP response message.
	Response *HTTPMessage

	// READ-ONLY; Deployment operation service request id.
	ServiceRequestID *string

	// READ-ONLY; Operation status code from the resource provider. This property may not be set if a response has not yet been
	// received.
	StatusCode *string

	// READ-ONLY; Operation status message from the resource provider. This property is optional. It will only be provided if
	// an error was received from the resource provider.
	StatusMessage *StatusMessage

	// READ-ONLY; The target resource.
	TargetResource *TargetResource

	// READ-ONLY; The date and time of the operation.
	Timestamp *time.Time
}

DeploymentOperationProperties - Deployment operation properties.

func (DeploymentOperationProperties) MarshalJSON 

func (d DeploymentOperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentOperationProperties.

func (*DeploymentOperationProperties) UnmarshalJSON 

func (d *DeploymentOperationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentOperationProperties.

type DeploymentOperationsClient 

type DeploymentOperationsClient struct {
	// contains filtered or unexported fields
}

DeploymentOperationsClient contains the methods for the DeploymentOperations group. Don't use this type directly, use NewDeploymentOperationsClient() instead.

func NewDeploymentOperationsClient 

func NewDeploymentOperationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeploymentOperationsClient, error)

NewDeploymentOperationsClient creates a new instance of DeploymentOperationsClient with the specified values.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DeploymentOperationsClient) Get 

func (client *DeploymentOperationsClient) Get(ctx context.Context, resourceGroupName string, deploymentName string, operationID string, options *DeploymentOperationsClientGetOptions) (DeploymentOperationsClientGetResponse, error)

Get - Gets a deployments operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • operationID - The ID of the operation to get.
  • options - DeploymentOperationsClientGetOptions contains the optional parameters for the DeploymentOperationsClient.Get method.

func (*DeploymentOperationsClient) GetAtManagementGroupScope 

func (client *DeploymentOperationsClient) GetAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, operationID string, options *DeploymentOperationsClientGetAtManagementGroupScopeOptions) (DeploymentOperationsClientGetAtManagementGroupScopeResponse, error)

GetAtManagementGroupScope - Gets a deployments operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • operationID - The ID of the operation to get.
  • options - DeploymentOperationsClientGetAtManagementGroupScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtManagementGroupScope method.

func (*DeploymentOperationsClient) GetAtScope 

func (client *DeploymentOperationsClient) GetAtScope(ctx context.Context, scope string, deploymentName string, operationID string, options *DeploymentOperationsClientGetAtScopeOptions) (DeploymentOperationsClientGetAtScopeResponse, error)

GetAtScope - Gets a deployments operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • operationID - The ID of the operation to get.
  • options - DeploymentOperationsClientGetAtScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtScope method.

func (*DeploymentOperationsClient) GetAtSubscriptionScope 

func (client *DeploymentOperationsClient) GetAtSubscriptionScope(ctx context.Context, deploymentName string, operationID string, options *DeploymentOperationsClientGetAtSubscriptionScopeOptions) (DeploymentOperationsClientGetAtSubscriptionScopeResponse, error)

GetAtSubscriptionScope - Gets a deployments operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • operationID - The ID of the operation to get.
  • options - DeploymentOperationsClientGetAtSubscriptionScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtSubscriptionScope method.

func (*DeploymentOperationsClient) GetAtTenantScope 

func (client *DeploymentOperationsClient) GetAtTenantScope(ctx context.Context, deploymentName string, operationID string, options *DeploymentOperationsClientGetAtTenantScopeOptions) (DeploymentOperationsClientGetAtTenantScopeResponse, error)

GetAtTenantScope - Gets a deployments operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • operationID - The ID of the operation to get.
  • options - DeploymentOperationsClientGetAtTenantScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtTenantScope method.

func (*DeploymentOperationsClient) NewListAtManagementGroupScopePager 

func (client *DeploymentOperationsClient) NewListAtManagementGroupScopePager(groupID string, deploymentName string, options *DeploymentOperationsClientListAtManagementGroupScopeOptions) *runtime.Pager[DeploymentOperationsClientListAtManagementGroupScopeResponse]

NewListAtManagementGroupScopePager - Gets all deployments operations for a deployment.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • options - DeploymentOperationsClientListAtManagementGroupScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtManagementGroupScopePager method.

func (*DeploymentOperationsClient) NewListAtScopePager 

func (client *DeploymentOperationsClient) NewListAtScopePager(scope string, deploymentName string, options *DeploymentOperationsClientListAtScopeOptions) *runtime.Pager[DeploymentOperationsClientListAtScopeResponse]

NewListAtScopePager - Gets all deployments operations for a deployment.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • options - DeploymentOperationsClientListAtScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtScopePager method.

func (*DeploymentOperationsClient) NewListAtSubscriptionScopePager 

func (client *DeploymentOperationsClient) NewListAtSubscriptionScopePager(deploymentName string, options *DeploymentOperationsClientListAtSubscriptionScopeOptions) *runtime.Pager[DeploymentOperationsClientListAtSubscriptionScopeResponse]

NewListAtSubscriptionScopePager - Gets all deployments operations for a deployment.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentOperationsClientListAtSubscriptionScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtSubscriptionScopePager method.

func (*DeploymentOperationsClient) NewListAtTenantScopePager 

func (client *DeploymentOperationsClient) NewListAtTenantScopePager(deploymentName string, options *DeploymentOperationsClientListAtTenantScopeOptions) *runtime.Pager[DeploymentOperationsClientListAtTenantScopeResponse]

NewListAtTenantScopePager - Gets all deployments operations for a deployment.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentOperationsClientListAtTenantScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtTenantScopePager method.

func (*DeploymentOperationsClient) NewListPager 

func (client *DeploymentOperationsClient) NewListPager(resourceGroupName string, deploymentName string, options *DeploymentOperationsClientListOptions) *runtime.Pager[DeploymentOperationsClientListResponse]

NewListPager - Gets all deployments operations for a deployment.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • options - DeploymentOperationsClientListOptions contains the optional parameters for the DeploymentOperationsClient.NewListPager method.

type DeploymentOperationsClientGetAtManagementGroupScopeOptions 

type DeploymentOperationsClientGetAtManagementGroupScopeOptions struct {
}

DeploymentOperationsClientGetAtManagementGroupScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtManagementGroupScope method.

type DeploymentOperationsClientGetAtManagementGroupScopeResponse 

type DeploymentOperationsClientGetAtManagementGroupScopeResponse struct {
	// Deployment operation information.
	DeploymentOperation
}

DeploymentOperationsClientGetAtManagementGroupScopeResponse contains the response from method DeploymentOperationsClient.GetAtManagementGroupScope.

type DeploymentOperationsClientGetAtScopeOptions 

type DeploymentOperationsClientGetAtScopeOptions struct {
}

DeploymentOperationsClientGetAtScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtScope method.

type DeploymentOperationsClientGetAtScopeResponse 

type DeploymentOperationsClientGetAtScopeResponse struct {
	// Deployment operation information.
	DeploymentOperation
}

DeploymentOperationsClientGetAtScopeResponse contains the response from method DeploymentOperationsClient.GetAtScope.

type DeploymentOperationsClientGetAtSubscriptionScopeOptions 

type DeploymentOperationsClientGetAtSubscriptionScopeOptions struct {
}

DeploymentOperationsClientGetAtSubscriptionScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtSubscriptionScope method.

type DeploymentOperationsClientGetAtSubscriptionScopeResponse 

type DeploymentOperationsClientGetAtSubscriptionScopeResponse struct {
	// Deployment operation information.
	DeploymentOperation
}

DeploymentOperationsClientGetAtSubscriptionScopeResponse contains the response from method DeploymentOperationsClient.GetAtSubscriptionScope.

type DeploymentOperationsClientGetAtTenantScopeOptions 

type DeploymentOperationsClientGetAtTenantScopeOptions struct {
}

DeploymentOperationsClientGetAtTenantScopeOptions contains the optional parameters for the DeploymentOperationsClient.GetAtTenantScope method.

type DeploymentOperationsClientGetAtTenantScopeResponse 

type DeploymentOperationsClientGetAtTenantScopeResponse struct {
	// Deployment operation information.
	DeploymentOperation
}

DeploymentOperationsClientGetAtTenantScopeResponse contains the response from method DeploymentOperationsClient.GetAtTenantScope.

type DeploymentOperationsClientGetOptions 

type DeploymentOperationsClientGetOptions struct {
}

DeploymentOperationsClientGetOptions contains the optional parameters for the DeploymentOperationsClient.Get method.

type DeploymentOperationsClientGetResponse 

type DeploymentOperationsClientGetResponse struct {
	// Deployment operation information.
	DeploymentOperation
}

DeploymentOperationsClientGetResponse contains the response from method DeploymentOperationsClient.Get.

type DeploymentOperationsClientListAtManagementGroupScopeOptions 

type DeploymentOperationsClientListAtManagementGroupScopeOptions struct {
	// The number of results to return.
	Top *int32
}

DeploymentOperationsClientListAtManagementGroupScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtManagementGroupScopePager method.

type DeploymentOperationsClientListAtManagementGroupScopeResponse 

type DeploymentOperationsClientListAtManagementGroupScopeResponse struct {
	// List of deployment operations.
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtManagementGroupScopeResponse contains the response from method DeploymentOperationsClient.NewListAtManagementGroupScopePager.

type DeploymentOperationsClientListAtScopeOptions 

type DeploymentOperationsClientListAtScopeOptions struct {
	// The number of results to return.
	Top *int32
}

DeploymentOperationsClientListAtScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtScopePager method.

type DeploymentOperationsClientListAtScopeResponse 

type DeploymentOperationsClientListAtScopeResponse struct {
	// List of deployment operations.
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtScopeResponse contains the response from method DeploymentOperationsClient.NewListAtScopePager.

type DeploymentOperationsClientListAtSubscriptionScopeOptions 

type DeploymentOperationsClientListAtSubscriptionScopeOptions struct {
	// The number of results to return.
	Top *int32
}

DeploymentOperationsClientListAtSubscriptionScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtSubscriptionScopePager method.

type DeploymentOperationsClientListAtSubscriptionScopeResponse 

type DeploymentOperationsClientListAtSubscriptionScopeResponse struct {
	// List of deployment operations.
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtSubscriptionScopeResponse contains the response from method DeploymentOperationsClient.NewListAtSubscriptionScopePager.

type DeploymentOperationsClientListAtTenantScopeOptions 

type DeploymentOperationsClientListAtTenantScopeOptions struct {
	// The number of results to return.
	Top *int32
}

DeploymentOperationsClientListAtTenantScopeOptions contains the optional parameters for the DeploymentOperationsClient.NewListAtTenantScopePager method.

type DeploymentOperationsClientListAtTenantScopeResponse 

type DeploymentOperationsClientListAtTenantScopeResponse struct {
	// List of deployment operations.
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtTenantScopeResponse contains the response from method DeploymentOperationsClient.NewListAtTenantScopePager.

type DeploymentOperationsClientListOptions 

type DeploymentOperationsClientListOptions struct {
	// The number of results to return.
	Top *int32
}

DeploymentOperationsClientListOptions contains the optional parameters for the DeploymentOperationsClient.NewListPager method.

type DeploymentOperationsClientListResponse 

type DeploymentOperationsClientListResponse struct {
	// List of deployment operations.
	DeploymentOperationsListResult
}

DeploymentOperationsClientListResponse contains the response from method DeploymentOperationsClient.NewListPager.

type DeploymentOperationsListResult 

type DeploymentOperationsListResult struct {
	// An array of deployment operations.
	Value []*DeploymentOperation

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

DeploymentOperationsListResult - List of deployment operations.

func (DeploymentOperationsListResult) MarshalJSON 

func (d DeploymentOperationsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentOperationsListResult.

func (*DeploymentOperationsListResult) UnmarshalJSON 

func (d *DeploymentOperationsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentOperationsListResult.

type DeploymentParameter 

type DeploymentParameter struct {
	// Azure Key Vault parameter reference.
	Reference *KeyVaultParameterReference

	// Input value to the parameter .
	Value any
}

DeploymentParameter - Deployment parameter for the template.

func (DeploymentParameter) MarshalJSON 

func (d DeploymentParameter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentParameter.

func (*DeploymentParameter) UnmarshalJSON 

func (d *DeploymentParameter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentParameter.

type DeploymentProperties 

type DeploymentProperties struct {
	// REQUIRED; The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode,
	// resources are deployed without deleting existing resources that are not included in
	// the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included
	// in the template are deleted. Be careful when using Complete mode as you may
	// unintentionally delete resources.
	Mode *DeploymentMode

	// The debug setting of the deployment.
	DebugSetting *DebugSetting

	// Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable
	// to nested templates. If not specified, default value is outer.
	ExpressionEvaluationOptions *ExpressionEvaluationOptions

	// The deployment on error behavior.
	OnErrorDeployment *OnErrorDeployment

	// Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide
	// the parameter values directly in the request rather than link to an existing
	// parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or
	// a well formed JSON string.
	Parameters map[string]*DeploymentParameter

	// The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink
	// property or the parameters property, but not both.
	ParametersLink *ParametersLink

	// The template content. You use this element when you want to pass the template syntax directly in the request rather than
	// link to an existing template. It can be a JObject or well-formed JSON string.
	// Use either the templateLink property or the template property, but not both.
	Template any

	// The URI of the template. Use either the templateLink property or the template property, but not both.
	TemplateLink *TemplateLink

	// The validation level of the deployment
	ValidationLevel *ValidationLevel
}

DeploymentProperties - Deployment properties.

func (DeploymentProperties) MarshalJSON 

func (d DeploymentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentProperties.

func (*DeploymentProperties) UnmarshalJSON 

func (d *DeploymentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentProperties.

type DeploymentPropertiesExtended 

type DeploymentPropertiesExtended struct {
	// The validation level of the deployment
	ValidationLevel *ValidationLevel

	// READ-ONLY; The correlation ID of the deployment.
	CorrelationID *string

	// READ-ONLY; The debug setting of the deployment.
	DebugSetting *DebugSetting

	// READ-ONLY; The list of deployment dependencies.
	Dependencies []*Dependency

	// READ-ONLY; Contains diagnostic information collected during validation process.
	Diagnostics []*DeploymentDiagnosticsDefinition

	// READ-ONLY; The duration of the template deployment.
	Duration *string

	// READ-ONLY; The deployment error.
	Error *ErrorResponse

	// READ-ONLY; The deployment mode. Possible values are Incremental and Complete.
	Mode *DeploymentMode

	// READ-ONLY; The deployment on error behavior.
	OnErrorDeployment *OnErrorDeploymentExtended

	// READ-ONLY; Array of provisioned resources.
	OutputResources []*ResourceReference

	// READ-ONLY; Key/value pairs that represent deployment output.
	Outputs any

	// READ-ONLY; Deployment parameters.
	Parameters any

	// READ-ONLY; The URI referencing the parameters.
	ParametersLink *ParametersLink

	// READ-ONLY; The list of resource providers needed for the deployment.
	Providers []*Provider

	// READ-ONLY; Denotes the state of provisioning.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The hash produced for the template.
	TemplateHash *string

	// READ-ONLY; The URI referencing the template.
	TemplateLink *TemplateLink

	// READ-ONLY; The timestamp of the template deployment.
	Timestamp *time.Time

	// READ-ONLY; Array of validated resources.
	ValidatedResources []*ResourceReference
}

DeploymentPropertiesExtended - Deployment properties with additional details.

func (DeploymentPropertiesExtended) MarshalJSON 

func (d DeploymentPropertiesExtended) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentPropertiesExtended.

func (*DeploymentPropertiesExtended) UnmarshalJSON 

func (d *DeploymentPropertiesExtended) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentPropertiesExtended.

type DeploymentValidateResult 

type DeploymentValidateResult struct {
	// The template deployment properties.
	Properties *DeploymentPropertiesExtended

	// READ-ONLY; The deployment validation error.
	Error *ErrorResponse

	// READ-ONLY; The ID of the deployment.
	ID *string

	// READ-ONLY; The name of the deployment.
	Name *string

	// READ-ONLY; The type of the deployment.
	Type *string
}

DeploymentValidateResult - Information from validate template deployment response.

func (DeploymentValidateResult) MarshalJSON 

func (d DeploymentValidateResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentValidateResult.

func (*DeploymentValidateResult) UnmarshalJSON 

func (d *DeploymentValidateResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentValidateResult.

type DeploymentWhatIf 

type DeploymentWhatIf struct {
	// REQUIRED; The deployment properties.
	Properties *DeploymentWhatIfProperties

	// The location to store the deployment data.
	Location *string
}

DeploymentWhatIf - Deployment What-if operation parameters.

func (DeploymentWhatIf) MarshalJSON 

func (d DeploymentWhatIf) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentWhatIf.

func (*DeploymentWhatIf) UnmarshalJSON 

func (d *DeploymentWhatIf) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentWhatIf.

type DeploymentWhatIfProperties 

type DeploymentWhatIfProperties struct {
	// REQUIRED; The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode,
	// resources are deployed without deleting existing resources that are not included in
	// the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included
	// in the template are deleted. Be careful when using Complete mode as you may
	// unintentionally delete resources.
	Mode *DeploymentMode

	// The debug setting of the deployment.
	DebugSetting *DebugSetting

	// Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable
	// to nested templates. If not specified, default value is outer.
	ExpressionEvaluationOptions *ExpressionEvaluationOptions

	// The deployment on error behavior.
	OnErrorDeployment *OnErrorDeployment

	// Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide
	// the parameter values directly in the request rather than link to an existing
	// parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or
	// a well formed JSON string.
	Parameters map[string]*DeploymentParameter

	// The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink
	// property or the parameters property, but not both.
	ParametersLink *ParametersLink

	// The template content. You use this element when you want to pass the template syntax directly in the request rather than
	// link to an existing template. It can be a JObject or well-formed JSON string.
	// Use either the templateLink property or the template property, but not both.
	Template any

	// The URI of the template. Use either the templateLink property or the template property, but not both.
	TemplateLink *TemplateLink

	// The validation level of the deployment
	ValidationLevel *ValidationLevel

	// Optional What-If operation settings.
	WhatIfSettings *DeploymentWhatIfSettings
}

DeploymentWhatIfProperties - Deployment What-if properties.

func (DeploymentWhatIfProperties) MarshalJSON 

func (d DeploymentWhatIfProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentWhatIfProperties.

func (*DeploymentWhatIfProperties) UnmarshalJSON 

func (d *DeploymentWhatIfProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentWhatIfProperties.

type DeploymentWhatIfSettings 

type DeploymentWhatIfSettings struct {
	// The format of the What-If results
	ResultFormat *WhatIfResultFormat
}

DeploymentWhatIfSettings - Deployment What-If operation settings.

func (DeploymentWhatIfSettings) MarshalJSON 

func (d DeploymentWhatIfSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentWhatIfSettings.

func (*DeploymentWhatIfSettings) UnmarshalJSON 

func (d *DeploymentWhatIfSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentWhatIfSettings.

type DeploymentsClient 

type DeploymentsClient struct {
	// contains filtered or unexported fields
}

DeploymentsClient contains the methods for the Deployments group. Don't use this type directly, use NewDeploymentsClient() instead.

func NewDeploymentsClient 

func NewDeploymentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeploymentsClient, error)

NewDeploymentsClient creates a new instance of DeploymentsClient with the specified values.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DeploymentsClient) BeginCreateOrUpdate 

func (client *DeploymentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment, options *DeploymentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DeploymentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - You can provide the template and parameters directly in the request or link to JSON files. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.
  • deploymentName - The name of the deployment.
  • parameters - Additional parameters supplied to the operation.
  • options - DeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdate method.
Example (CreateADeploymentThatWillDeployATemplateSpecWithTheGivenResourceId)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Duration: to.Ptr("PT22.8356799S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		OutputResources: []*armresources.ResourceReference{
// 			{
// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"),
// 		}},
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Storage"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							to.Ptr("eastus")},
// 							ResourceType: to.Ptr("storageAccounts"),
// 					}},
// 			}},
// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 			TemplateHash: to.Ptr("0000000000000000000"),
// 			TemplateLink: &armresources.TemplateLink{
// 				ContentVersion: to.Ptr("1.0.0.0"),
// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
// 			},
// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
// 		},
// 	}

Output:
Example (CreateADeploymentThatWillDeployATemplateWithAUriAndQueryString)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			QueryString: to.Ptr("sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"),
			URI:         to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Duration: to.Ptr("PT22.8356799S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		OutputResources: []*armresources.ResourceReference{
// 			{
// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"),
// 		}},
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Storage"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							to.Ptr("eastus")},
// 							ResourceType: to.Ptr("storageAccounts"),
// 					}},
// 			}},
// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 			TemplateHash: to.Ptr("0000000000000000000"),
// 			TemplateLink: &armresources.TemplateLink{
// 				ContentVersion: to.Ptr("1.0.0.0"),
// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
// 			},
// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
// 		},
// 	}

Output:
Example (CreateADeploymentThatWillRedeployAnotherDeploymentOnFailure)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
	Properties: &armresources.DeploymentProperties{
		Mode: to.Ptr(armresources.DeploymentModeComplete),
		OnErrorDeployment: &armresources.OnErrorDeployment{
			Type:           to.Ptr(armresources.OnErrorDeploymentTypeSpecificDeployment),
			DeploymentName: to.Ptr("name-of-deployment-to-use"),
		},
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 			{
// 				DependsOn: []*armresources.BasicDependency{
// 					{
// 						ID: to.Ptr("{resourceid}"),
// 						ResourceName: to.Ptr("VNet1"),
// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
// 				}},
// 				ID: to.Ptr("{resourceid}"),
// 				ResourceName: to.Ptr("VNet1/Subnet1"),
// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
// 			},
// 			{
// 				DependsOn: []*armresources.BasicDependency{
// 					{
// 						ID: to.Ptr("{resourceid}"),
// 						ResourceName: to.Ptr("VNet1"),
// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
// 					},
// 					{
// 						ID: to.Ptr("{resourceid}"),
// 						ResourceName: to.Ptr("VNet1/Subnet1"),
// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
// 				}},
// 				ID: to.Ptr("{resourceid}"),
// 				ResourceName: to.Ptr("VNet1/Subnet2"),
// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
// 		}},
// 		Duration: to.Ptr("PT0.8204881S"),
// 		Mode: to.Ptr(armresources.DeploymentModeComplete),
// 		OnErrorDeployment: &armresources.OnErrorDeploymentExtended{
// 			Type: to.Ptr(armresources.OnErrorDeploymentTypeSpecificDeployment),
// 			DeploymentName: to.Ptr("name-of-deployment-to-use"),
// 		},
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Network"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							to.Ptr("centralus")},
// 							ResourceType: to.Ptr("virtualNetworks"),
// 						},
// 						{
// 							Locations: []*string{
// 								to.Ptr("centralus")},
// 								ResourceType: to.Ptr("virtualNetworks/subnets"),
// 						}},
// 				}},
// 				ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 				TemplateLink: &armresources.TemplateLink{
// 					ContentVersion: to.Ptr("1.0.0.0"),
// 					URI: to.Ptr("https://example.com/exampleTemplate.json"),
// 				},
// 				Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T00:00:00.000Z"); return t}()),
// 			},
// 		}

Output:
Example (CreateADeploymentThatWillRedeployTheLastSuccessfulDeploymentOnFailure)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
	Properties: &armresources.DeploymentProperties{
		Mode: to.Ptr(armresources.DeploymentModeComplete),
		OnErrorDeployment: &armresources.OnErrorDeployment{
			Type: to.Ptr(armresources.OnErrorDeploymentTypeLastSuccessful),
		},
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 			{
// 				DependsOn: []*armresources.BasicDependency{
// 					{
// 						ID: to.Ptr("{resourceid}"),
// 						ResourceName: to.Ptr("VNet1"),
// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
// 				}},
// 				ID: to.Ptr("{resourceid}"),
// 				ResourceName: to.Ptr("VNet1/Subnet1"),
// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
// 			},
// 			{
// 				DependsOn: []*armresources.BasicDependency{
// 					{
// 						ID: to.Ptr("{resourceid}"),
// 						ResourceName: to.Ptr("VNet1"),
// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
// 					},
// 					{
// 						ID: to.Ptr("{resourceid}"),
// 						ResourceName: to.Ptr("VNet1/Subnet1"),
// 						ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
// 				}},
// 				ID: to.Ptr("{resourceid}"),
// 				ResourceName: to.Ptr("VNet1/Subnet2"),
// 				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
// 		}},
// 		Duration: to.Ptr("PT0.8204881S"),
// 		Mode: to.Ptr(armresources.DeploymentModeComplete),
// 		OnErrorDeployment: &armresources.OnErrorDeploymentExtended{
// 			Type: to.Ptr(armresources.OnErrorDeploymentTypeLastSuccessful),
// 			DeploymentName: to.Ptr("{nameOfLastSuccesfulDeployment}"),
// 		},
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Network"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							to.Ptr("centralus")},
// 							ResourceType: to.Ptr("virtualNetworks"),
// 						},
// 						{
// 							Locations: []*string{
// 								to.Ptr("centralus")},
// 								ResourceType: to.Ptr("virtualNetworks/subnets"),
// 						}},
// 				}},
// 				ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 				TemplateLink: &armresources.TemplateLink{
// 					ContentVersion: to.Ptr("1.0.0.0"),
// 					URI: to.Ptr("https://example.com/exampleTemplate.json"),
// 				},
// 				Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T00:00:00.000Z"); return t}()),
// 			},
// 		}

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtManagementGroupScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions) (*runtime.Poller[DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse], error)

BeginCreateOrUpdateAtManagementGroupScope - You can provide the template and parameters directly in the request or link to JSON files. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • parameters - Additional parameters supplied to the operation.
  • options - DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtManagementGroupScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentAtManagementGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdateAtManagementGroupScope(ctx, "my-management-group-id", "my-deployment", armresources.ScopedDeployment{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 			{
// 				DependsOn: []*armresources.BasicDependency{
// 					{
// 						ID: to.Ptr("/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name"),
// 						ResourceName: to.Ptr("policy-definition-name"),
// 						ResourceType: to.Ptr("Microsoft.Authorization/policyDefinitions"),
// 				}},
// 				ID: to.Ptr("/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock"),
// 				ResourceName: to.Ptr("location-lock"),
// 				ResourceType: to.Ptr("Microsoft.Authorization/policyAssignments"),
// 		}},
// 		Duration: to.Ptr("PT1.2970875S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Authorization"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							nil},
// 							ResourceType: to.Ptr("policyDefinitions"),
// 						},
// 						{
// 							Locations: []*string{
// 								nil},
// 								ResourceType: to.Ptr("policyAssignments"),
// 						}},
// 					},
// 					{
// 						Namespace: to.Ptr("Microsoft.Resources"),
// 						ResourceTypes: []*armresources.ProviderResourceType{
// 							{
// 								Locations: []*string{
// 									to.Ptr("eastus")},
// 									ResourceType: to.Ptr("deployments"),
// 							}},
// 					}},
// 					ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-24T22:52:38.789Z"); return t}()),
// 				},
// 			}

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtScope(ctx context.Context, scope string, deploymentName string, parameters Deployment, options *DeploymentsClientBeginCreateOrUpdateAtScopeOptions) (*runtime.Poller[DeploymentsClientCreateOrUpdateAtScopeResponse], error)

BeginCreateOrUpdateAtScope - You can provide the template and parameters directly in the request or link to JSON files. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • parameters - Additional parameters supplied to the operation.
  • options - DeploymentsClientBeginCreateOrUpdateAtScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentAtScope.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdateAtScope(ctx, "providers/Microsoft.Management/managementGroups/my-management-group-id", "my-deployment", armresources.Deployment{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
	Tags: map[string]*string{
		"tagKey1": to.Ptr("tag-value-1"),
		"tagKey2": to.Ptr("tag-value-2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 			{
// 				DependsOn: []*armresources.BasicDependency{
// 					{
// 						ID: to.Ptr("/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name"),
// 						ResourceName: to.Ptr("policy-definition-name"),
// 						ResourceType: to.Ptr("Microsoft.Authorization/policyDefinitions"),
// 				}},
// 				ID: to.Ptr("/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock"),
// 				ResourceName: to.Ptr("location-lock"),
// 				ResourceType: to.Ptr("Microsoft.Authorization/policyAssignments"),
// 		}},
// 		Duration: to.Ptr("PT1.2970875S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Authorization"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							nil},
// 							ResourceType: to.Ptr("policyDefinitions"),
// 						},
// 						{
// 							Locations: []*string{
// 								nil},
// 								ResourceType: to.Ptr("policyAssignments"),
// 						}},
// 					},
// 					{
// 						Namespace: to.Ptr("Microsoft.Resources"),
// 						ResourceTypes: []*armresources.ProviderResourceType{
// 							{
// 								Locations: []*string{
// 									to.Ptr("eastus")},
// 									ResourceType: to.Ptr("deployments"),
// 							}},
// 					}},
// 					ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-24T22:52:38.789Z"); return t}()),
// 				},
// 				Tags: map[string]*string{
// 					"tagKey1": to.Ptr("tag-value-1"),
// 					"tagKey2": to.Ptr("tag-value-2"),
// 				},
// 			}

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtSubscriptionScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtSubscriptionScope(ctx context.Context, deploymentName string, parameters Deployment, options *DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions) (*runtime.Poller[DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse], error)

BeginCreateOrUpdateAtSubscriptionScope - You can provide the template and parameters directly in the request or link to JSON files. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • parameters - Additional parameters supplied to the operation.
  • options - DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtSubscriptionScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdateAtSubscriptionScope(ctx, "my-deployment", armresources.Deployment{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Duration: to.Ptr("PT1.2637681S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		OutputResources: []*armresources.ResourceReference{
// 		},
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 		},
// 		ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 		TemplateHash: to.Ptr("0000000000000000000"),
// 		TemplateLink: &armresources.TemplateLink{
// 			ContentVersion: to.Ptr("1.0.0.0"),
// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
// 		},
// 		Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:51:58.628Z"); return t}()),
// 	},
// }

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtTenantScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtTenantScope(ctx context.Context, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions) (*runtime.Poller[DeploymentsClientCreateOrUpdateAtTenantScopeResponse], error)

BeginCreateOrUpdateAtTenantScope - You can provide the template and parameters directly in the request or link to JSON files. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • parameters - Additional parameters supplied to the operation.
  • options - DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtTenantScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutDeploymentAtTenant.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdateAtTenantScope(ctx, "tenant-dep01", armresources.ScopedDeployment{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
	Tags: map[string]*string{
		"tagKey1": to.Ptr("tag-value-1"),
		"tagKey2": to.Ptr("tag-value-2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentExtended = armresources.DeploymentExtended{
// 	Name: to.Ptr("tenant-dep01"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/providers/Microsoft.Resources/deployments/tenant-dep01"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 			{
// 				DependsOn: []*armresources.BasicDependency{
// 					{
// 						ID: to.Ptr("/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name"),
// 						ResourceName: to.Ptr("policy-definition-name"),
// 						ResourceType: to.Ptr("Microsoft.Authorization/policyDefinitions"),
// 				}},
// 				ID: to.Ptr("/providers/Microsoft.Authorization/policyAssignments/location-lock"),
// 				ResourceName: to.Ptr("location-lock"),
// 				ResourceType: to.Ptr("Microsoft.Authorization/policyAssignments"),
// 		}},
// 		Duration: to.Ptr("PT1.2970875S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Authorization"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							nil},
// 							ResourceType: to.Ptr("policyDefinitions"),
// 						},
// 						{
// 							Locations: []*string{
// 								nil},
// 								ResourceType: to.Ptr("policyAssignments"),
// 						}},
// 					},
// 					{
// 						Namespace: to.Ptr("Microsoft.Resources"),
// 						ResourceTypes: []*armresources.ProviderResourceType{
// 							{
// 								Locations: []*string{
// 									to.Ptr("eastus")},
// 									ResourceType: to.Ptr("deployments"),
// 							}},
// 					}},
// 					ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-24T22:52:38.789Z"); return t}()),
// 				},
// 				Tags: map[string]*string{
// 					"tagKey1": to.Ptr("tag-value-1"),
// 					"tagKey2": to.Ptr("tag-value-2"),
// 				},
// 			}

Output:

func (*DeploymentsClient) BeginDelete 

func (client *DeploymentsClient) BeginDelete(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsClientBeginDeleteOptions) (*runtime.Poller[DeploymentsClientDeleteResponse], error)

BeginDelete - A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group with the deployment to delete. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientBeginDeleteOptions contains the optional parameters for the DeploymentsClient.BeginDelete method.

func (*DeploymentsClient) BeginDeleteAtManagementGroupScope 

func (client *DeploymentsClient) BeginDeleteAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, options *DeploymentsClientBeginDeleteAtManagementGroupScopeOptions) (*runtime.Poller[DeploymentsClientDeleteAtManagementGroupScopeResponse], error)

BeginDeleteAtManagementGroupScope - A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientBeginDeleteAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtManagementGroupScope method.

func (*DeploymentsClient) BeginDeleteAtScope 

func (client *DeploymentsClient) BeginDeleteAtScope(ctx context.Context, scope string, deploymentName string, options *DeploymentsClientBeginDeleteAtScopeOptions) (*runtime.Poller[DeploymentsClientDeleteAtScopeResponse], error)

BeginDeleteAtScope - A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientBeginDeleteAtScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtScope method.

func (*DeploymentsClient) BeginDeleteAtSubscriptionScope 

func (client *DeploymentsClient) BeginDeleteAtSubscriptionScope(ctx context.Context, deploymentName string, options *DeploymentsClientBeginDeleteAtSubscriptionScopeOptions) (*runtime.Poller[DeploymentsClientDeleteAtSubscriptionScopeResponse], error)

BeginDeleteAtSubscriptionScope - A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientBeginDeleteAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtSubscriptionScope method.

func (*DeploymentsClient) BeginDeleteAtTenantScope 

func (client *DeploymentsClient) BeginDeleteAtTenantScope(ctx context.Context, deploymentName string, options *DeploymentsClientBeginDeleteAtTenantScopeOptions) (*runtime.Poller[DeploymentsClientDeleteAtTenantScopeResponse], error)

BeginDeleteAtTenantScope - A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientBeginDeleteAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtTenantScope method.

func (*DeploymentsClient) BeginValidate 

func (client *DeploymentsClient) BeginValidate(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment, options *DeploymentsClientBeginValidateOptions) (*runtime.Poller[DeploymentsClientValidateResponse], error)

BeginValidate - Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group the template will be deployed to. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginValidateOptions contains the optional parameters for the DeploymentsClient.BeginValidate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginValidate(ctx, "my-resource-group", "my-deployment", armresources.Deployment{
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			QueryString: to.Ptr("sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"),
			URI:         to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentValidateResult = armresources.DeploymentValidateResult{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Diagnostics: []*armresources.DeploymentDiagnosticsDefinition{
// 			{
// 				Code: to.Ptr("NestedDeploymentShortCircuited"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("A nested deployment got short-circuited and all its resources got skipped from validation. This is due to a nested template having a parameter that was not fully evaluated (e.g. contains a reference() function)."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentSkippedFromInternalExpansion"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("When nested deployments are expanded, all its inner resources are retrieved for further validation. This process is performed in batch of: '10' at a time. Nested deployments exceeding this batch count are skipped from expansion."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentExpansionLimitReached"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("Nested deployments are expanded up to: '50' in total. Nested deployments exceeding this count are skipped from expansion."),
// 		}},
// 		Duration: to.Ptr("PT22.8356799S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Storage"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							to.Ptr("eastus")},
// 							ResourceType: to.Ptr("storageAccounts"),
// 					}},
// 			}},
// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 			TemplateHash: to.Ptr("0000000000000000000"),
// 			TemplateLink: &armresources.TemplateLink{
// 				ContentVersion: to.Ptr("1.0.0.0"),
// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
// 			},
// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
// 			ValidatedResources: []*armresources.ResourceReference{
// 				{
// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"),
// 			}},
// 		},
// 	}

Output:

func (*DeploymentsClient) BeginValidateAtManagementGroupScope 

func (client *DeploymentsClient) BeginValidateAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginValidateAtManagementGroupScopeOptions) (*runtime.Poller[DeploymentsClientValidateAtManagementGroupScopeResponse], error)

BeginValidateAtManagementGroupScope - Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginValidateAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtManagementGroupScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnManagementGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginValidateAtManagementGroupScope(ctx, "my-management-group-id", "my-deployment", armresources.ScopedDeployment{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentValidateResult = armresources.DeploymentValidateResult{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Diagnostics: []*armresources.DeploymentDiagnosticsDefinition{
// 			{
// 				Code: to.Ptr("NestedDeploymentShortCircuited"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("A nested deployment got short-circuited and all its resources got skipped from validation. This is due to a nested template having a parameter that was not fully evaluated (e.g. contains a reference() function)."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentSkippedFromInternalExpansion"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("When nested deployments are expanded, all its inner resources are retrieved for further validation. This process is performed in batch of: '10' at a time. Nested deployments exceeding this batch count are skipped from expansion."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentExpansionLimitReached"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("Nested deployments are expanded up to: '50' in total. Nested deployments exceeding this count are skipped from expansion."),
// 		}},
// 		Duration: to.Ptr("PT22.8356799S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Authorization"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							nil},
// 							ResourceType: to.Ptr("policyAssignments"),
// 					}},
// 			}},
// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 			TemplateHash: to.Ptr("0000000000000000000"),
// 			TemplateLink: &armresources.TemplateLink{
// 				ContentVersion: to.Ptr("1.0.0.0"),
// 				URI: to.Ptr("https://example.com/exampleTemplate.json"),
// 			},
// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
// 			ValidatedResources: []*armresources.ResourceReference{
// 				{
// 					ID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment"),
// 			}},
// 		},
// 	}

Output:

func (*DeploymentsClient) BeginValidateAtScope 

func (client *DeploymentsClient) BeginValidateAtScope(ctx context.Context, scope string, deploymentName string, parameters Deployment, options *DeploymentsClientBeginValidateAtScopeOptions) (*runtime.Poller[DeploymentsClientValidateAtScopeResponse], error)

BeginValidateAtScope - Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginValidateAtScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnScope.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginValidateAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group", "my-deployment", armresources.Deployment{
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			QueryString: to.Ptr("sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"),
			URI:         to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentValidateResult = armresources.DeploymentValidateResult{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Diagnostics: []*armresources.DeploymentDiagnosticsDefinition{
// 			{
// 				Code: to.Ptr("NestedDeploymentShortCircuited"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("A nested deployment got short-circuited and all its resources got skipped from validation. This is due to a nested template having a parameter that was not fully evaluated (e.g. contains a reference() function)."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentSkippedFromInternalExpansion"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("When nested deployments are expanded, all its inner resources are retrieved for further validation. This process is performed in batch of: '10' at a time. Nested deployments exceeding this batch count are skipped from expansion."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentExpansionLimitReached"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("Nested deployments are expanded up to: '50' in total. Nested deployments exceeding this count are skipped from expansion."),
// 		}},
// 		Duration: to.Ptr("PT22.8356799S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Storage"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							to.Ptr("eastus")},
// 							ResourceType: to.Ptr("storageAccounts"),
// 					}},
// 			}},
// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 			TemplateHash: to.Ptr("0000000000000000000"),
// 			TemplateLink: &armresources.TemplateLink{
// 				ContentVersion: to.Ptr("1.0.0.0"),
// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
// 			},
// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
// 			ValidatedResources: []*armresources.ResourceReference{
// 				{
// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"),
// 			}},
// 		},
// 	}

Output:

func (*DeploymentsClient) BeginValidateAtSubscriptionScope 

func (client *DeploymentsClient) BeginValidateAtSubscriptionScope(ctx context.Context, deploymentName string, parameters Deployment, options *DeploymentsClientBeginValidateAtSubscriptionScopeOptions) (*runtime.Poller[DeploymentsClientValidateAtSubscriptionScopeResponse], error)

BeginValidateAtSubscriptionScope - Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginValidateAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtSubscriptionScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginValidateAtSubscriptionScope(ctx, "my-deployment", armresources.Deployment{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentValidateResult = armresources.DeploymentValidateResult{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Diagnostics: []*armresources.DeploymentDiagnosticsDefinition{
// 			{
// 				Code: to.Ptr("NestedDeploymentShortCircuited"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("A nested deployment got short-circuited and all its resources got skipped from validation. This is due to a nested template having a parameter that was not fully evaluated (e.g. contains a reference() function)."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentSkippedFromInternalExpansion"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("When nested deployments are expanded, all its inner resources are retrieved for further validation. This process is performed in batch of: '10' at a time. Nested deployments exceeding this batch count are skipped from expansion."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentExpansionLimitReached"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("Nested deployments are expanded up to: '50' in total. Nested deployments exceeding this count are skipped from expansion."),
// 		}},
// 		Duration: to.Ptr("PT22.8356799S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Resources"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							to.Ptr("eastus")},
// 							ResourceType: to.Ptr("resourceGroups"),
// 					}},
// 			}},
// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 			TemplateHash: to.Ptr("0000000000000000000"),
// 			TemplateLink: &armresources.TemplateLink{
// 				ContentVersion: to.Ptr("1.0.0.0"),
// 				URI: to.Ptr("https://example.com/exampleTemplate.json"),
// 			},
// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
// 			ValidatedResources: []*armresources.ResourceReference{
// 				{
// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2"),
// 			}},
// 		},
// 	}

Output:

func (*DeploymentsClient) BeginValidateAtTenantScope 

func (client *DeploymentsClient) BeginValidateAtTenantScope(ctx context.Context, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginValidateAtTenantScopeOptions) (*runtime.Poller[DeploymentsClientValidateAtTenantScopeResponse], error)

BeginValidateAtTenantScope - Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginValidateAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtTenantScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnTenant.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginValidateAtTenantScope(ctx, "my-deployment", armresources.ScopedDeployment{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentValidateResult = armresources.DeploymentValidateResult{
// 	Name: to.Ptr("my-deployment"),
// 	Type: to.Ptr("Microsoft.Resources/deployments"),
// 	ID: to.Ptr("/providers/Microsoft.Resources/deployments/my-deployment"),
// 	Properties: &armresources.DeploymentPropertiesExtended{
// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		Dependencies: []*armresources.Dependency{
// 		},
// 		Diagnostics: []*armresources.DeploymentDiagnosticsDefinition{
// 			{
// 				Code: to.Ptr("NestedDeploymentShortCircuited"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("A nested deployment got short-circuited and all its resources got skipped from validation. This is due to a nested template having a parameter that was not fully evaluated (e.g. contains a reference() function)."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentSkippedFromInternalExpansion"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("When nested deployments are expanded, all its inner resources are retrieved for further validation. This process is performed in batch of: '10' at a time. Nested deployments exceeding this batch count are skipped from expansion."),
// 			},
// 			{
// 				Code: to.Ptr("NestedDeploymentExpansionLimitReached"),
// 				Level: to.Ptr(armresources.LevelWarning),
// 				Message: to.Ptr("Nested deployments are expanded up to: '50' in total. Nested deployments exceeding this count are skipped from expansion."),
// 		}},
// 		Duration: to.Ptr("PT22.8356799S"),
// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
// 		Parameters: map[string]any{
// 		},
// 		Providers: []*armresources.Provider{
// 			{
// 				Namespace: to.Ptr("Microsoft.Authorization"),
// 				ResourceTypes: []*armresources.ProviderResourceType{
// 					{
// 						Locations: []*string{
// 							nil},
// 							ResourceType: to.Ptr("policyDefinitions"),
// 					}},
// 			}},
// 			ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
// 			TemplateHash: to.Ptr("0000000000000000000"),
// 			TemplateLink: &armresources.TemplateLink{
// 				ContentVersion: to.Ptr("1.0.0.0"),
// 				URI: to.Ptr("https://example.com/exampleTemplate.json"),
// 			},
// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T01:20:01.723Z"); return t}()),
// 			ValidatedResources: []*armresources.ResourceReference{
// 				{
// 					ID: to.Ptr("/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name"),
// 			}},
// 		},
// 	}

Output:

func (*DeploymentsClient) BeginWhatIf 

func (client *DeploymentsClient) BeginWhatIf(ctx context.Context, resourceGroupName string, deploymentName string, parameters DeploymentWhatIf, options *DeploymentsClientBeginWhatIfOptions) (*runtime.Poller[DeploymentsClientWhatIfResponse], error)

BeginWhatIf - Returns changes that will be made by the deployment if executed at the scope of the resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group the template will be deployed to. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginWhatIfOptions contains the optional parameters for the DeploymentsClient.BeginWhatIf method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentWhatIfOnResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginWhatIf(ctx, "my-resource-group", "my-deployment", armresources.DeploymentWhatIf{
	Properties: &armresources.DeploymentWhatIfProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.WhatIfOperationResult = armresources.WhatIfOperationResult{
// 	Properties: &armresources.WhatIfOperationProperties{
// 		Changes: []*armresources.WhatIfChange{
// 			{
// 				After: map[string]any{
// 					"name": "myExistingIdentity",
// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
// 					"apiVersion": "2018-11-30",
// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
// 					"location": "westus2",
// 					"tags":map[string]any{
// 						"myNewTag": "my tag value",
// 					},
// 				},
// 				Before: map[string]any{
// 					"name": "myExistingIdentity",
// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
// 					"apiVersion": "2018-11-30",
// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
// 					"location": "westus2",
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeModify),
// 				Delta: []*armresources.WhatIfPropertyChange{
// 					{
// 						Path: to.Ptr("tags.myNewTag"),
// 						After: "my tag value",
// 						PropertyChangeType: to.Ptr(armresources.PropertyChangeTypeCreate),
// 				}},
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity"),
// 			},
// 			{
// 				After: map[string]any{
// 					"name": "myNewIdentity",
// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
// 					"apiVersion": "2018-11-30",
// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
// 					"location": "eastus",
// 					"tags":map[string]any{
// 						"myOtherNewTag": "another new tag value",
// 					},
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity"),
// 		}},
// 	},
// 	Status: to.Ptr("Succeeded"),
// }

Output:

func (*DeploymentsClient) BeginWhatIfAtManagementGroupScope 

func (client *DeploymentsClient) BeginWhatIfAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, parameters ScopedDeploymentWhatIf, options *DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions) (*runtime.Poller[DeploymentsClientWhatIfAtManagementGroupScopeResponse], error)

BeginWhatIfAtManagementGroupScope - Returns changes that will be made by the deployment if executed at the scope of the management group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtManagementGroupScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentWhatIfOnManagementGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginWhatIfAtManagementGroupScope(ctx, "myManagementGruop", "exampleDeploymentName", armresources.ScopedDeploymentWhatIf{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentWhatIfProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.WhatIfOperationResult = armresources.WhatIfOperationResult{
// 	Properties: &armresources.WhatIfOperationProperties{
// 		Changes: []*armresources.WhatIfChange{
// 			{
// 				After: map[string]any{
// 					"before":map[string]any{
// 						"name": "myPolicyAssignment",
// 						"type": "Microsoft.Authorization/policyAssignments",
// 						"apiVersion": "2019-06-01",
// 						"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
// 						"location": "westus2",
// 						"properties":map[string]any{
// 							"enforcementMode": "DoNotEnforce",
// 							"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
// 							"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
// 						},
// 					},
// 					"changeType": "Modify",
// 					"delta":[]any{
// 						map[string]any{
// 							"path": "properties.enforcementMode",
// 							"after": "DoNotEnforce",
// 							"before": "Default",
// 							"propertyChangeType": "Modify",
// 						},
// 					},
// 					"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
// 				},
// 				Before: map[string]any{
// 					"name": "myPolicyAssignment",
// 					"type": "Microsoft.Authorization/policyAssignments",
// 					"apiVersion": "2019-06-01",
// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
// 					"location": "westus2",
// 					"properties":map[string]any{
// 						"enforcementMode": "Default",
// 						"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
// 						"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
// 					},
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeModify),
// 				ResourceID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment"),
// 			},
// 			{
// 				After: map[string]any{
// 					"name": "myPolicyAssignment2",
// 					"type": "Microsoft.Authorization/policyAssignments",
// 					"apiVersion": "2019-06-01",
// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
// 					"location": "westus2",
// 					"properties":map[string]any{
// 						"enforcementMode": "Default",
// 						"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
// 						"scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
// 					},
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
// 				ResourceID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2"),
// 		}},
// 	},
// 	Status: to.Ptr("Succeeded"),
// }

Output:

func (*DeploymentsClient) BeginWhatIfAtSubscriptionScope 

func (client *DeploymentsClient) BeginWhatIfAtSubscriptionScope(ctx context.Context, deploymentName string, parameters DeploymentWhatIf, options *DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions) (*runtime.Poller[DeploymentsClientWhatIfAtSubscriptionScopeResponse], error)

BeginWhatIfAtSubscriptionScope - Returns changes that will be made by the deployment if executed at the scope of the subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • parameters - Parameters to What If.
  • options - DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtSubscriptionScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentWhatIfOnSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginWhatIfAtSubscriptionScope(ctx, "my-deployment", armresources.DeploymentWhatIf{
	Location: to.Ptr("westus"),
	Properties: &armresources.DeploymentWhatIfProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.WhatIfOperationResult = armresources.WhatIfOperationResult{
// 	Properties: &armresources.WhatIfOperationProperties{
// 		Changes: []*armresources.WhatIfChange{
// 			{
// 				After: map[string]any{
// 					"name": "myExistingIdentity",
// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
// 					"apiVersion": "2018-11-30",
// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
// 					"location": "westus2",
// 					"tags":map[string]any{
// 						"myNewTag": "my tag value",
// 					},
// 				},
// 				Before: map[string]any{
// 					"name": "myExistingIdentity",
// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
// 					"apiVersion": "2018-11-30",
// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
// 					"location": "westus2",
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeModify),
// 				Delta: []*armresources.WhatIfPropertyChange{
// 					{
// 						Path: to.Ptr("tags.myNewTag"),
// 						After: "my tag value",
// 						PropertyChangeType: to.Ptr(armresources.PropertyChangeTypeCreate),
// 				}},
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity"),
// 			},
// 			{
// 				After: map[string]any{
// 					"name": "myNewIdentity",
// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
// 					"apiVersion": "2018-11-30",
// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
// 					"location": "eastus",
// 					"tags":map[string]any{
// 						"myOtherNewTag": "another new tag value",
// 					},
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity"),
// 			},
// 			{
// 				After: map[string]any{
// 					"name": "my-resource-group2",
// 					"type": "Microsoft.Resources/resourceGroups",
// 					"apiVersion": "2019-03-01",
// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
// 					"location": "{location3}",
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2"),
// 		}},
// 	},
// 	Status: to.Ptr("Succeeded"),
// }

Output:

func (*DeploymentsClient) BeginWhatIfAtTenantScope 

func (client *DeploymentsClient) BeginWhatIfAtTenantScope(ctx context.Context, deploymentName string, parameters ScopedDeploymentWhatIf, options *DeploymentsClientBeginWhatIfAtTenantScopeOptions) (*runtime.Poller[DeploymentsClientWhatIfAtTenantScopeResponse], error)

BeginWhatIfAtTenantScope - Returns changes that will be made by the deployment if executed at the scope of the tenant group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • parameters - Parameters to validate.
  • options - DeploymentsClientBeginWhatIfAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtTenantScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentWhatIfOnTenant.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginWhatIfAtTenantScope(ctx, "exampleDeploymentName", armresources.ScopedDeploymentWhatIf{
	Location: to.Ptr("eastus"),
	Properties: &armresources.DeploymentWhatIfProperties{
		Mode:       to.Ptr(armresources.DeploymentModeIncremental),
		Parameters: map[string]*armresources.DeploymentParameter{},
		TemplateLink: &armresources.TemplateLink{
			URI: to.Ptr("https://example.com/exampleTemplate.json"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.WhatIfOperationResult = armresources.WhatIfOperationResult{
// 	Properties: &armresources.WhatIfOperationProperties{
// 		Changes: []*armresources.WhatIfChange{
// 			{
// 				After: map[string]any{
// 					"name": "myManagementGroup",
// 					"type": "Microsoft.Management/managementGroups",
// 					"apiVersion": "2019-11-01",
// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
// 				},
// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
// 				ResourceID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup"),
// 		}},
// 	},
// 	Status: to.Ptr("Succeeded"),
// }

Output:

func (*DeploymentsClient) CalculateTemplateHash 

func (client *DeploymentsClient) CalculateTemplateHash(ctx context.Context, templateParam any, options *DeploymentsClientCalculateTemplateHashOptions) (DeploymentsClientCalculateTemplateHashResponse, error)

CalculateTemplateHash - Calculate the hash of the given template. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • templateParam - The template provided to calculate hash.
  • options - DeploymentsClientCalculateTemplateHashOptions contains the optional parameters for the DeploymentsClient.CalculateTemplateHash method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/CalculateTemplateHash.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeploymentsClient().CalculateTemplateHash(ctx, map[string]any{
	"$schema":        "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview",
	"contentVersion": "1.0.0.0",
	"outputs": map[string]any{
		"string": map[string]any{
			"type":  "string",
			"value": "myvalue",
		},
	},
	"parameters": map[string]any{
		"string": map[string]any{
			"type": "string",
		},
	},
	"resources": []any{},
	"variables": map[string]any{
		"array": []any{
			float64(1),
			float64(2),
			float64(3),
			float64(4),
		},
		"bool": true,
		"int":  float64(42),
		"object": map[string]any{
			"object": map[string]any{
				"location": "West US",
				"vmSize":   "Large",
			},
		},
		"string": "string",
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TemplateHashResult = armresources.TemplateHashResult{
// 	MinifiedTemplate: to.Ptr("{\"$SCHEMA\":\"HTTP://SCHEMAS.MANAGEMENT.AZURE.COM/DEPLOYMENTTEMPLATE?API-VERSION=2014-04-01-PREVIEW\",\"CONTENTVERSION\":\"1.0.0.0\",\"PARAMETERS\":{\"STRING\":{\"TYPE\":\"STRING\"}},\"VARIABLES\":{\"STRING\":\"STRING\",\"INT\":42,\"BOOL\":TRUE,\"ARRAY\":[1,2,3,4],\"OBJECT\":{\"OBJECT\":{\"VMSIZE\":\"LARGE\",\"LOCATION\":\"WEST US\"}}},\"RESOURCES\":[],\"OUTPUTS\":{\"STRING\":{\"TYPE\":\"STRING\",\"VALUE\":\"MYVALUE\"}}}"),
// 	TemplateHash: to.Ptr("695440707931307747"),
// }

Output:

func (*DeploymentsClient) Cancel 

func (client *DeploymentsClient) Cancel(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsClientCancelOptions) (DeploymentsClientCancelResponse, error)

Cancel - You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCancelOptions contains the optional parameters for the DeploymentsClient.Cancel method.

func (*DeploymentsClient) CancelAtManagementGroupScope 

func (client *DeploymentsClient) CancelAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, options *DeploymentsClientCancelAtManagementGroupScopeOptions) (DeploymentsClientCancelAtManagementGroupScopeResponse, error)

CancelAtManagementGroupScope - You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCancelAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtManagementGroupScope method.

func (*DeploymentsClient) CancelAtScope 

func (client *DeploymentsClient) CancelAtScope(ctx context.Context, scope string, deploymentName string, options *DeploymentsClientCancelAtScopeOptions) (DeploymentsClientCancelAtScopeResponse, error)

CancelAtScope - You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCancelAtScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtScope method.

func (*DeploymentsClient) CancelAtSubscriptionScope 

func (client *DeploymentsClient) CancelAtSubscriptionScope(ctx context.Context, deploymentName string, options *DeploymentsClientCancelAtSubscriptionScopeOptions) (DeploymentsClientCancelAtSubscriptionScopeResponse, error)

CancelAtSubscriptionScope - You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCancelAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtSubscriptionScope method.

func (*DeploymentsClient) CancelAtTenantScope 

func (client *DeploymentsClient) CancelAtTenantScope(ctx context.Context, deploymentName string, options *DeploymentsClientCancelAtTenantScopeOptions) (DeploymentsClientCancelAtTenantScopeResponse, error)

CancelAtTenantScope - You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCancelAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtTenantScope method.

func (*DeploymentsClient) CheckExistence 

func (client *DeploymentsClient) CheckExistence(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsClientCheckExistenceOptions) (DeploymentsClientCheckExistenceResponse, error)

CheckExistence - Checks whether the deployment exists.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group with the deployment to check. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCheckExistenceOptions contains the optional parameters for the DeploymentsClient.CheckExistence method.

func (*DeploymentsClient) CheckExistenceAtManagementGroupScope 

func (client *DeploymentsClient) CheckExistenceAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, options *DeploymentsClientCheckExistenceAtManagementGroupScopeOptions) (DeploymentsClientCheckExistenceAtManagementGroupScopeResponse, error)

CheckExistenceAtManagementGroupScope - Checks whether the deployment exists.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCheckExistenceAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtManagementGroupScope method.

func (*DeploymentsClient) CheckExistenceAtScope 

func (client *DeploymentsClient) CheckExistenceAtScope(ctx context.Context, scope string, deploymentName string, options *DeploymentsClientCheckExistenceAtScopeOptions) (DeploymentsClientCheckExistenceAtScopeResponse, error)

CheckExistenceAtScope - Checks whether the deployment exists.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCheckExistenceAtScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtScope method.

func (*DeploymentsClient) CheckExistenceAtSubscriptionScope 

func (client *DeploymentsClient) CheckExistenceAtSubscriptionScope(ctx context.Context, deploymentName string, options *DeploymentsClientCheckExistenceAtSubscriptionScopeOptions) (DeploymentsClientCheckExistenceAtSubscriptionScopeResponse, error)

CheckExistenceAtSubscriptionScope - Checks whether the deployment exists.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCheckExistenceAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtSubscriptionScope method.

func (*DeploymentsClient) CheckExistenceAtTenantScope 

func (client *DeploymentsClient) CheckExistenceAtTenantScope(ctx context.Context, deploymentName string, options *DeploymentsClientCheckExistenceAtTenantScopeOptions) (DeploymentsClientCheckExistenceAtTenantScopeResponse, error)

CheckExistenceAtTenantScope - Checks whether the deployment exists.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientCheckExistenceAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtTenantScope method.

func (*DeploymentsClient) ExportTemplate 

func (client *DeploymentsClient) ExportTemplate(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsClientExportTemplateOptions) (DeploymentsClientExportTemplateResponse, error)

ExportTemplate - Exports the template used for specified deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientExportTemplateOptions contains the optional parameters for the DeploymentsClient.ExportTemplate method.

func (*DeploymentsClient) ExportTemplateAtManagementGroupScope 

func (client *DeploymentsClient) ExportTemplateAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, options *DeploymentsClientExportTemplateAtManagementGroupScopeOptions) (DeploymentsClientExportTemplateAtManagementGroupScopeResponse, error)

ExportTemplateAtManagementGroupScope - Exports the template used for specified deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientExportTemplateAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtManagementGroupScope method.

func (*DeploymentsClient) ExportTemplateAtScope 

func (client *DeploymentsClient) ExportTemplateAtScope(ctx context.Context, scope string, deploymentName string, options *DeploymentsClientExportTemplateAtScopeOptions) (DeploymentsClientExportTemplateAtScopeResponse, error)

ExportTemplateAtScope - Exports the template used for specified deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientExportTemplateAtScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtScope method.

func (*DeploymentsClient) ExportTemplateAtSubscriptionScope 

func (client *DeploymentsClient) ExportTemplateAtSubscriptionScope(ctx context.Context, deploymentName string, options *DeploymentsClientExportTemplateAtSubscriptionScopeOptions) (DeploymentsClientExportTemplateAtSubscriptionScopeResponse, error)

ExportTemplateAtSubscriptionScope - Exports the template used for specified deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientExportTemplateAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtSubscriptionScope method.

func (*DeploymentsClient) ExportTemplateAtTenantScope 

func (client *DeploymentsClient) ExportTemplateAtTenantScope(ctx context.Context, deploymentName string, options *DeploymentsClientExportTemplateAtTenantScopeOptions) (DeploymentsClientExportTemplateAtTenantScopeResponse, error)

ExportTemplateAtTenantScope - Exports the template used for specified deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientExportTemplateAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtTenantScope method.

func (*DeploymentsClient) Get 

func (client *DeploymentsClient) Get(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsClientGetOptions) (DeploymentsClientGetResponse, error)

Get - Gets a deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientGetOptions contains the optional parameters for the DeploymentsClient.Get method.

func (*DeploymentsClient) GetAtManagementGroupScope 

func (client *DeploymentsClient) GetAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, options *DeploymentsClientGetAtManagementGroupScopeOptions) (DeploymentsClientGetAtManagementGroupScopeResponse, error)

GetAtManagementGroupScope - Gets a deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientGetAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.GetAtManagementGroupScope method.

func (*DeploymentsClient) GetAtScope 

func (client *DeploymentsClient) GetAtScope(ctx context.Context, scope string, deploymentName string, options *DeploymentsClientGetAtScopeOptions) (DeploymentsClientGetAtScopeResponse, error)

GetAtScope - Gets a deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • deploymentName - The name of the deployment.
  • options - DeploymentsClientGetAtScopeOptions contains the optional parameters for the DeploymentsClient.GetAtScope method.

func (*DeploymentsClient) GetAtSubscriptionScope 

func (client *DeploymentsClient) GetAtSubscriptionScope(ctx context.Context, deploymentName string, options *DeploymentsClientGetAtSubscriptionScopeOptions) (DeploymentsClientGetAtSubscriptionScopeResponse, error)

GetAtSubscriptionScope - Gets a deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientGetAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.GetAtSubscriptionScope method.

func (*DeploymentsClient) GetAtTenantScope 

func (client *DeploymentsClient) GetAtTenantScope(ctx context.Context, deploymentName string, options *DeploymentsClientGetAtTenantScopeOptions) (DeploymentsClientGetAtTenantScopeResponse, error)

GetAtTenantScope - Gets a deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • deploymentName - The name of the deployment.
  • options - DeploymentsClientGetAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.GetAtTenantScope method.

func (*DeploymentsClient) NewListAtManagementGroupScopePager 

func (client *DeploymentsClient) NewListAtManagementGroupScopePager(groupID string, options *DeploymentsClientListAtManagementGroupScopeOptions) *runtime.Pager[DeploymentsClientListAtManagementGroupScopeResponse]

NewListAtManagementGroupScopePager - Get all the deployments for a management group.

Generated from API version 2024-11-01

  • groupID - The management group ID.
  • options - DeploymentsClientListAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtManagementGroupScopePager method.

func (*DeploymentsClient) NewListAtScopePager 

func (client *DeploymentsClient) NewListAtScopePager(scope string, options *DeploymentsClientListAtScopeOptions) *runtime.Pager[DeploymentsClientListAtScopeResponse]

NewListAtScopePager - Get all the deployments at the given scope.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • options - DeploymentsClientListAtScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtScopePager method.

func (*DeploymentsClient) NewListAtSubscriptionScopePager 

func (client *DeploymentsClient) NewListAtSubscriptionScopePager(options *DeploymentsClientListAtSubscriptionScopeOptions) *runtime.Pager[DeploymentsClientListAtSubscriptionScopeResponse]

NewListAtSubscriptionScopePager - Get all the deployments for a subscription.

Generated from API version 2024-11-01

  • options - DeploymentsClientListAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtSubscriptionScopePager method.

func (*DeploymentsClient) NewListAtTenantScopePager 

func (client *DeploymentsClient) NewListAtTenantScopePager(options *DeploymentsClientListAtTenantScopeOptions) *runtime.Pager[DeploymentsClientListAtTenantScopeResponse]

NewListAtTenantScopePager - Get all the deployments at the tenant scope.

Generated from API version 2024-11-01

  • options - DeploymentsClientListAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtTenantScopePager method.

func (*DeploymentsClient) NewListByResourceGroupPager 

func (client *DeploymentsClient) NewListByResourceGroupPager(resourceGroupName string, options *DeploymentsClientListByResourceGroupOptions) *runtime.Pager[DeploymentsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Get all the deployments for a resource group.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group with the deployments to get. The name is case insensitive.
  • options - DeploymentsClientListByResourceGroupOptions contains the optional parameters for the DeploymentsClient.NewListByResourceGroupPager method.

type DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions 

type DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtManagementGroupScope method.

type DeploymentsClientBeginCreateOrUpdateAtScopeOptions 

type DeploymentsClientBeginCreateOrUpdateAtScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginCreateOrUpdateAtScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtScope method.

type DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions 

type DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtSubscriptionScope method.

type DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions 

type DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdateAtTenantScope method.

type DeploymentsClientBeginCreateOrUpdateOptions 

type DeploymentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdate method.

type DeploymentsClientBeginDeleteAtManagementGroupScopeOptions 

type DeploymentsClientBeginDeleteAtManagementGroupScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginDeleteAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtManagementGroupScope method.

type DeploymentsClientBeginDeleteAtScopeOptions 

type DeploymentsClientBeginDeleteAtScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginDeleteAtScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtScope method.

type DeploymentsClientBeginDeleteAtSubscriptionScopeOptions 

type DeploymentsClientBeginDeleteAtSubscriptionScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginDeleteAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtSubscriptionScope method.

type DeploymentsClientBeginDeleteAtTenantScopeOptions 

type DeploymentsClientBeginDeleteAtTenantScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginDeleteAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginDeleteAtTenantScope method.

type DeploymentsClientBeginDeleteOptions 

type DeploymentsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginDeleteOptions contains the optional parameters for the DeploymentsClient.BeginDelete method.

type DeploymentsClientBeginValidateAtManagementGroupScopeOptions 

type DeploymentsClientBeginValidateAtManagementGroupScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginValidateAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtManagementGroupScope method.

type DeploymentsClientBeginValidateAtScopeOptions 

type DeploymentsClientBeginValidateAtScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginValidateAtScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtScope method.

type DeploymentsClientBeginValidateAtSubscriptionScopeOptions 

type DeploymentsClientBeginValidateAtSubscriptionScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginValidateAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtSubscriptionScope method.

type DeploymentsClientBeginValidateAtTenantScopeOptions 

type DeploymentsClientBeginValidateAtTenantScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginValidateAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtTenantScope method.

type DeploymentsClientBeginValidateOptions 

type DeploymentsClientBeginValidateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginValidateOptions contains the optional parameters for the DeploymentsClient.BeginValidate method.

type DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions 

type DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtManagementGroupScope method.

type DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions 

type DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtSubscriptionScope method.

type DeploymentsClientBeginWhatIfAtTenantScopeOptions 

type DeploymentsClientBeginWhatIfAtTenantScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginWhatIfAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtTenantScope method.

type DeploymentsClientBeginWhatIfOptions 

type DeploymentsClientBeginWhatIfOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginWhatIfOptions contains the optional parameters for the DeploymentsClient.BeginWhatIf method.

type DeploymentsClientCalculateTemplateHashOptions 

type DeploymentsClientCalculateTemplateHashOptions struct {
}

DeploymentsClientCalculateTemplateHashOptions contains the optional parameters for the DeploymentsClient.CalculateTemplateHash method.

type DeploymentsClientCalculateTemplateHashResponse 

type DeploymentsClientCalculateTemplateHashResponse struct {
	// Result of the request to calculate template hash. It contains a string of minified template and its hash.
	TemplateHashResult
}

DeploymentsClientCalculateTemplateHashResponse contains the response from method DeploymentsClient.CalculateTemplateHash.

type DeploymentsClientCancelAtManagementGroupScopeOptions 

type DeploymentsClientCancelAtManagementGroupScopeOptions struct {
}

DeploymentsClientCancelAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtManagementGroupScope method.

type DeploymentsClientCancelAtManagementGroupScopeResponse 

type DeploymentsClientCancelAtManagementGroupScopeResponse struct {
}

DeploymentsClientCancelAtManagementGroupScopeResponse contains the response from method DeploymentsClient.CancelAtManagementGroupScope.

type DeploymentsClientCancelAtScopeOptions 

type DeploymentsClientCancelAtScopeOptions struct {
}

DeploymentsClientCancelAtScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtScope method.

type DeploymentsClientCancelAtScopeResponse 

type DeploymentsClientCancelAtScopeResponse struct {
}

DeploymentsClientCancelAtScopeResponse contains the response from method DeploymentsClient.CancelAtScope.

type DeploymentsClientCancelAtSubscriptionScopeOptions 

type DeploymentsClientCancelAtSubscriptionScopeOptions struct {
}

DeploymentsClientCancelAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtSubscriptionScope method.

type DeploymentsClientCancelAtSubscriptionScopeResponse 

type DeploymentsClientCancelAtSubscriptionScopeResponse struct {
}

DeploymentsClientCancelAtSubscriptionScopeResponse contains the response from method DeploymentsClient.CancelAtSubscriptionScope.

type DeploymentsClientCancelAtTenantScopeOptions 

type DeploymentsClientCancelAtTenantScopeOptions struct {
}

DeploymentsClientCancelAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.CancelAtTenantScope method.

type DeploymentsClientCancelAtTenantScopeResponse 

type DeploymentsClientCancelAtTenantScopeResponse struct {
}

DeploymentsClientCancelAtTenantScopeResponse contains the response from method DeploymentsClient.CancelAtTenantScope.

type DeploymentsClientCancelOptions 

type DeploymentsClientCancelOptions struct {
}

DeploymentsClientCancelOptions contains the optional parameters for the DeploymentsClient.Cancel method.

type DeploymentsClientCancelResponse 

type DeploymentsClientCancelResponse struct {
}

DeploymentsClientCancelResponse contains the response from method DeploymentsClient.Cancel.

type DeploymentsClientCheckExistenceAtManagementGroupScopeOptions 

type DeploymentsClientCheckExistenceAtManagementGroupScopeOptions struct {
}

DeploymentsClientCheckExistenceAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtManagementGroupScope method.

type DeploymentsClientCheckExistenceAtManagementGroupScopeResponse 

type DeploymentsClientCheckExistenceAtManagementGroupScopeResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

DeploymentsClientCheckExistenceAtManagementGroupScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtManagementGroupScope.

type DeploymentsClientCheckExistenceAtScopeOptions 

type DeploymentsClientCheckExistenceAtScopeOptions struct {
}

DeploymentsClientCheckExistenceAtScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtScope method.

type DeploymentsClientCheckExistenceAtScopeResponse 

type DeploymentsClientCheckExistenceAtScopeResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

DeploymentsClientCheckExistenceAtScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtScope.

type DeploymentsClientCheckExistenceAtSubscriptionScopeOptions 

type DeploymentsClientCheckExistenceAtSubscriptionScopeOptions struct {
}

DeploymentsClientCheckExistenceAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtSubscriptionScope method.

type DeploymentsClientCheckExistenceAtSubscriptionScopeResponse 

type DeploymentsClientCheckExistenceAtSubscriptionScopeResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

DeploymentsClientCheckExistenceAtSubscriptionScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtSubscriptionScope.

type DeploymentsClientCheckExistenceAtTenantScopeOptions 

type DeploymentsClientCheckExistenceAtTenantScopeOptions struct {
}

DeploymentsClientCheckExistenceAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.CheckExistenceAtTenantScope method.

type DeploymentsClientCheckExistenceAtTenantScopeResponse 

type DeploymentsClientCheckExistenceAtTenantScopeResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

DeploymentsClientCheckExistenceAtTenantScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtTenantScope.

type DeploymentsClientCheckExistenceOptions 

type DeploymentsClientCheckExistenceOptions struct {
}

DeploymentsClientCheckExistenceOptions contains the optional parameters for the DeploymentsClient.CheckExistence method.

type DeploymentsClientCheckExistenceResponse 

type DeploymentsClientCheckExistenceResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

DeploymentsClientCheckExistenceResponse contains the response from method DeploymentsClient.CheckExistence.

type DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse 

type DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse contains the response from method DeploymentsClient.BeginCreateOrUpdateAtManagementGroupScope.

type DeploymentsClientCreateOrUpdateAtScopeResponse 

type DeploymentsClientCreateOrUpdateAtScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtScopeResponse contains the response from method DeploymentsClient.BeginCreateOrUpdateAtScope.

type DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse 

type DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse contains the response from method DeploymentsClient.BeginCreateOrUpdateAtSubscriptionScope.

type DeploymentsClientCreateOrUpdateAtTenantScopeResponse 

type DeploymentsClientCreateOrUpdateAtTenantScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtTenantScopeResponse contains the response from method DeploymentsClient.BeginCreateOrUpdateAtTenantScope.

type DeploymentsClientCreateOrUpdateResponse 

type DeploymentsClientCreateOrUpdateResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateResponse contains the response from method DeploymentsClient.BeginCreateOrUpdate.

type DeploymentsClientDeleteAtManagementGroupScopeResponse 

type DeploymentsClientDeleteAtManagementGroupScopeResponse struct {
}

DeploymentsClientDeleteAtManagementGroupScopeResponse contains the response from method DeploymentsClient.BeginDeleteAtManagementGroupScope.

type DeploymentsClientDeleteAtScopeResponse 

type DeploymentsClientDeleteAtScopeResponse struct {
}

DeploymentsClientDeleteAtScopeResponse contains the response from method DeploymentsClient.BeginDeleteAtScope.

type DeploymentsClientDeleteAtSubscriptionScopeResponse 

type DeploymentsClientDeleteAtSubscriptionScopeResponse struct {
}

DeploymentsClientDeleteAtSubscriptionScopeResponse contains the response from method DeploymentsClient.BeginDeleteAtSubscriptionScope.

type DeploymentsClientDeleteAtTenantScopeResponse 

type DeploymentsClientDeleteAtTenantScopeResponse struct {
}

DeploymentsClientDeleteAtTenantScopeResponse contains the response from method DeploymentsClient.BeginDeleteAtTenantScope.

type DeploymentsClientDeleteResponse 

type DeploymentsClientDeleteResponse struct {
}

DeploymentsClientDeleteResponse contains the response from method DeploymentsClient.BeginDelete.

type DeploymentsClientExportTemplateAtManagementGroupScopeOptions 

type DeploymentsClientExportTemplateAtManagementGroupScopeOptions struct {
}

DeploymentsClientExportTemplateAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtManagementGroupScope method.

type DeploymentsClientExportTemplateAtManagementGroupScopeResponse 

type DeploymentsClientExportTemplateAtManagementGroupScopeResponse struct {
	// The deployment export result.
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtManagementGroupScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtManagementGroupScope.

type DeploymentsClientExportTemplateAtScopeOptions 

type DeploymentsClientExportTemplateAtScopeOptions struct {
}

DeploymentsClientExportTemplateAtScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtScope method.

type DeploymentsClientExportTemplateAtScopeResponse 

type DeploymentsClientExportTemplateAtScopeResponse struct {
	// The deployment export result.
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtScope.

type DeploymentsClientExportTemplateAtSubscriptionScopeOptions 

type DeploymentsClientExportTemplateAtSubscriptionScopeOptions struct {
}

DeploymentsClientExportTemplateAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtSubscriptionScope method.

type DeploymentsClientExportTemplateAtSubscriptionScopeResponse 

type DeploymentsClientExportTemplateAtSubscriptionScopeResponse struct {
	// The deployment export result.
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtSubscriptionScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtSubscriptionScope.

type DeploymentsClientExportTemplateAtTenantScopeOptions 

type DeploymentsClientExportTemplateAtTenantScopeOptions struct {
}

DeploymentsClientExportTemplateAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.ExportTemplateAtTenantScope method.

type DeploymentsClientExportTemplateAtTenantScopeResponse 

type DeploymentsClientExportTemplateAtTenantScopeResponse struct {
	// The deployment export result.
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtTenantScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtTenantScope.

type DeploymentsClientExportTemplateOptions 

type DeploymentsClientExportTemplateOptions struct {
}

DeploymentsClientExportTemplateOptions contains the optional parameters for the DeploymentsClient.ExportTemplate method.

type DeploymentsClientExportTemplateResponse 

type DeploymentsClientExportTemplateResponse struct {
	// The deployment export result.
	DeploymentExportResult
}

DeploymentsClientExportTemplateResponse contains the response from method DeploymentsClient.ExportTemplate.

type DeploymentsClientGetAtManagementGroupScopeOptions 

type DeploymentsClientGetAtManagementGroupScopeOptions struct {
}

DeploymentsClientGetAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.GetAtManagementGroupScope method.

type DeploymentsClientGetAtManagementGroupScopeResponse 

type DeploymentsClientGetAtManagementGroupScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientGetAtManagementGroupScopeResponse contains the response from method DeploymentsClient.GetAtManagementGroupScope.

type DeploymentsClientGetAtScopeOptions 

type DeploymentsClientGetAtScopeOptions struct {
}

DeploymentsClientGetAtScopeOptions contains the optional parameters for the DeploymentsClient.GetAtScope method.

type DeploymentsClientGetAtScopeResponse 

type DeploymentsClientGetAtScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientGetAtScopeResponse contains the response from method DeploymentsClient.GetAtScope.

type DeploymentsClientGetAtSubscriptionScopeOptions 

type DeploymentsClientGetAtSubscriptionScopeOptions struct {
}

DeploymentsClientGetAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.GetAtSubscriptionScope method.

type DeploymentsClientGetAtSubscriptionScopeResponse 

type DeploymentsClientGetAtSubscriptionScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientGetAtSubscriptionScopeResponse contains the response from method DeploymentsClient.GetAtSubscriptionScope.

type DeploymentsClientGetAtTenantScopeOptions 

type DeploymentsClientGetAtTenantScopeOptions struct {
}

DeploymentsClientGetAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.GetAtTenantScope method.

type DeploymentsClientGetAtTenantScopeResponse 

type DeploymentsClientGetAtTenantScopeResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientGetAtTenantScopeResponse contains the response from method DeploymentsClient.GetAtTenantScope.

type DeploymentsClientGetOptions 

type DeploymentsClientGetOptions struct {
}

DeploymentsClientGetOptions contains the optional parameters for the DeploymentsClient.Get method.

type DeploymentsClientGetResponse 

type DeploymentsClientGetResponse struct {
	// Deployment information.
	DeploymentExtended
}

DeploymentsClientGetResponse contains the response from method DeploymentsClient.Get.

type DeploymentsClientListAtManagementGroupScopeOptions 

type DeploymentsClientListAtManagementGroupScopeOptions struct {
	// The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
	Filter *string

	// The number of results to get. If null is passed, returns all deployments.
	Top *int32
}

DeploymentsClientListAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtManagementGroupScopePager method.

type DeploymentsClientListAtManagementGroupScopeResponse 

type DeploymentsClientListAtManagementGroupScopeResponse struct {
	// List of deployments.
	DeploymentListResult
}

DeploymentsClientListAtManagementGroupScopeResponse contains the response from method DeploymentsClient.NewListAtManagementGroupScopePager.

type DeploymentsClientListAtScopeOptions 

type DeploymentsClientListAtScopeOptions struct {
	// The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
	Filter *string

	// The number of results to get. If null is passed, returns all deployments.
	Top *int32
}

DeploymentsClientListAtScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtScopePager method.

type DeploymentsClientListAtScopeResponse 

type DeploymentsClientListAtScopeResponse struct {
	// List of deployments.
	DeploymentListResult
}

DeploymentsClientListAtScopeResponse contains the response from method DeploymentsClient.NewListAtScopePager.

type DeploymentsClientListAtSubscriptionScopeOptions 

type DeploymentsClientListAtSubscriptionScopeOptions struct {
	// The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
	Filter *string

	// The number of results to get. If null is passed, returns all deployments.
	Top *int32
}

DeploymentsClientListAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtSubscriptionScopePager method.

type DeploymentsClientListAtSubscriptionScopeResponse 

type DeploymentsClientListAtSubscriptionScopeResponse struct {
	// List of deployments.
	DeploymentListResult
}

DeploymentsClientListAtSubscriptionScopeResponse contains the response from method DeploymentsClient.NewListAtSubscriptionScopePager.

type DeploymentsClientListAtTenantScopeOptions 

type DeploymentsClientListAtTenantScopeOptions struct {
	// The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
	Filter *string

	// The number of results to get. If null is passed, returns all deployments.
	Top *int32
}

DeploymentsClientListAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.NewListAtTenantScopePager method.

type DeploymentsClientListAtTenantScopeResponse 

type DeploymentsClientListAtTenantScopeResponse struct {
	// List of deployments.
	DeploymentListResult
}

DeploymentsClientListAtTenantScopeResponse contains the response from method DeploymentsClient.NewListAtTenantScopePager.

type DeploymentsClientListByResourceGroupOptions 

type DeploymentsClientListByResourceGroupOptions struct {
	// The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
	Filter *string

	// The number of results to get. If null is passed, returns all deployments.
	Top *int32
}

DeploymentsClientListByResourceGroupOptions contains the optional parameters for the DeploymentsClient.NewListByResourceGroupPager method.

type DeploymentsClientListByResourceGroupResponse 

type DeploymentsClientListByResourceGroupResponse struct {
	// List of deployments.
	DeploymentListResult
}

DeploymentsClientListByResourceGroupResponse contains the response from method DeploymentsClient.NewListByResourceGroupPager.

type DeploymentsClientValidateAtManagementGroupScopeResponse 

type DeploymentsClientValidateAtManagementGroupScopeResponse struct {
	// Information from validate template deployment response.
	DeploymentValidateResult
}

DeploymentsClientValidateAtManagementGroupScopeResponse contains the response from method DeploymentsClient.BeginValidateAtManagementGroupScope.

type DeploymentsClientValidateAtScopeResponse 

type DeploymentsClientValidateAtScopeResponse struct {
	// Information from validate template deployment response.
	DeploymentValidateResult
}

DeploymentsClientValidateAtScopeResponse contains the response from method DeploymentsClient.BeginValidateAtScope.

type DeploymentsClientValidateAtSubscriptionScopeResponse 

type DeploymentsClientValidateAtSubscriptionScopeResponse struct {
	// Information from validate template deployment response.
	DeploymentValidateResult
}

DeploymentsClientValidateAtSubscriptionScopeResponse contains the response from method DeploymentsClient.BeginValidateAtSubscriptionScope.

type DeploymentsClientValidateAtTenantScopeResponse 

type DeploymentsClientValidateAtTenantScopeResponse struct {
	// Information from validate template deployment response.
	DeploymentValidateResult
}

DeploymentsClientValidateAtTenantScopeResponse contains the response from method DeploymentsClient.BeginValidateAtTenantScope.

type DeploymentsClientValidateResponse 

type DeploymentsClientValidateResponse struct {
	// Information from validate template deployment response.
	DeploymentValidateResult
}

DeploymentsClientValidateResponse contains the response from method DeploymentsClient.BeginValidate.

type DeploymentsClientWhatIfAtManagementGroupScopeResponse 

type DeploymentsClientWhatIfAtManagementGroupScopeResponse struct {
	// Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.
	WhatIfOperationResult
}

DeploymentsClientWhatIfAtManagementGroupScopeResponse contains the response from method DeploymentsClient.BeginWhatIfAtManagementGroupScope.

type DeploymentsClientWhatIfAtSubscriptionScopeResponse 

type DeploymentsClientWhatIfAtSubscriptionScopeResponse struct {
	// Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.
	WhatIfOperationResult
}

DeploymentsClientWhatIfAtSubscriptionScopeResponse contains the response from method DeploymentsClient.BeginWhatIfAtSubscriptionScope.

type DeploymentsClientWhatIfAtTenantScopeResponse 

type DeploymentsClientWhatIfAtTenantScopeResponse struct {
	// Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.
	WhatIfOperationResult
}

DeploymentsClientWhatIfAtTenantScopeResponse contains the response from method DeploymentsClient.BeginWhatIfAtTenantScope.

type DeploymentsClientWhatIfResponse 

type DeploymentsClientWhatIfResponse struct {
	// Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.
	WhatIfOperationResult
}

DeploymentsClientWhatIfResponse contains the response from method DeploymentsClient.BeginWhatIf.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

func (e ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorResponse 

type ErrorResponse struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorResponse

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

func (ErrorResponse) MarshalJSON 

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type ExportTemplateOutputFormat 

type ExportTemplateOutputFormat string

ExportTemplateOutputFormat - The output format for the exported resources. 

const (
	ExportTemplateOutputFormatBicep ExportTemplateOutputFormat = "Bicep"
	ExportTemplateOutputFormatJSON  ExportTemplateOutputFormat = "Json"
)

func PossibleExportTemplateOutputFormatValues 

func PossibleExportTemplateOutputFormatValues() []ExportTemplateOutputFormat

PossibleExportTemplateOutputFormatValues returns the possible values for the ExportTemplateOutputFormat const type.

type ExportTemplateRequest 

type ExportTemplateRequest struct {
	// The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue',
	// 'IncludeComments', 'SkipResourceNameParameterization',
	// 'SkipAllParameterization'
	Options *string

	// The output format for the exported resources.
	OutputFormat *ExportTemplateOutputFormat

	// The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'.
	Resources []*string
}

ExportTemplateRequest - Export resource group template request parameters.

func (ExportTemplateRequest) MarshalJSON 

func (e ExportTemplateRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExportTemplateRequest.

func (*ExportTemplateRequest) UnmarshalJSON 

func (e *ExportTemplateRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExportTemplateRequest.

type ExpressionEvaluationOptions 

type ExpressionEvaluationOptions struct {
	// The scope to be used for evaluation of parameters, variables and functions in a nested template.
	Scope *ExpressionEvaluationOptionsScopeType
}

ExpressionEvaluationOptions - Specifies whether template expressions are evaluated within the scope of the parent template or nested template.

func (ExpressionEvaluationOptions) MarshalJSON 

func (e ExpressionEvaluationOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressionEvaluationOptions.

func (*ExpressionEvaluationOptions) UnmarshalJSON 

func (e *ExpressionEvaluationOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressionEvaluationOptions.

type ExpressionEvaluationOptionsScopeType 

type ExpressionEvaluationOptionsScopeType string

ExpressionEvaluationOptionsScopeType - The scope to be used for evaluation of parameters, variables and functions in a nested template. 

const (
	ExpressionEvaluationOptionsScopeTypeInner        ExpressionEvaluationOptionsScopeType = "Inner"
	ExpressionEvaluationOptionsScopeTypeNotSpecified ExpressionEvaluationOptionsScopeType = "NotSpecified"
	ExpressionEvaluationOptionsScopeTypeOuter        ExpressionEvaluationOptionsScopeType = "Outer"
)

func PossibleExpressionEvaluationOptionsScopeTypeValues 

func PossibleExpressionEvaluationOptionsScopeTypeValues() []ExpressionEvaluationOptionsScopeType

PossibleExpressionEvaluationOptionsScopeTypeValues returns the possible values for the ExpressionEvaluationOptionsScopeType const type.

type ExtendedLocation 

type ExtendedLocation struct {
	// The extended location name.
	Name *string

	// The extended location type.
	Type *ExtendedLocationType
}

ExtendedLocation - Resource extended location.

func (ExtendedLocation) MarshalJSON 

func (e ExtendedLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedLocation.

func (*ExtendedLocation) UnmarshalJSON 

func (e *ExtendedLocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedLocation.

type ExtendedLocationType 

type ExtendedLocationType string

ExtendedLocationType - The extended location type. 

const (
	ExtendedLocationTypeEdgeZone ExtendedLocationType = "EdgeZone"
)

func PossibleExtendedLocationTypeValues 

func PossibleExtendedLocationTypeValues() []ExtendedLocationType

PossibleExtendedLocationTypeValues returns the possible values for the ExtendedLocationType const type.

type GenericResource 

type GenericResource struct {
	// Resource extended location.
	ExtendedLocation *ExtendedLocation

	// The identity of the resource.
	Identity *Identity

	// The kind of the resource.
	Kind *string

	// Resource location
	Location *string

	// ID of the resource that manages this resource.
	ManagedBy *string

	// The plan of the resource.
	Plan *Plan

	// The resource properties.
	Properties any

	// The SKU of the resource.
	SKU *SKU

	// Resource tags
	Tags map[string]*string

	// READ-ONLY; Resource ID
	ID *string

	// READ-ONLY; Resource name
	Name *string

	// READ-ONLY; Resource type
	Type *string
}

GenericResource - Resource information.

func (GenericResource) MarshalJSON 

func (g GenericResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenericResource.

func (*GenericResource) UnmarshalJSON 

func (g *GenericResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenericResource.

type GenericResourceExpanded 

type GenericResourceExpanded struct {
	// Resource extended location.
	ExtendedLocation *ExtendedLocation

	// The identity of the resource.
	Identity *Identity

	// The kind of the resource.
	Kind *string

	// Resource location
	Location *string

	// ID of the resource that manages this resource.
	ManagedBy *string

	// The plan of the resource.
	Plan *Plan

	// The resource properties.
	Properties any

	// The SKU of the resource.
	SKU *SKU

	// Resource tags
	Tags map[string]*string

	// READ-ONLY; The changed time of the resource. This is only present if requested via the $expand query parameter.
	ChangedTime *time.Time

	// READ-ONLY; The created time of the resource. This is only present if requested via the $expand query parameter.
	CreatedTime *time.Time

	// READ-ONLY; Resource ID
	ID *string

	// READ-ONLY; Resource name
	Name *string

	// READ-ONLY; The provisioning state of the resource. This is only present if requested via the $expand query parameter.
	ProvisioningState *string

	// READ-ONLY; Resource type
	Type *string
}

GenericResourceExpanded - Resource information.

func (GenericResourceExpanded) MarshalJSON 

func (g GenericResourceExpanded) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenericResourceExpanded.

func (*GenericResourceExpanded) UnmarshalJSON 

func (g *GenericResourceExpanded) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenericResourceExpanded.

type GenericResourceFilter 

type GenericResourceFilter struct {
	// The resource type.
	ResourceType *string

	// The tag name.
	Tagname *string

	// The tag value.
	Tagvalue *string
}

GenericResourceFilter - Resource filter.

func (GenericResourceFilter) MarshalJSON 

func (g GenericResourceFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenericResourceFilter.

func (*GenericResourceFilter) UnmarshalJSON 

func (g *GenericResourceFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenericResourceFilter.

type HTTPMessage 

type HTTPMessage struct {
	// HTTP message content.
	Content any
}

HTTPMessage - HTTP message.

func (HTTPMessage) MarshalJSON 

func (h HTTPMessage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPMessage.

func (*HTTPMessage) UnmarshalJSON 

func (h *HTTPMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPMessage.

type Identity 

type Identity struct {
	// The identity type.
	Type *ResourceIdentityType

	// The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource
	// ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*IdentityUserAssignedIdentitiesValue

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of resource.
	TenantID *string
}

Identity for the resource.

func (Identity) MarshalJSON 

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Identity.

func (*Identity) UnmarshalJSON 

func (i *Identity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Identity.

type IdentityUserAssignedIdentitiesValue 

type IdentityUserAssignedIdentitiesValue struct {
	// READ-ONLY; The client id of user assigned identity.
	ClientID *string

	// READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string
}

func (IdentityUserAssignedIdentitiesValue) MarshalJSON 

func (i IdentityUserAssignedIdentitiesValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityUserAssignedIdentitiesValue.

func (*IdentityUserAssignedIdentitiesValue) UnmarshalJSON 

func (i *IdentityUserAssignedIdentitiesValue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityUserAssignedIdentitiesValue.

type KeyVaultParameterReference 

type KeyVaultParameterReference struct {
	// REQUIRED; Azure Key Vault reference.
	KeyVault *KeyVaultReference

	// REQUIRED; Azure Key Vault secret name.
	SecretName *string

	// Azure Key Vault secret version.
	SecretVersion *string
}

KeyVaultParameterReference - Azure Key Vault parameter reference.

func (KeyVaultParameterReference) MarshalJSON 

func (k KeyVaultParameterReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultParameterReference.

func (*KeyVaultParameterReference) UnmarshalJSON 

func (k *KeyVaultParameterReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultParameterReference.

type KeyVaultReference 

type KeyVaultReference struct {
	// REQUIRED; Azure Key Vault resource id.
	ID *string
}

KeyVaultReference - Azure Key Vault reference.

func (KeyVaultReference) MarshalJSON 

func (k KeyVaultReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultReference.

func (*KeyVaultReference) UnmarshalJSON 

func (k *KeyVaultReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultReference.

type Level 

type Level string

Level - Denotes the additional response level. 

const (
	LevelError   Level = "Error"
	LevelInfo    Level = "Info"
	LevelWarning Level = "Warning"
)

func PossibleLevelValues 

func PossibleLevelValues() []Level

PossibleLevelValues returns the possible values for the Level const type.

type MoveInfo 

type MoveInfo struct {
	// The IDs of the resources.
	Resources []*string

	// The target resource group.
	TargetResourceGroup *string
}

MoveInfo - Parameters of move resources.

func (MoveInfo) MarshalJSON 

func (m MoveInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MoveInfo.

func (*MoveInfo) UnmarshalJSON 

func (m *MoveInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MoveInfo.

type OnErrorDeployment 

type OnErrorDeployment struct {
	// The deployment to be used on error case.
	DeploymentName *string

	// The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.
	Type *OnErrorDeploymentType
}

OnErrorDeployment - Deployment on error behavior.

func (OnErrorDeployment) MarshalJSON 

func (o OnErrorDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnErrorDeployment.

func (*OnErrorDeployment) UnmarshalJSON 

func (o *OnErrorDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OnErrorDeployment.

type OnErrorDeploymentExtended 

type OnErrorDeploymentExtended struct {
	// The deployment to be used on error case.
	DeploymentName *string

	// The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.
	Type *OnErrorDeploymentType

	// READ-ONLY; The state of the provisioning for the on error deployment.
	ProvisioningState *string
}

OnErrorDeploymentExtended - Deployment on error behavior with additional details.

func (OnErrorDeploymentExtended) MarshalJSON 

func (o OnErrorDeploymentExtended) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnErrorDeploymentExtended.

func (*OnErrorDeploymentExtended) UnmarshalJSON 

func (o *OnErrorDeploymentExtended) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OnErrorDeploymentExtended.

type OnErrorDeploymentType 

type OnErrorDeploymentType string

OnErrorDeploymentType - The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. 

const (
	OnErrorDeploymentTypeLastSuccessful     OnErrorDeploymentType = "LastSuccessful"
	OnErrorDeploymentTypeSpecificDeployment OnErrorDeploymentType = "SpecificDeployment"
)

func PossibleOnErrorDeploymentTypeValues 

func PossibleOnErrorDeploymentTypeValues() []OnErrorDeploymentType

PossibleOnErrorDeploymentTypeValues returns the possible values for the OnErrorDeploymentType const type.

type Operation 

type Operation struct {
	// The object that represents the operation.
	Display *OperationDisplay

	// Operation name: {provider}/{resource}/{operation}
	Name *string
}

Operation - Microsoft.Resources operation

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation.
	Description *string

	// Operation type: Read, write, delete, etc.
	Operation *string

	// Service provider: Microsoft.Resources
	Provider *string

	// Resource on which the operation is performed: Profile, endpoint, etc.
	Resource *string
}

OperationDisplay - The object that represents the operation.

func (OperationDisplay) MarshalJSON 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string

	// List of Microsoft.Resources operations.
	Value []*Operation
}

OperationListResult - Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available Microsoft.Resources REST API operations.

Generated from API version 2024-11-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the
	// next set of results.
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager. 

type ParametersLink struct {
	// REQUIRED; The URI of the parameters file.
	URI *string

	// If included, must match the ContentVersion in the template.
	ContentVersion *string
}

ParametersLink - Entity representing the reference to the deployment parameters.

func (ParametersLink) MarshalJSON 

func (p ParametersLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ParametersLink.

func (*ParametersLink) UnmarshalJSON 

func (p *ParametersLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ParametersLink.

type Permission 

type Permission struct {
	// Allowed actions.
	Actions []*string

	// Allowed Data actions.
	DataActions []*string

	// Denied actions.
	NotActions []*string

	// Denied Data actions.
	NotDataActions []*string
}

Permission - Role definition permissions.

func (Permission) MarshalJSON 

func (p Permission) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Permission.

func (*Permission) UnmarshalJSON 

func (p *Permission) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Permission.

type Plan 

type Plan struct {
	// The plan ID.
	Name *string

	// The offer ID.
	Product *string

	// The promotion code.
	PromotionCode *string

	// The publisher ID.
	Publisher *string

	// The plan's version.
	Version *string
}

Plan for the resource.

func (Plan) MarshalJSON 

func (p Plan) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Plan.

func (*Plan) UnmarshalJSON 

func (p *Plan) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Plan.

type PropertyChangeType 

type PropertyChangeType string

PropertyChangeType - The type of property change. 

const (
	// PropertyChangeTypeArray - The property is an array and contains nested changes.
	PropertyChangeTypeArray PropertyChangeType = "Array"
	// PropertyChangeTypeCreate - The property does not exist in the current state but is present in the desired state. The property
	// will be created when the deployment is executed.
	PropertyChangeTypeCreate PropertyChangeType = "Create"
	// PropertyChangeTypeDelete - The property exists in the current state and is missing from the desired state. It will be deleted
	// when the deployment is executed.
	PropertyChangeTypeDelete PropertyChangeType = "Delete"
	// PropertyChangeTypeModify - The property exists in both current and desired state and is different. The value of the property
	// will change when the deployment is executed.
	PropertyChangeTypeModify PropertyChangeType = "Modify"
	// PropertyChangeTypeNoEffect - The property will not be set or updated.
	PropertyChangeTypeNoEffect PropertyChangeType = "NoEffect"
)

func PossiblePropertyChangeTypeValues 

func PossiblePropertyChangeTypeValues() []PropertyChangeType

PossiblePropertyChangeTypeValues returns the possible values for the PropertyChangeType const type.

type Provider 

type Provider struct {
	// The namespace of the resource provider.
	Namespace *string

	// The provider authorization consent state.
	ProviderAuthorizationConsentState *ProviderAuthorizationConsentState

	// READ-ONLY; The provider ID.
	ID *string

	// READ-ONLY; The registration policy of the resource provider.
	RegistrationPolicy *string

	// READ-ONLY; The registration state of the resource provider.
	RegistrationState *string

	// READ-ONLY; The collection of provider resource types.
	ResourceTypes []*ProviderResourceType
}

Provider - Resource provider information.

func (Provider) MarshalJSON 

func (p Provider) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Provider.

func (*Provider) UnmarshalJSON 

func (p *Provider) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Provider.

type ProviderAuthorizationConsentState 

type ProviderAuthorizationConsentState string

ProviderAuthorizationConsentState - The provider authorization consent state. 

const (
	ProviderAuthorizationConsentStateConsented    ProviderAuthorizationConsentState = "Consented"
	ProviderAuthorizationConsentStateNotRequired  ProviderAuthorizationConsentState = "NotRequired"
	ProviderAuthorizationConsentStateNotSpecified ProviderAuthorizationConsentState = "NotSpecified"
	ProviderAuthorizationConsentStateRequired     ProviderAuthorizationConsentState = "Required"
)

func PossibleProviderAuthorizationConsentStateValues 

func PossibleProviderAuthorizationConsentStateValues() []ProviderAuthorizationConsentState

PossibleProviderAuthorizationConsentStateValues returns the possible values for the ProviderAuthorizationConsentState const type.

type ProviderConsentDefinition 

type ProviderConsentDefinition struct {
	// A value indicating whether authorization is consented or not.
	ConsentToAuthorization *bool
}

ProviderConsentDefinition - The provider consent.

func (ProviderConsentDefinition) MarshalJSON 

func (p ProviderConsentDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderConsentDefinition.

func (*ProviderConsentDefinition) UnmarshalJSON 

func (p *ProviderConsentDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderConsentDefinition.

type ProviderExtendedLocation 

type ProviderExtendedLocation struct {
	// The extended locations for the azure location.
	ExtendedLocations []*string

	// The azure location.
	Location *string

	// The extended location type.
	Type *string
}

ProviderExtendedLocation - The provider extended location.

func (ProviderExtendedLocation) MarshalJSON 

func (p ProviderExtendedLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderExtendedLocation.

func (*ProviderExtendedLocation) UnmarshalJSON 

func (p *ProviderExtendedLocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderExtendedLocation.

type ProviderListResult 

type ProviderListResult struct {
	// An array of resource providers.
	Value []*Provider

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

ProviderListResult - List of resource providers.

func (ProviderListResult) MarshalJSON 

func (p ProviderListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderListResult.

func (*ProviderListResult) UnmarshalJSON 

func (p *ProviderListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderListResult.

type ProviderPermission 

type ProviderPermission struct {
	// The application id.
	ApplicationID *string

	// Role definition properties.
	ManagedByRoleDefinition *RoleDefinition

	// The provider authorization consent state.
	ProviderAuthorizationConsentState *ProviderAuthorizationConsentState

	// Role definition properties.
	RoleDefinition *RoleDefinition
}

ProviderPermission - The provider permission

func (ProviderPermission) MarshalJSON 

func (p ProviderPermission) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderPermission.

func (*ProviderPermission) UnmarshalJSON 

func (p *ProviderPermission) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderPermission.

type ProviderPermissionListResult 

type ProviderPermissionListResult struct {
	// An array of provider permissions.
	Value []*ProviderPermission

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

ProviderPermissionListResult - List of provider permissions.

func (ProviderPermissionListResult) MarshalJSON 

func (p ProviderPermissionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderPermissionListResult.

func (*ProviderPermissionListResult) UnmarshalJSON 

func (p *ProviderPermissionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderPermissionListResult.

type ProviderRegistrationRequest 

type ProviderRegistrationRequest struct {
	// The provider consent.
	ThirdPartyProviderConsent *ProviderConsentDefinition
}

ProviderRegistrationRequest - The provider registration definition.

func (ProviderRegistrationRequest) MarshalJSON 

func (p ProviderRegistrationRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderRegistrationRequest.

func (*ProviderRegistrationRequest) UnmarshalJSON 

func (p *ProviderRegistrationRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderRegistrationRequest.

type ProviderResourceType 

type ProviderResourceType struct {
	// The API version.
	APIVersions []*string

	// The aliases that are supported by this resource type.
	Aliases []*Alias

	// The additional capabilities offered by this resource type.
	Capabilities *string

	// The location mappings that are supported by this resource type.
	LocationMappings []*ProviderExtendedLocation

	// The collection of locations where this resource type can be created.
	Locations []*string

	// The properties.
	Properties map[string]*string

	// The resource type.
	ResourceType *string
	ZoneMappings []*ZoneMapping

	// READ-ONLY; The API profiles for the resource provider.
	APIProfiles []*APIProfile

	// READ-ONLY; The default API version.
	DefaultAPIVersion *string
}

ProviderResourceType - Resource type managed by the resource provider.

func (ProviderResourceType) MarshalJSON 

func (p ProviderResourceType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderResourceType.

func (*ProviderResourceType) UnmarshalJSON 

func (p *ProviderResourceType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderResourceType.

type ProviderResourceTypeListResult 

type ProviderResourceTypeListResult struct {
	// An array of resource types.
	Value []*ProviderResourceType

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

ProviderResourceTypeListResult - List of resource types of a resource provider.

func (ProviderResourceTypeListResult) MarshalJSON 

func (p ProviderResourceTypeListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderResourceTypeListResult.

func (*ProviderResourceTypeListResult) UnmarshalJSON 

func (p *ProviderResourceTypeListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderResourceTypeListResult.

type ProviderResourceTypesClient 

type ProviderResourceTypesClient struct {
	// contains filtered or unexported fields
}

ProviderResourceTypesClient contains the methods for the ProviderResourceTypes group. Don't use this type directly, use NewProviderResourceTypesClient() instead.

func NewProviderResourceTypesClient 

func NewProviderResourceTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ProviderResourceTypesClient, error)

NewProviderResourceTypesClient creates a new instance of ProviderResourceTypesClient with the specified values.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ProviderResourceTypesClient) List 

func (client *ProviderResourceTypesClient) List(ctx context.Context, resourceProviderNamespace string, options *ProviderResourceTypesClientListOptions) (ProviderResourceTypesClientListResponse, error)

List - List the resource types for a specified resource provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceProviderNamespace - The namespace of the resource provider.
  • options - ProviderResourceTypesClientListOptions contains the optional parameters for the ProviderResourceTypesClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/GetProviderResourceTypes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewProviderResourceTypesClient().List(ctx, "Microsoft.TestRP", &armresources.ProviderResourceTypesClientListOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ProviderResourceTypeListResult = armresources.ProviderResourceTypeListResult{
// 	Value: []*armresources.ProviderResourceType{
// 		{
// 			APIVersions: []*string{
// 				to.Ptr("2018-01-01"),
// 				to.Ptr("2015-05-01")},
// 				Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
// 				LocationMappings: []*armresources.ProviderExtendedLocation{
// 					{
// 						Type: to.Ptr("EdgeZone"),
// 						ExtendedLocations: []*string{
// 							to.Ptr("LosAngeles"),
// 							to.Ptr("LosAngeles2")},
// 							Location: to.Ptr("West US"),
// 					}},
// 					Locations: []*string{
// 						to.Ptr("West US")},
// 						ResourceType: to.Ptr("TestResourceType"),
// 					},
// 					{
// 						APIVersions: []*string{
// 							to.Ptr("2018-01-01"),
// 							to.Ptr("2015-05-01")},
// 							Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
// 							Locations: []*string{
// 								to.Ptr("West US")},
// 								ResourceType: to.Ptr("TestResourceTypeSibling"),
// 						}},
// 					}

Output:

type ProviderResourceTypesClientListOptions 

type ProviderResourceTypesClientListOptions struct {
	// The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.
	Expand *string
}

ProviderResourceTypesClientListOptions contains the optional parameters for the ProviderResourceTypesClient.List method.

type ProviderResourceTypesClientListResponse 

type ProviderResourceTypesClientListResponse struct {
	// List of resource types of a resource provider.
	ProviderResourceTypeListResult
}

ProviderResourceTypesClientListResponse contains the response from method ProviderResourceTypesClient.List.

type ProvidersClient 

type ProvidersClient struct {
	// contains filtered or unexported fields
}

ProvidersClient contains the methods for the Providers group. Don't use this type directly, use NewProvidersClient() instead.

func NewProvidersClient 

func NewProvidersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ProvidersClient, error)

NewProvidersClient creates a new instance of ProvidersClient with the specified values.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ProvidersClient) Get 

func (client *ProvidersClient) Get(ctx context.Context, resourceProviderNamespace string, options *ProvidersClientGetOptions) (ProvidersClientGetResponse, error)

Get - Gets the specified resource provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceProviderNamespace - The namespace of the resource provider.
  • options - ProvidersClientGetOptions contains the optional parameters for the ProvidersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/GetProvider.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewProvidersClient().Get(ctx, "Microsoft.TestRP1", &armresources.ProvidersClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Provider = armresources.Provider{
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1"),
// 	Namespace: to.Ptr("Microsoft.TestRP1"),
// 	RegistrationPolicy: to.Ptr("RegistrationRequired"),
// 	RegistrationState: to.Ptr("Registering"),
// 	ResourceTypes: []*armresources.ProviderResourceType{
// 		{
// 			APIVersions: []*string{
// 				to.Ptr("2018-01-01"),
// 				to.Ptr("2015-05-01")},
// 				Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
// 				LocationMappings: []*armresources.ProviderExtendedLocation{
// 					{
// 						Type: to.Ptr("EdgeZone"),
// 						ExtendedLocations: []*string{
// 							to.Ptr("LosAngeles"),
// 							to.Ptr("LosAngeles2")},
// 							Location: to.Ptr("West US"),
// 					}},
// 					Locations: []*string{
// 						to.Ptr("West US")},
// 						ResourceType: to.Ptr("TestResourceType"),
// 					},
// 					{
// 						APIVersions: []*string{
// 							to.Ptr("2018-01-01"),
// 							to.Ptr("2015-05-01")},
// 							Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
// 							Locations: []*string{
// 								to.Ptr("West US")},
// 								ResourceType: to.Ptr("TestResourceTypeSibling"),
// 						}},
// 					}

Output:

func (*ProvidersClient) GetAtTenantScope 

func (client *ProvidersClient) GetAtTenantScope(ctx context.Context, resourceProviderNamespace string, options *ProvidersClientGetAtTenantScopeOptions) (ProvidersClientGetAtTenantScopeResponse, error)

GetAtTenantScope - Gets the specified resource provider at the tenant level. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceProviderNamespace - The namespace of the resource provider.
  • options - ProvidersClientGetAtTenantScopeOptions contains the optional parameters for the ProvidersClient.GetAtTenantScope method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/GetNamedProviderAtTenant.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewProvidersClient().GetAtTenantScope(ctx, "Microsoft.Storage", &armresources.ProvidersClientGetAtTenantScopeOptions{Expand: to.Ptr("resourceTypes/aliases")})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Provider = armresources.Provider{
// 	Namespace: to.Ptr("Microsoft.Storage"),
// 	ResourceTypes: []*armresources.ProviderResourceType{
// 		{
// 			Aliases: []*armresources.Alias{
// 				{
// 					Name: to.Ptr("Microsoft.Storage/storageAccounts/accountType"),
// 					DefaultPath: to.Ptr("sku.name"),
// 					Paths: []*armresources.AliasPath{
// 						{
// 							Path: to.Ptr("properties.accountType"),
// 							APIVersions: []*string{
// 								to.Ptr("2015-06-15"),
// 								to.Ptr("2015-05-01-preview")},
// 							},
// 							{
// 								Path: to.Ptr("sku.name"),
// 								APIVersions: []*string{
// 									to.Ptr("2018-11-01"),
// 									to.Ptr("2018-11-09"),
// 									to.Ptr("2018-07-01"),
// 									to.Ptr("2018-03-01-Preview"),
// 									to.Ptr("2018-02-01"),
// 									to.Ptr("2017-10-01"),
// 									to.Ptr("2017-06-01"),
// 									to.Ptr("2016-12-01"),
// 									to.Ptr("2016-05-01"),
// 									to.Ptr("2016-01-01")},
// 							}},
// 						},
// 						{
// 							Name: to.Ptr("Microsoft.Storage/storageAccounts/sku.name"),
// 							DefaultPath: to.Ptr("sku.name"),
// 							Paths: []*armresources.AliasPath{
// 								{
// 									Path: to.Ptr("properties.accountType"),
// 									APIVersions: []*string{
// 										to.Ptr("2015-06-15"),
// 										to.Ptr("2015-05-01-preview")},
// 									},
// 									{
// 										Path: to.Ptr("sku.name"),
// 										APIVersions: []*string{
// 											to.Ptr("2018-11-01"),
// 											to.Ptr("2018-11-09"),
// 											to.Ptr("2018-07-01"),
// 											to.Ptr("2018-03-01-Preview"),
// 											to.Ptr("2018-02-01"),
// 											to.Ptr("2017-10-01"),
// 											to.Ptr("2017-06-01"),
// 											to.Ptr("2016-12-01"),
// 											to.Ptr("2016-05-01"),
// 											to.Ptr("2016-01-01")},
// 									}},
// 								},
// 								{
// 									Name: to.Ptr("Microsoft.Storage/storageAccounts/accessTier"),
// 									DefaultPath: to.Ptr("properties.accessTier"),
// 									Paths: []*armresources.AliasPath{
// 										{
// 											Path: to.Ptr("properties.accessTier"),
// 											APIVersions: []*string{
// 												to.Ptr("2018-11-01"),
// 												to.Ptr("2018-11-09"),
// 												to.Ptr("2018-07-01"),
// 												to.Ptr("2018-03-01-Preview"),
// 												to.Ptr("2018-02-01"),
// 												to.Ptr("2017-10-01"),
// 												to.Ptr("2017-06-01"),
// 												to.Ptr("2016-12-01"),
// 												to.Ptr("2016-05-01"),
// 												to.Ptr("2016-01-01"),
// 												to.Ptr("2015-06-15"),
// 												to.Ptr("2015-05-01-preview")},
// 										}},
// 									},
// 									{
// 										Name: to.Ptr("Microsoft.Storage/storageAccounts/enableBlobEncryption"),
// 										DefaultPath: to.Ptr("properties.encryption.services.blob.enabled"),
// 										Paths: []*armresources.AliasPath{
// 											{
// 												Path: to.Ptr("properties.encryption.services.blob.enabled"),
// 												APIVersions: []*string{
// 													to.Ptr("2018-11-01"),
// 													to.Ptr("2018-11-09"),
// 													to.Ptr("2018-07-01"),
// 													to.Ptr("2018-03-01-Preview"),
// 													to.Ptr("2018-02-01"),
// 													to.Ptr("2017-10-01"),
// 													to.Ptr("2017-06-01"),
// 													to.Ptr("2016-12-01"),
// 													to.Ptr("2016-05-01"),
// 													to.Ptr("2016-01-01"),
// 													to.Ptr("2015-06-15"),
// 													to.Ptr("2015-05-01-preview")},
// 											}},
// 										},
// 										{
// 											Name: to.Ptr("Microsoft.Storage/storageAccounts/enableFileEncryption"),
// 											DefaultPath: to.Ptr("properties.encryption.services.file.enabled"),
// 											Paths: []*armresources.AliasPath{
// 												{
// 													Path: to.Ptr("properties.encryption.services.file.enabled"),
// 													APIVersions: []*string{
// 														to.Ptr("2018-11-01"),
// 														to.Ptr("2018-11-09"),
// 														to.Ptr("2018-07-01"),
// 														to.Ptr("2018-03-01-Preview"),
// 														to.Ptr("2018-02-01"),
// 														to.Ptr("2017-10-01"),
// 														to.Ptr("2017-06-01"),
// 														to.Ptr("2016-12-01"),
// 														to.Ptr("2016-05-01"),
// 														to.Ptr("2016-01-01"),
// 														to.Ptr("2015-06-15"),
// 														to.Ptr("2015-05-01-preview")},
// 												}},
// 											},
// 											{
// 												Name: to.Ptr("Microsoft.Storage/storageAccounts/supportsHttpsTrafficOnly"),
// 												DefaultMetadata: &armresources.AliasPathMetadata{
// 													Type: to.Ptr(armresources.AliasPathTokenTypeBoolean),
// 													Attributes: to.Ptr(armresources.AliasPathAttributesModifiable),
// 												},
// 												DefaultPath: to.Ptr("properties.supportsHttpsTrafficOnly"),
// 												Paths: []*armresources.AliasPath{
// 													{
// 														Path: to.Ptr("properties.supportsHttpsTrafficOnly"),
// 														APIVersions: []*string{
// 															to.Ptr("2018-11-09"),
// 															to.Ptr("2018-03-01-Preview"),
// 															to.Ptr("2016-05-01"),
// 															to.Ptr("2016-01-01"),
// 															to.Ptr("2015-06-15"),
// 															to.Ptr("2015-05-01-preview")},
// 															Metadata: &armresources.AliasPathMetadata{
// 																Type: to.Ptr(armresources.AliasPathTokenTypeNotSpecified),
// 																Attributes: to.Ptr(armresources.AliasPathAttributesNone),
// 															},
// 													}},
// 											}},
// 											APIProfiles: []*armresources.APIProfile{
// 												{
// 													APIVersion: to.Ptr("2017-10-01"),
// 													ProfileVersion: to.Ptr("2019-03-01-hybrid"),
// 												},
// 												{
// 													APIVersion: to.Ptr("2016-01-01"),
// 													ProfileVersion: to.Ptr("2017-03-09-profile"),
// 												},
// 												{
// 													APIVersion: to.Ptr("2016-01-01"),
// 													ProfileVersion: to.Ptr("2018-03-01-hybrid"),
// 												},
// 												{
// 													APIVersion: to.Ptr("2017-10-01"),
// 													ProfileVersion: to.Ptr("2018-06-01-profile"),
// 											}},
// 											APIVersions: []*string{
// 												to.Ptr("2019-06-01"),
// 												to.Ptr("2019-04-01"),
// 												to.Ptr("2018-11-01"),
// 												to.Ptr("2018-07-01"),
// 												to.Ptr("2018-03-01-preview"),
// 												to.Ptr("2018-02-01"),
// 												to.Ptr("2017-10-01"),
// 												to.Ptr("2017-06-01"),
// 												to.Ptr("2016-12-01"),
// 												to.Ptr("2016-05-01"),
// 												to.Ptr("2016-01-01"),
// 												to.Ptr("2015-06-15"),
// 												to.Ptr("2015-05-01-preview")},
// 												Capabilities: to.Ptr("SupportsTags, SupportsLocation"),
// 												DefaultAPIVersion: to.Ptr("2019-06-01"),
// 												Locations: []*string{
// 													to.Ptr("East US"),
// 													to.Ptr("East US 2"),
// 													to.Ptr("East US 2 (Stage)"),
// 													to.Ptr("West US"),
// 													to.Ptr("West Europe"),
// 													to.Ptr("East Asia"),
// 													to.Ptr("Southeast Asia"),
// 													to.Ptr("Japan East"),
// 													to.Ptr("Japan West"),
// 													to.Ptr("North Central US"),
// 													to.Ptr("South Central US"),
// 													to.Ptr("Central US"),
// 													to.Ptr("North Europe"),
// 													to.Ptr("Brazil South"),
// 													to.Ptr("Australia East"),
// 													to.Ptr("Australia Southeast"),
// 													to.Ptr("South India"),
// 													to.Ptr("Central India"),
// 													to.Ptr("West India"),
// 													to.Ptr("Canada East"),
// 													to.Ptr("Canada Central"),
// 													to.Ptr("West US 2"),
// 													to.Ptr("West Central US"),
// 													to.Ptr("UK South"),
// 													to.Ptr("UK West"),
// 													to.Ptr("Korea Central"),
// 													to.Ptr("Korea South"),
// 													to.Ptr("East US 2 EUAP"),
// 													to.Ptr("Central US EUAP"),
// 													to.Ptr("France Central"),
// 													to.Ptr("France South"),
// 													to.Ptr("Australia Central"),
// 													to.Ptr("Australia Central 2"),
// 													to.Ptr("South Africa West"),
// 													to.Ptr("South Africa North"),
// 													to.Ptr("UAE Central"),
// 													to.Ptr("UAE North"),
// 													to.Ptr("Switzerland North"),
// 													to.Ptr("Switzerland West"),
// 													to.Ptr("Germany West Central"),
// 													to.Ptr("Germany North"),
// 													to.Ptr("Norway East"),
// 													to.Ptr("Norway West"),
// 													to.Ptr("South Central US STG"),
// 													to.Ptr("Brazil Southeast")},
// 													ResourceType: to.Ptr("storageAccounts"),
// 											}},
// 										}

Output:

func (*ProvidersClient) NewListAtTenantScopePager 

func (client *ProvidersClient) NewListAtTenantScopePager(options *ProvidersClientListAtTenantScopeOptions) *runtime.Pager[ProvidersClientListAtTenantScopeResponse]

NewListAtTenantScopePager - Gets all resource providers for the tenant.

Generated from API version 2024-11-01

  • options - ProvidersClientListAtTenantScopeOptions contains the optional parameters for the ProvidersClient.NewListAtTenantScopePager method.

func (*ProvidersClient) NewListPager 

func (client *ProvidersClient) NewListPager(options *ProvidersClientListOptions) *runtime.Pager[ProvidersClientListResponse]

NewListPager - Gets all resource providers for a subscription.

Generated from API version 2024-11-01

  • options - ProvidersClientListOptions contains the optional parameters for the ProvidersClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/GetProviders.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewProvidersClient().NewListPager(&armresources.ProvidersClientListOptions{Expand: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ProviderListResult = armresources.ProviderListResult{
	// 	Value: []*armresources.Provider{
	// 		{
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1"),
	// 			Namespace: to.Ptr("Microsoft.TestRP1"),
	// 			RegistrationPolicy: to.Ptr("RegistrationRequired"),
	// 			RegistrationState: to.Ptr("Registering"),
	// 			ResourceTypes: []*armresources.ProviderResourceType{
	// 				{
	// 					APIVersions: []*string{
	// 						to.Ptr("2018-01-01"),
	// 						to.Ptr("2015-05-01")},
	// 						Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 						LocationMappings: []*armresources.ProviderExtendedLocation{
	// 							{
	// 								Type: to.Ptr("EdgeZone"),
	// 								ExtendedLocations: []*string{
	// 									to.Ptr("LosAngeles"),
	// 									to.Ptr("LosAngeles2")},
	// 									Location: to.Ptr("West US"),
	// 							}},
	// 							Locations: []*string{
	// 								to.Ptr("West US")},
	// 								ResourceType: to.Ptr("TestResourceType"),
	// 							},
	// 							{
	// 								APIVersions: []*string{
	// 									to.Ptr("2018-01-01"),
	// 									to.Ptr("2015-05-01")},
	// 									Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 									Locations: []*string{
	// 										to.Ptr("West US")},
	// 										ResourceType: to.Ptr("TestResourceTypeSibling"),
	// 								}},
	// 							},
	// 							{
	// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources"),
	// 								Namespace: to.Ptr("Microsoft.Resources"),
	// 								RegistrationPolicy: to.Ptr("RegistrationFree"),
	// 								RegistrationState: to.Ptr("Registered"),
	// 								ResourceTypes: []*armresources.ProviderResourceType{
	// 									{
	// 										Aliases: []*armresources.Alias{
	// 										},
	// 										APIVersions: []*string{
	// 											to.Ptr("2016-09-01"),
	// 											to.Ptr("2014-04-01-preview")},
	// 											Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 											Locations: []*string{
	// 												to.Ptr("eastus"),
	// 												to.Ptr("eastus2"),
	// 												to.Ptr("westus")},
	// 												ResourceType: to.Ptr("subscriptions"),
	// 											},
	// 											{
	// 												Aliases: []*armresources.Alias{
	// 												},
	// 												APIVersions: []*string{
	// 													to.Ptr("2016-09-01"),
	// 													to.Ptr("2014-04-01-preview")},
	// 													Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 													Locations: []*string{
	// 														to.Ptr("centralus"),
	// 														to.Ptr("eastasia"),
	// 														to.Ptr("southeastasia")},
	// 														ResourceType: to.Ptr("resourceGroups"),
	// 													},
	// 													{
	// 														Aliases: []*armresources.Alias{
	// 														},
	// 														APIVersions: []*string{
	// 															to.Ptr("2016-09-01"),
	// 															to.Ptr("2014-04-01-preview")},
	// 															Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 															Locations: []*string{
	// 																to.Ptr("eastus"),
	// 																to.Ptr("eastus2"),
	// 																to.Ptr("westus")},
	// 																ResourceType: to.Ptr("subscriptions/resourceGroups"),
	// 															},
	// 															{
	// 																Aliases: []*armresources.Alias{
	// 																},
	// 																APIVersions: []*string{
	// 																	to.Ptr("2014-04-01-preview")},
	// 																	Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 																	Locations: []*string{
	// 																		to.Ptr("centralus"),
	// 																		to.Ptr("eastasia")},
	// 																		ResourceType: to.Ptr("bulkDelete"),
	// 																	},
	// 																	{
	// 																		Aliases: []*armresources.Alias{
	// 																		},
	// 																		APIVersions: []*string{
	// 																			to.Ptr("2017-08-01"),
	// 																			to.Ptr("2017-06-01")},
	// 																			Capabilities: to.Ptr("SupportsTags"),
	// 																			Locations: []*string{
	// 																			},
	// 																			ResourceType: to.Ptr("deployments"),
	// 																		},
	// 																		{
	// 																			Aliases: []*armresources.Alias{
	// 																			},
	// 																			APIVersions: []*string{
	// 																			},
	// 																			Capabilities: to.Ptr("SupportsExtension"),
	// 																			Locations: []*string{
	// 																				to.Ptr("DevFabric")},
	// 																				ResourceType: to.Ptr("tags"),
	// 																		}},
	// 																	},
	// 																	{
	// 																		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP2"),
	// 																		Namespace: to.Ptr("Microsoft.TestRP2"),
	// 																		RegistrationPolicy: to.Ptr("RegistrationRequired"),
	// 																		RegistrationState: to.Ptr("NotRegistered"),
	// 																		ResourceTypes: []*armresources.ProviderResourceType{
	// 																			{
	// 																				APIVersions: []*string{
	// 																					to.Ptr("2018-01-01"),
	// 																					to.Ptr("2015-05-01")},
	// 																					Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 																					LocationMappings: []*armresources.ProviderExtendedLocation{
	// 																						{
	// 																							Type: to.Ptr("EdgeZone"),
	// 																							ExtendedLocations: []*string{
	// 																								to.Ptr("LosAngeles"),
	// 																								to.Ptr("LosAngeles2")},
	// 																								Location: to.Ptr("West US"),
	// 																						}},
	// 																						Locations: []*string{
	// 																							to.Ptr("West US")},
	// 																							ResourceType: to.Ptr("TestResourceType"),
	// 																						},
	// 																						{
	// 																							APIVersions: []*string{
	// 																								to.Ptr("2018-01-01"),
	// 																								to.Ptr("2015-05-01")},
	// 																								Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 																								Locations: []*string{
	// 																									to.Ptr("West US")},
	// 																									ResourceType: to.Ptr("TestResourceTypeSibling"),
	// 																							}},
	// 																					}},
	// 																				}
}

Output:

func (*ProvidersClient) ProviderPermissions 

func (client *ProvidersClient) ProviderPermissions(ctx context.Context, resourceProviderNamespace string, options *ProvidersClientProviderPermissionsOptions) (ProvidersClientProviderPermissionsResponse, error)

ProviderPermissions - Get the provider permissions. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceProviderNamespace - The namespace of the resource provider.
  • options - ProvidersClientProviderPermissionsOptions contains the optional parameters for the ProvidersClient.ProviderPermissions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/GetProviderPermissions.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewProvidersClient().ProviderPermissions(ctx, "Microsoft.TestRP", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ProviderPermissionListResult = armresources.ProviderPermissionListResult{
// 	Value: []*armresources.ProviderPermission{
// 		{
// 			ApplicationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			ProviderAuthorizationConsentState: to.Ptr(armresources.ProviderAuthorizationConsentStateConsented),
// 			RoleDefinition: &armresources.RoleDefinition{
// 				Name: to.Ptr("Contoso service role"),
// 				ID: to.Ptr("00000000000000000000000000000000"),
// 				IsServiceRole: to.Ptr(true),
// 				Permissions: []*armresources.Permission{
// 					{
// 						Actions: []*string{
// 							to.Ptr("Microsoft.Contoso/*")},
// 							DataActions: []*string{
// 							},
// 							NotActions: []*string{
// 							},
// 							NotDataActions: []*string{
// 							},
// 					}},
// 					Scopes: []*string{
// 						to.Ptr("/")},
// 					},
// 			}},
// 		}

Output:

func (*ProvidersClient) Register 

func (client *ProvidersClient) Register(ctx context.Context, resourceProviderNamespace string, options *ProvidersClientRegisterOptions) (ProvidersClientRegisterResponse, error)

Register - Registers a subscription with a resource provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceProviderNamespace - The namespace of the resource provider to register.
  • options - ProvidersClientRegisterOptions contains the optional parameters for the ProvidersClient.Register method.

func (*ProvidersClient) RegisterAtManagementGroupScope 

func (client *ProvidersClient) RegisterAtManagementGroupScope(ctx context.Context, resourceProviderNamespace string, groupID string, options *ProvidersClientRegisterAtManagementGroupScopeOptions) (ProvidersClientRegisterAtManagementGroupScopeResponse, error)

RegisterAtManagementGroupScope - Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceProviderNamespace - The namespace of the resource provider to register.
  • groupID - The management group ID.
  • options - ProvidersClientRegisterAtManagementGroupScopeOptions contains the optional parameters for the ProvidersClient.RegisterAtManagementGroupScope method.

func (*ProvidersClient) Unregister 

func (client *ProvidersClient) Unregister(ctx context.Context, resourceProviderNamespace string, options *ProvidersClientUnregisterOptions) (ProvidersClientUnregisterResponse, error)

Unregister - Unregisters a subscription from a resource provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceProviderNamespace - The namespace of the resource provider to unregister.
  • options - ProvidersClientUnregisterOptions contains the optional parameters for the ProvidersClient.Unregister method.

type ProvidersClientGetAtTenantScopeOptions 

type ProvidersClientGetAtTenantScopeOptions struct {
	// The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.
	Expand *string
}

ProvidersClientGetAtTenantScopeOptions contains the optional parameters for the ProvidersClient.GetAtTenantScope method.

type ProvidersClientGetAtTenantScopeResponse 

type ProvidersClientGetAtTenantScopeResponse struct {
	// Resource provider information.
	Provider
}

ProvidersClientGetAtTenantScopeResponse contains the response from method ProvidersClient.GetAtTenantScope.

type ProvidersClientGetOptions 

type ProvidersClientGetOptions struct {
	// The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.
	Expand *string
}

ProvidersClientGetOptions contains the optional parameters for the ProvidersClient.Get method.

type ProvidersClientGetResponse 

type ProvidersClientGetResponse struct {
	// Resource provider information.
	Provider
}

ProvidersClientGetResponse contains the response from method ProvidersClient.Get.

type ProvidersClientListAtTenantScopeOptions 

type ProvidersClientListAtTenantScopeOptions struct {
	// The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider
	// metadata. To include property aliases in response, use
	// $expand=resourceTypes/aliases.
	Expand *string
}

ProvidersClientListAtTenantScopeOptions contains the optional parameters for the ProvidersClient.NewListAtTenantScopePager method.

type ProvidersClientListAtTenantScopeResponse 

type ProvidersClientListAtTenantScopeResponse struct {
	// List of resource providers.
	ProviderListResult
}

ProvidersClientListAtTenantScopeResponse contains the response from method ProvidersClient.NewListAtTenantScopePager.

type ProvidersClientListOptions 

type ProvidersClientListOptions struct {
	// The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider
	// metadata. To include property aliases in response, use
	// $expand=resourceTypes/aliases.
	Expand *string
}

ProvidersClientListOptions contains the optional parameters for the ProvidersClient.NewListPager method.

type ProvidersClientListResponse 

type ProvidersClientListResponse struct {
	// List of resource providers.
	ProviderListResult
}

ProvidersClientListResponse contains the response from method ProvidersClient.NewListPager.

type ProvidersClientProviderPermissionsOptions 

type ProvidersClientProviderPermissionsOptions struct {
}

ProvidersClientProviderPermissionsOptions contains the optional parameters for the ProvidersClient.ProviderPermissions method.

type ProvidersClientProviderPermissionsResponse 

type ProvidersClientProviderPermissionsResponse struct {
	// List of provider permissions.
	ProviderPermissionListResult
}

ProvidersClientProviderPermissionsResponse contains the response from method ProvidersClient.ProviderPermissions.

type ProvidersClientRegisterAtManagementGroupScopeOptions 

type ProvidersClientRegisterAtManagementGroupScopeOptions struct {
}

ProvidersClientRegisterAtManagementGroupScopeOptions contains the optional parameters for the ProvidersClient.RegisterAtManagementGroupScope method.

type ProvidersClientRegisterAtManagementGroupScopeResponse 

type ProvidersClientRegisterAtManagementGroupScopeResponse struct {
}

ProvidersClientRegisterAtManagementGroupScopeResponse contains the response from method ProvidersClient.RegisterAtManagementGroupScope.

type ProvidersClientRegisterOptions 

type ProvidersClientRegisterOptions struct {
	// The third party consent for S2S.
	Properties *ProviderRegistrationRequest
}

ProvidersClientRegisterOptions contains the optional parameters for the ProvidersClient.Register method.

type ProvidersClientRegisterResponse 

type ProvidersClientRegisterResponse struct {
	// Resource provider information.
	Provider
}

ProvidersClientRegisterResponse contains the response from method ProvidersClient.Register.

type ProvidersClientUnregisterOptions 

type ProvidersClientUnregisterOptions struct {
}

ProvidersClientUnregisterOptions contains the optional parameters for the ProvidersClient.Unregister method.

type ProvidersClientUnregisterResponse 

type ProvidersClientUnregisterResponse struct {
	// Resource provider information.
	Provider
}

ProvidersClientUnregisterResponse contains the response from method ProvidersClient.Unregister.

type ProvisioningOperation 

type ProvisioningOperation string

ProvisioningOperation - The name of the current provisioning operation. 

const (
	// ProvisioningOperationAction - The provisioning operation is action.
	ProvisioningOperationAction ProvisioningOperation = "Action"
	// ProvisioningOperationAzureAsyncOperationWaiting - The provisioning operation is waiting Azure async operation.
	ProvisioningOperationAzureAsyncOperationWaiting ProvisioningOperation = "AzureAsyncOperationWaiting"
	// ProvisioningOperationCreate - The provisioning operation is create.
	ProvisioningOperationCreate ProvisioningOperation = "Create"
	// ProvisioningOperationDelete - The provisioning operation is delete.
	ProvisioningOperationDelete ProvisioningOperation = "Delete"
	// ProvisioningOperationDeploymentCleanup - The provisioning operation is cleanup. This operation is part of the 'complete'
	// mode deployment.
	ProvisioningOperationDeploymentCleanup ProvisioningOperation = "DeploymentCleanup"
	// ProvisioningOperationEvaluateDeploymentOutput - The provisioning operation is evaluate output.
	ProvisioningOperationEvaluateDeploymentOutput ProvisioningOperation = "EvaluateDeploymentOutput"
	// ProvisioningOperationNotSpecified - The provisioning operation is not specified.
	ProvisioningOperationNotSpecified ProvisioningOperation = "NotSpecified"
	// ProvisioningOperationRead - The provisioning operation is read.
	ProvisioningOperationRead ProvisioningOperation = "Read"
	// ProvisioningOperationResourceCacheWaiting - The provisioning operation is waiting for resource cache.
	ProvisioningOperationResourceCacheWaiting ProvisioningOperation = "ResourceCacheWaiting"
	// ProvisioningOperationWaiting - The provisioning operation is waiting.
	ProvisioningOperationWaiting ProvisioningOperation = "Waiting"
)

func PossibleProvisioningOperationValues 

func PossibleProvisioningOperationValues() []ProvisioningOperation

PossibleProvisioningOperationValues returns the possible values for the ProvisioningOperation const type.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Denotes the state of provisioning. 

const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreated      ProvisioningState = "Created"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateReady        ProvisioningState = "Ready"
	ProvisioningStateRunning      ProvisioningState = "Running"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type Resource 

type Resource struct {
	// Resource extended location.
	ExtendedLocation *ExtendedLocation

	// Resource location
	Location *string

	// Resource tags
	Tags map[string]*string

	// READ-ONLY; Resource ID
	ID *string

	// READ-ONLY; Resource name
	Name *string

	// READ-ONLY; Resource type
	Type *string
}

Resource - Specified resource.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceGroup 

type ResourceGroup struct {
	// REQUIRED; The location of the resource group. It cannot be changed after the resource group has been created. It must be
	// one of the supported Azure locations.
	Location *string

	// The ID of the resource that manages this resource group.
	ManagedBy *string

	// The resource group properties.
	Properties *ResourceGroupProperties

	// The tags attached to the resource group.
	Tags map[string]*string

	// READ-ONLY; The ID of the resource group.
	ID *string

	// READ-ONLY; The name of the resource group.
	Name *string

	// READ-ONLY; The type of the resource group.
	Type *string
}

ResourceGroup - Resource group information.

func (ResourceGroup) MarshalJSON 

func (r ResourceGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGroup.

func (*ResourceGroup) UnmarshalJSON 

func (r *ResourceGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroup.

type ResourceGroupExportResult 

type ResourceGroupExportResult struct {
	// The template export error.
	Error *ErrorResponse

	// The formatted export content. Used if outputFormat is set to 'Bicep'.
	Output *string

	// The template content. Used if outputFormat is empty or set to 'Json'.
	Template any
}

ResourceGroupExportResult - Resource group export result.

func (ResourceGroupExportResult) MarshalJSON 

func (r ResourceGroupExportResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGroupExportResult.

func (*ResourceGroupExportResult) UnmarshalJSON 

func (r *ResourceGroupExportResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupExportResult.

type ResourceGroupFilter 

type ResourceGroupFilter struct {
	// The tag name.
	TagName *string

	// The tag value.
	TagValue *string
}

ResourceGroupFilter - Resource group filter.

func (ResourceGroupFilter) MarshalJSON 

func (r ResourceGroupFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGroupFilter.

func (*ResourceGroupFilter) UnmarshalJSON 

func (r *ResourceGroupFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupFilter.

type ResourceGroupListResult 

type ResourceGroupListResult struct {
	// An array of resource groups.
	Value []*ResourceGroup

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

ResourceGroupListResult - List of resource groups.

func (ResourceGroupListResult) MarshalJSON 

func (r ResourceGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGroupListResult.

func (*ResourceGroupListResult) UnmarshalJSON 

func (r *ResourceGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupListResult.

type ResourceGroupPatchable 

type ResourceGroupPatchable struct {
	// The ID of the resource that manages this resource group.
	ManagedBy *string

	// The name of the resource group.
	Name *string

	// The resource group properties.
	Properties *ResourceGroupProperties

	// The tags attached to the resource group.
	Tags map[string]*string
}

ResourceGroupPatchable - Resource group information.

func (ResourceGroupPatchable) MarshalJSON 

func (r ResourceGroupPatchable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGroupPatchable.

func (*ResourceGroupPatchable) UnmarshalJSON 

func (r *ResourceGroupPatchable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupPatchable.

type ResourceGroupProperties 

type ResourceGroupProperties struct {
	// READ-ONLY; The provisioning state.
	ProvisioningState *string
}

ResourceGroupProperties - The resource group properties.

func (ResourceGroupProperties) MarshalJSON 

func (r ResourceGroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGroupProperties.

func (*ResourceGroupProperties) UnmarshalJSON 

func (r *ResourceGroupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupProperties.

type ResourceGroupsClient 

type ResourceGroupsClient struct {
	// contains filtered or unexported fields
}

ResourceGroupsClient contains the methods for the ResourceGroups group. Don't use this type directly, use NewResourceGroupsClient() instead.

func NewResourceGroupsClient 

func NewResourceGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceGroupsClient, error)

NewResourceGroupsClient creates a new instance of ResourceGroupsClient with the specified values.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ResourceGroupsClient) BeginDelete 

func (client *ResourceGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, options *ResourceGroupsClientBeginDeleteOptions) (*runtime.Poller[ResourceGroupsClientDeleteResponse], error)

BeginDelete - When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group to delete. The name is case insensitive.
  • options - ResourceGroupsClientBeginDeleteOptions contains the optional parameters for the ResourceGroupsClient.BeginDelete method.
Example (ForceDeleteAllTheVirtualMachinesAndVirtualMachineScaleSetsInAResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewResourceGroupsClient().BeginDelete(ctx, "my-resource-group", &armresources.ResourceGroupsClientBeginDeleteOptions{ForceDeletionTypes: to.Ptr("Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets")})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (ForceDeleteAllTheVirtualMachinesInAResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/ForceDeleteVMsInResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewResourceGroupsClient().BeginDelete(ctx, "my-resource-group", &armresources.ResourceGroupsClientBeginDeleteOptions{ForceDeletionTypes: to.Ptr("Microsoft.Compute/virtualMachines")})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ResourceGroupsClient) BeginExportTemplate 

func (client *ResourceGroupsClient) BeginExportTemplate(ctx context.Context, resourceGroupName string, parameters ExportTemplateRequest, options *ResourceGroupsClientBeginExportTemplateOptions) (*runtime.Poller[ResourceGroupsClientExportTemplateResponse], error)

BeginExportTemplate - Captures the specified resource group as a template. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • parameters - Parameters for exporting the template.
  • options - ResourceGroupsClientBeginExportTemplateOptions contains the optional parameters for the ResourceGroupsClient.BeginExportTemplate method.
Example (ExportAResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/ExportResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewResourceGroupsClient().BeginExportTemplate(ctx, "my-resource-group", armresources.ExportTemplateRequest{
	Options: to.Ptr("IncludeParameterDefaultValue,IncludeComments"),
	Resources: []*string{
		to.Ptr("*")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGroupExportResult = armresources.ResourceGroupExportResult{
// 	Error: &armresources.ErrorResponse{
// 		Code: to.Ptr("ExportTemplateCompletedWithErrors"),
// 		Message: to.Ptr("Export template operation completed with errors. Some resources were not exported. Please see details for more information."),
// 		Details: []*armresources.ErrorResponse{
// 		},
// 	},
// 	Template: map[string]any{
// 		"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
// 		"contentVersion": "1.0.0.0",
// 		"parameters":map[string]any{
// 			"myResourceType_myFirstResource_name":map[string]any{
// 				"type": "String",
// 				"defaultValue": "myFirstResource",
// 			},
// 			"myResourceType_myFirstResource_secret":map[string]any{
// 				"type": "SecureString",
// 				"defaultValue": nil,
// 			},
// 			"myResourceType_mySecondResource_name":map[string]any{
// 				"type": "String",
// 				"defaultValue": "mySecondResource",
// 			},
// 		},
// 		"resources":[]any{
// 			map[string]any{
// 				"name": "[parameters('myResourceType_myFirstResource_name')]",
// 				"type": "My.RP/myResourceType",
// 				"apiVersion": "2019-01-01",
// 				"location": "West US",
// 				"properties":map[string]any{
// 					"secret": "[parameters('myResourceType_myFirstResource_secret')]",
// 				},
// 			},
// 			map[string]any{
// 				"name": "[parameters('myResourceType_mySecondResource_name')]",
// 				"type": "My.RP/myResourceType",
// 				"apiVersion": "2019-01-01",
// 				"location": "West US",
// 				"properties":map[string]any{
// 					"customProperty": "hello!",
// 				},
// 			},
// 		},
// 		"variables":map[string]any{
// 		},
// 	},
// }

Output:
Example (ExportAResourceGroupAsBicep)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/ExportResourceGroupAsBicep.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewResourceGroupsClient().BeginExportTemplate(ctx, "my-resource-group", armresources.ExportTemplateRequest{
	Options:      to.Ptr("IncludeParameterDefaultValue,IncludeComments"),
	OutputFormat: to.Ptr(armresources.ExportTemplateOutputFormatBicep),
	Resources: []*string{
		to.Ptr("*")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGroupExportResult = armresources.ResourceGroupExportResult{
// 	Error: &armresources.ErrorResponse{
// 		Code: to.Ptr("ExportTemplateCompletedWithErrors"),
// 		Message: to.Ptr("Export template operation completed with errors. Some resources were not exported. Please see details for more information."),
// 		Details: []*armresources.ErrorResponse{
// 		},
// 	},

Output:
Example (ExportAResourceGroupWithFiltering)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/ExportResourceGroupWithFiltering.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewResourceGroupsClient().BeginExportTemplate(ctx, "my-resource-group", armresources.ExportTemplateRequest{
	Options: to.Ptr("SkipResourceNameParameterization"),
	Resources: []*string{
		to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGroupExportResult = armresources.ResourceGroupExportResult{
// 	Template: map[string]any{
// 		"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
// 		"contentVersion": "1.0.0.0",
// 		"parameters":map[string]any{
// 			"myResourceType_myFirstResource_secret":map[string]any{
// 				"type": "SecureString",
// 				"defaultValue": nil,
// 			},
// 		},
// 		"resources":[]any{
// 			map[string]any{
// 				"name": "myFirstResource",
// 				"type": "My.RP/myResourceType",
// 				"apiVersion": "2019-01-01",
// 				"location": "West US",
// 				"properties":map[string]any{
// 					"secret": "[parameters('myResourceType_myFirstResource_secret')]",
// 				},
// 			},
// 		},
// 		"variables":map[string]any{
// 		},
// 	},
// }

Output:

func (*ResourceGroupsClient) CheckExistence 

func (client *ResourceGroupsClient) CheckExistence(ctx context.Context, resourceGroupName string, options *ResourceGroupsClientCheckExistenceOptions) (ResourceGroupsClientCheckExistenceResponse, error)

CheckExistence - Checks whether a resource group exists.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group to check. The name is case insensitive.
  • options - ResourceGroupsClientCheckExistenceOptions contains the optional parameters for the ResourceGroupsClient.CheckExistence method.

func (*ResourceGroupsClient) CreateOrUpdate 

func (client *ResourceGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, parameters ResourceGroup, options *ResourceGroupsClientCreateOrUpdateOptions) (ResourceGroupsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
  • parameters - Parameters supplied to the create or update a resource group.
  • options - ResourceGroupsClientCreateOrUpdateOptions contains the optional parameters for the ResourceGroupsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/CreateResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGroupsClient().CreateOrUpdate(ctx, "my-resource-group", armresources.ResourceGroup{
	Location: to.Ptr("eastus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGroup = armresources.ResourceGroup{
// 	Name: to.Ptr("my-resource-group"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armresources.ResourceGroupProperties{
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:

func (*ResourceGroupsClient) Get 

func (client *ResourceGroupsClient) Get(ctx context.Context, resourceGroupName string, options *ResourceGroupsClientGetOptions) (ResourceGroupsClientGetResponse, error)

Get - Gets a resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group to get. The name is case insensitive.
  • options - ResourceGroupsClientGetOptions contains the optional parameters for the ResourceGroupsClient.Get method.

func (*ResourceGroupsClient) NewListPager 

func (client *ResourceGroupsClient) NewListPager(options *ResourceGroupsClientListOptions) *runtime.Pager[ResourceGroupsClientListResponse]

NewListPager - Gets all the resource groups for a subscription.

Generated from API version 2024-11-01

  • options - ResourceGroupsClientListOptions contains the optional parameters for the ResourceGroupsClient.NewListPager method.

func (*ResourceGroupsClient) Update 

func (client *ResourceGroupsClient) Update(ctx context.Context, resourceGroupName string, parameters ResourceGroupPatchable, options *ResourceGroupsClientUpdateOptions) (ResourceGroupsClientUpdateResponse, error)

Update - Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • resourceGroupName - The name of the resource group to update. The name is case insensitive.
  • parameters - Parameters supplied to update a resource group.
  • options - ResourceGroupsClientUpdateOptions contains the optional parameters for the ResourceGroupsClient.Update method.

type ResourceGroupsClientBeginDeleteOptions 

type ResourceGroupsClientBeginDeleteOptions struct {
	// The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets
	ForceDeletionTypes *string

	// Resumes the LRO from the provided token.
	ResumeToken string
}

ResourceGroupsClientBeginDeleteOptions contains the optional parameters for the ResourceGroupsClient.BeginDelete method.

type ResourceGroupsClientBeginExportTemplateOptions 

type ResourceGroupsClientBeginExportTemplateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ResourceGroupsClientBeginExportTemplateOptions contains the optional parameters for the ResourceGroupsClient.BeginExportTemplate method.

type ResourceGroupsClientCheckExistenceOptions 

type ResourceGroupsClientCheckExistenceOptions struct {
}

ResourceGroupsClientCheckExistenceOptions contains the optional parameters for the ResourceGroupsClient.CheckExistence method.

type ResourceGroupsClientCheckExistenceResponse 

type ResourceGroupsClientCheckExistenceResponse struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

ResourceGroupsClientCheckExistenceResponse contains the response from method ResourceGroupsClient.CheckExistence.

type ResourceGroupsClientCreateOrUpdateOptions 

type ResourceGroupsClientCreateOrUpdateOptions struct {
}

ResourceGroupsClientCreateOrUpdateOptions contains the optional parameters for the ResourceGroupsClient.CreateOrUpdate method.

type ResourceGroupsClientCreateOrUpdateResponse 

type ResourceGroupsClientCreateOrUpdateResponse struct {
	// Resource group information.
	ResourceGroup
}

ResourceGroupsClientCreateOrUpdateResponse contains the response from method ResourceGroupsClient.CreateOrUpdate.

type ResourceGroupsClientDeleteResponse 

type ResourceGroupsClientDeleteResponse struct {
}

ResourceGroupsClientDeleteResponse contains the response from method ResourceGroupsClient.BeginDelete.

type ResourceGroupsClientExportTemplateResponse 

type ResourceGroupsClientExportTemplateResponse struct {
	// Resource group export result.
	ResourceGroupExportResult
}

ResourceGroupsClientExportTemplateResponse contains the response from method ResourceGroupsClient.BeginExportTemplate.

type ResourceGroupsClientGetOptions 

type ResourceGroupsClientGetOptions struct {
}

ResourceGroupsClientGetOptions contains the optional parameters for the ResourceGroupsClient.Get method.

type ResourceGroupsClientGetResponse 

type ResourceGroupsClientGetResponse struct {
	// Resource group information.
	ResourceGroup
}

ResourceGroupsClientGetResponse contains the response from method ResourceGroupsClient.Get.

type ResourceGroupsClientListOptions 

type ResourceGroupsClientListOptions struct {
	// The filter to apply on the operation.
	// You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1'
	// and tagValue eq 'Value1'
	Filter *string

	// The number of results to return. If null is passed, returns all resource groups.
	Top *int32
}

ResourceGroupsClientListOptions contains the optional parameters for the ResourceGroupsClient.NewListPager method.

type ResourceGroupsClientListResponse 

type ResourceGroupsClientListResponse struct {
	// List of resource groups.
	ResourceGroupListResult
}

ResourceGroupsClientListResponse contains the response from method ResourceGroupsClient.NewListPager.

type ResourceGroupsClientUpdateOptions 

type ResourceGroupsClientUpdateOptions struct {
}

ResourceGroupsClientUpdateOptions contains the optional parameters for the ResourceGroupsClient.Update method.

type ResourceGroupsClientUpdateResponse 

type ResourceGroupsClientUpdateResponse struct {
	// Resource group information.
	ResourceGroup
}

ResourceGroupsClientUpdateResponse contains the response from method ResourceGroupsClient.Update.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The identity type. 

const (
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
	ResourceIdentityTypeUserAssigned               ResourceIdentityType = "UserAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

type ResourceListResult 

type ResourceListResult struct {
	// An array of resources.
	Value []*GenericResourceExpanded

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

ResourceListResult - List of resource groups.

func (ResourceListResult) MarshalJSON 

func (r ResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceListResult.

func (*ResourceListResult) UnmarshalJSON 

func (r *ResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceListResult.

type ResourceProviderOperationDisplayProperties 

type ResourceProviderOperationDisplayProperties struct {
	// Operation description.
	Description *string

	// Resource provider operation.
	Operation *string

	// Operation provider.
	Provider *string

	// Operation description.
	Publisher *string

	// Operation resource.
	Resource *string
}

ResourceProviderOperationDisplayProperties - Resource provider operation's display properties.

func (ResourceProviderOperationDisplayProperties) MarshalJSON 

func (r ResourceProviderOperationDisplayProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderOperationDisplayProperties.

func (*ResourceProviderOperationDisplayProperties) UnmarshalJSON 

func (r *ResourceProviderOperationDisplayProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderOperationDisplayProperties.

type ResourceReference 

type ResourceReference struct {
	// READ-ONLY; The fully qualified resource Id.
	ID *string
}

ResourceReference - The resource Id model.

func (ResourceReference) MarshalJSON 

func (r ResourceReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceReference.

func (*ResourceReference) UnmarshalJSON 

func (r *ResourceReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceReference.

type RoleDefinition 

type RoleDefinition struct {
	// The role definition ID.
	ID *string

	// If this is a service role.
	IsServiceRole *bool

	// The role definition name.
	Name *string

	// Role definition permissions.
	Permissions []*Permission

	// Role definition assignable scopes.
	Scopes []*string
}

RoleDefinition - Role definition properties.

func (RoleDefinition) MarshalJSON 

func (r RoleDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleDefinition.

func (*RoleDefinition) UnmarshalJSON 

func (r *RoleDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleDefinition.

type SKU 

type SKU struct {
	// The SKU capacity.
	Capacity *int32

	// The SKU family.
	Family *string

	// The SKU model.
	Model *string

	// The SKU name.
	Name *string

	// The SKU size.
	Size *string

	// The SKU tier.
	Tier *string
}

SKU for the resource.

func (SKU) MarshalJSON 

func (s SKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON 

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type ScopedDeployment 

type ScopedDeployment struct {
	// REQUIRED; The location to store the deployment data.
	Location *string

	// REQUIRED; The deployment properties.
	Properties *DeploymentProperties

	// Deployment tags
	Tags map[string]*string
}

ScopedDeployment - Deployment operation parameters.

func (ScopedDeployment) MarshalJSON 

func (s ScopedDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScopedDeployment.

func (*ScopedDeployment) UnmarshalJSON 

func (s *ScopedDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScopedDeployment.

type ScopedDeploymentWhatIf 

type ScopedDeploymentWhatIf struct {
	// REQUIRED; The location to store the deployment data.
	Location *string

	// REQUIRED; The deployment properties.
	Properties *DeploymentWhatIfProperties
}

ScopedDeploymentWhatIf - Deployment What-if operation parameters.

func (ScopedDeploymentWhatIf) MarshalJSON 

func (s ScopedDeploymentWhatIf) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScopedDeploymentWhatIf.

func (*ScopedDeploymentWhatIf) UnmarshalJSON 

func (s *ScopedDeploymentWhatIf) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScopedDeploymentWhatIf.

type StatusMessage 

type StatusMessage struct {
	// The error reported by the operation.
	Error *ErrorResponse

	// Status of the deployment operation.
	Status *string
}

StatusMessage - Operation status message object.

func (StatusMessage) MarshalJSON 

func (s StatusMessage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StatusMessage.

func (*StatusMessage) UnmarshalJSON 

func (s *StatusMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StatusMessage.

type SubResource 

type SubResource struct {
	// Resource ID
	ID *string
}

SubResource - Sub-resource.

func (SubResource) MarshalJSON 

func (s SubResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubResource.

func (*SubResource) UnmarshalJSON 

func (s *SubResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SubResource.

type TagCount 

type TagCount struct {
	// Type of count.
	Type *string

	// Value of count.
	Value *int32
}

TagCount - Tag count.

func (TagCount) MarshalJSON 

func (t TagCount) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagCount.

func (*TagCount) UnmarshalJSON 

func (t *TagCount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagCount.

type TagDetails 

type TagDetails struct {
	// The total number of resources that use the resource tag. When a tag is initially created and has no associated resources,
	// the value is 0.
	Count *TagCount

	// The tag name.
	TagName *string

	// The list of tag values.
	Values []*TagValue

	// READ-ONLY; The tag name ID.
	ID *string
}

TagDetails - Tag details.

func (TagDetails) MarshalJSON 

func (t TagDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagDetails.

func (*TagDetails) UnmarshalJSON 

func (t *TagDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagDetails.

type TagValue 

type TagValue struct {
	// The tag value count.
	Count *TagCount

	// The tag value.
	TagValue *string

	// READ-ONLY; The tag value ID.
	ID *string
}

TagValue - Tag information.

func (TagValue) MarshalJSON 

func (t TagValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagValue.

func (*TagValue) UnmarshalJSON 

func (t *TagValue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagValue.

type Tags 

type Tags struct {
	// Dictionary of
	Tags map[string]*string
}

Tags - A dictionary of name and value pairs.

func (Tags) MarshalJSON 

func (t Tags) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Tags.

func (*Tags) UnmarshalJSON 

func (t *Tags) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Tags.

type TagsClient 

type TagsClient struct {
	// contains filtered or unexported fields
}

TagsClient contains the methods for the Tags group. Don't use this type directly, use NewTagsClient() instead.

func NewTagsClient 

func NewTagsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TagsClient, error)

NewTagsClient creates a new instance of TagsClient with the specified values.

  • subscriptionID - The Microsoft Azure subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*TagsClient) BeginCreateOrUpdateAtScope 

func (client *TagsClient) BeginCreateOrUpdateAtScope(ctx context.Context, scope string, parameters TagsResource, options *TagsClientBeginCreateOrUpdateAtScopeOptions) (*runtime.Poller[TagsClientCreateOrUpdateAtScopeResponse], error)

BeginCreateOrUpdateAtScope - This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • options - TagsClientBeginCreateOrUpdateAtScopeOptions contains the optional parameters for the TagsClient.BeginCreateOrUpdateAtScope method.
Example (UpdateTagsOnAResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutTagsResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTagsClient().BeginCreateOrUpdateAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm", armresources.TagsResource{
	Properties: &armresources.Tags{
		Tags: map[string]*string{
			"tagKey1": to.Ptr("tag-value-1"),
			"tagKey2": to.Ptr("tag-value-2"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TagsResource = armresources.TagsResource{
// 	ID: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm"),
// 	Properties: &armresources.Tags{
// 		Tags: map[string]*string{
// 			"tagKey1": to.Ptr("tag-value-1"),
// 			"tagKey2": to.Ptr("tag-value-2"),
// 		},
// 	},
// }

Output:
Example (UpdateTagsOnASubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PutTagsSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTagsClient().BeginCreateOrUpdateAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", armresources.TagsResource{
	Properties: &armresources.Tags{
		Tags: map[string]*string{
			"tagKey1": to.Ptr("tag-value-1"),
			"tagKey2": to.Ptr("tag-value-2"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TagsResource = armresources.TagsResource{
// 	ID: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000"),
// 	Properties: &armresources.Tags{
// 		Tags: map[string]*string{
// 			"tagKey1": to.Ptr("tag-value-1"),
// 			"tagKey2": to.Ptr("tag-value-2"),
// 		},
// 	},
// }

Output:

func (*TagsClient) BeginDeleteAtScope 

func (client *TagsClient) BeginDeleteAtScope(ctx context.Context, scope string, options *TagsClientBeginDeleteAtScopeOptions) (*runtime.Poller[TagsClientDeleteAtScopeResponse], error)

BeginDeleteAtScope - Deletes the entire set of tags on a resource or subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • options - TagsClientBeginDeleteAtScopeOptions contains the optional parameters for the TagsClient.BeginDeleteAtScope method.
Example (UpdateTagsOnAResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/DeleteTagsResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTagsClient().BeginDeleteAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (UpdateTagsOnASubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/DeleteTagsSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTagsClient().BeginDeleteAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*TagsClient) BeginUpdateAtScope 

func (client *TagsClient) BeginUpdateAtScope(ctx context.Context, scope string, parameters TagsPatchResource, options *TagsClientBeginUpdateAtScopeOptions) (*runtime.Poller[TagsClientUpdateAtScopeResponse], error)

BeginUpdateAtScope - This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • options - TagsClientBeginUpdateAtScopeOptions contains the optional parameters for the TagsClient.BeginUpdateAtScope method.
Example (UpdateTagsOnAResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PatchTagsResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTagsClient().BeginUpdateAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm", armresources.TagsPatchResource{
	Operation: to.Ptr(armresources.TagsPatchOperationReplace),
	Properties: &armresources.Tags{
		Tags: map[string]*string{
			"tagKey1": to.Ptr("tag-value-1"),
			"tagKey2": to.Ptr("tag-value-2"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TagsResource = armresources.TagsResource{
// 	ID: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm"),
// 	Properties: &armresources.Tags{
// 		Tags: map[string]*string{
// 			"tagKey1": to.Ptr("tag-value-1"),
// 			"tagKey2": to.Ptr("tag-value-2"),
// 		},
// 	},
// }

Output:
Example (UpdateTagsOnASubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PatchTagsSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTagsClient().BeginUpdateAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", armresources.TagsPatchResource{
	Operation: to.Ptr(armresources.TagsPatchOperationReplace),
	Properties: &armresources.Tags{
		Tags: map[string]*string{
			"tagKey1": to.Ptr("tag-value-1"),
			"tagKey2": to.Ptr("tag-value-2"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TagsResource = armresources.TagsResource{
// 	ID: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000"),
// 	Properties: &armresources.Tags{
// 		Tags: map[string]*string{
// 			"tagKey1": to.Ptr("tag-value-1"),
// 			"tagKey2": to.Ptr("tag-value-2"),
// 		},
// 	},
// }

Output:

func (*TagsClient) CreateOrUpdate 

func (client *TagsClient) CreateOrUpdate(ctx context.Context, tagName string, options *TagsClientCreateOrUpdateOptions) (TagsClientCreateOrUpdateResponse, error)

CreateOrUpdate - This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • tagName - The name of the tag to create.
  • options - TagsClientCreateOrUpdateOptions contains the optional parameters for the TagsClient.CreateOrUpdate method.

func (*TagsClient) CreateOrUpdateValue 

func (client *TagsClient) CreateOrUpdateValue(ctx context.Context, tagName string, tagValue string, options *TagsClientCreateOrUpdateValueOptions) (TagsClientCreateOrUpdateValueResponse, error)

CreateOrUpdateValue - This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • tagName - The name of the tag.
  • tagValue - The value of the tag to create.
  • options - TagsClientCreateOrUpdateValueOptions contains the optional parameters for the TagsClient.CreateOrUpdateValue method.

func (*TagsClient) Delete 

func (client *TagsClient) Delete(ctx context.Context, tagName string, options *TagsClientDeleteOptions) (TagsClientDeleteResponse, error)

Delete - This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • tagName - The name of the tag.
  • options - TagsClientDeleteOptions contains the optional parameters for the TagsClient.Delete method.

func (*TagsClient) DeleteValue 

func (client *TagsClient) DeleteValue(ctx context.Context, tagName string, tagValue string, options *TagsClientDeleteValueOptions) (TagsClientDeleteValueResponse, error)

DeleteValue - This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • tagName - The name of the tag.
  • tagValue - The value of the tag to delete.
  • options - TagsClientDeleteValueOptions contains the optional parameters for the TagsClient.DeleteValue method.

func (*TagsClient) GetAtScope 

func (client *TagsClient) GetAtScope(ctx context.Context, scope string, options *TagsClientGetAtScopeOptions) (TagsClientGetAtScopeResponse, error)

GetAtScope - Gets the entire set of tags on a resource or subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-11-01

  • scope - The resource scope.
  • options - TagsClientGetAtScopeOptions contains the optional parameters for the TagsClient.GetAtScope method.
Example (GetTagsOnAResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/GetTagsResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTagsClient().GetAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TagsResource = armresources.TagsResource{
// 	ID: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm"),
// 	Properties: &armresources.Tags{
// 		Tags: map[string]*string{
// 			"tagKey1": to.Ptr("tag-value-1"),
// 			"tagKey2": to.Ptr("tag-value-2"),
// 		},
// 	},
// }

Output:
Example (GetTagsOnASubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/91bfc0d02eaed75e6a3bfb5b9b150c84c79400ed/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/GetTagsSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTagsClient().GetAtScope(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TagsResource = armresources.TagsResource{
// 	ID: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000"),
// 	Properties: &armresources.Tags{
// 		Tags: map[string]*string{
// 			"tagKey1": to.Ptr("tag-value-1"),
// 			"tagKey2": to.Ptr("tag-value-2"),
// 		},
// 	},
// }

Output:

func (*TagsClient) NewListPager 

func (client *TagsClient) NewListPager(options *TagsClientListOptions) *runtime.Pager[TagsClientListResponse]

NewListPager - This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.

Generated from API version 2024-11-01

  • options - TagsClientListOptions contains the optional parameters for the TagsClient.NewListPager method.

type TagsClientBeginCreateOrUpdateAtScopeOptions 

type TagsClientBeginCreateOrUpdateAtScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TagsClientBeginCreateOrUpdateAtScopeOptions contains the optional parameters for the TagsClient.BeginCreateOrUpdateAtScope method.

type TagsClientBeginDeleteAtScopeOptions 

type TagsClientBeginDeleteAtScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TagsClientBeginDeleteAtScopeOptions contains the optional parameters for the TagsClient.BeginDeleteAtScope method.

type TagsClientBeginUpdateAtScopeOptions 

type TagsClientBeginUpdateAtScopeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TagsClientBeginUpdateAtScopeOptions contains the optional parameters for the TagsClient.BeginUpdateAtScope method.

type TagsClientCreateOrUpdateAtScopeResponse 

type TagsClientCreateOrUpdateAtScopeResponse struct {
	// Wrapper resource for tags API requests and responses.
	TagsResource
}

TagsClientCreateOrUpdateAtScopeResponse contains the response from method TagsClient.BeginCreateOrUpdateAtScope.

type TagsClientCreateOrUpdateOptions 

type TagsClientCreateOrUpdateOptions struct {
}

TagsClientCreateOrUpdateOptions contains the optional parameters for the TagsClient.CreateOrUpdate method.

type TagsClientCreateOrUpdateResponse 

type TagsClientCreateOrUpdateResponse struct {
	// Tag details.
	TagDetails
}

TagsClientCreateOrUpdateResponse contains the response from method TagsClient.CreateOrUpdate.

type TagsClientCreateOrUpdateValueOptions 

type TagsClientCreateOrUpdateValueOptions struct {
}

TagsClientCreateOrUpdateValueOptions contains the optional parameters for the TagsClient.CreateOrUpdateValue method.

type TagsClientCreateOrUpdateValueResponse 

type TagsClientCreateOrUpdateValueResponse struct {
	// Tag information.
	TagValue
}

TagsClientCreateOrUpdateValueResponse contains the response from method TagsClient.CreateOrUpdateValue.

type TagsClientDeleteAtScopeResponse 

type TagsClientDeleteAtScopeResponse struct {
}

TagsClientDeleteAtScopeResponse contains the response from method TagsClient.BeginDeleteAtScope.

type TagsClientDeleteOptions 

type TagsClientDeleteOptions struct {
}

TagsClientDeleteOptions contains the optional parameters for the TagsClient.Delete method.

type TagsClientDeleteResponse 

type TagsClientDeleteResponse struct {
}

TagsClientDeleteResponse contains the response from method TagsClient.Delete.

type TagsClientDeleteValueOptions 

type TagsClientDeleteValueOptions struct {
}

TagsClientDeleteValueOptions contains the optional parameters for the TagsClient.DeleteValue method.

type TagsClientDeleteValueResponse 

type TagsClientDeleteValueResponse struct {
}

TagsClientDeleteValueResponse contains the response from method TagsClient.DeleteValue.

type TagsClientGetAtScopeOptions 

type TagsClientGetAtScopeOptions struct {
}

TagsClientGetAtScopeOptions contains the optional parameters for the TagsClient.GetAtScope method.

type TagsClientGetAtScopeResponse 

type TagsClientGetAtScopeResponse struct {
	// Wrapper resource for tags API requests and responses.
	TagsResource
}

TagsClientGetAtScopeResponse contains the response from method TagsClient.GetAtScope.

type TagsClientListOptions 

type TagsClientListOptions struct {
}

TagsClientListOptions contains the optional parameters for the TagsClient.NewListPager method.

type TagsClientListResponse 

type TagsClientListResponse struct {
	// List of subscription tags.
	TagsListResult
}

TagsClientListResponse contains the response from method TagsClient.NewListPager.

type TagsClientUpdateAtScopeResponse 

type TagsClientUpdateAtScopeResponse struct {
	// Wrapper resource for tags API requests and responses.
	TagsResource
}

TagsClientUpdateAtScopeResponse contains the response from method TagsClient.BeginUpdateAtScope.

type TagsListResult 

type TagsListResult struct {
	// An array of tags.
	Value []*TagDetails

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string
}

TagsListResult - List of subscription tags.

func (TagsListResult) MarshalJSON 

func (t TagsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsListResult.

func (*TagsListResult) UnmarshalJSON 

func (t *TagsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagsListResult.

type TagsPatchOperation 

type TagsPatchOperation string

TagsPatchOperation - The operation type for the patch API. 

const (
	// TagsPatchOperationDelete - The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
	TagsPatchOperationDelete TagsPatchOperation = "Delete"
	// TagsPatchOperationMerge - The 'merge' option allows adding tags with new names and updating the values of tags with existing
	// names.
	TagsPatchOperationMerge TagsPatchOperation = "Merge"
	// TagsPatchOperationReplace - The 'replace' option replaces the entire set of existing tags with a new set.
	TagsPatchOperationReplace TagsPatchOperation = "Replace"
)

func PossibleTagsPatchOperationValues 

func PossibleTagsPatchOperationValues() []TagsPatchOperation

PossibleTagsPatchOperationValues returns the possible values for the TagsPatchOperation const type.

type TagsPatchResource 

type TagsPatchResource struct {
	// The operation type for the patch API.
	Operation *TagsPatchOperation

	// The set of tags.
	Properties *Tags
}

TagsPatchResource - Wrapper resource for tags patch API request only.

func (TagsPatchResource) MarshalJSON 

func (t TagsPatchResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsPatchResource.

func (*TagsPatchResource) UnmarshalJSON 

func (t *TagsPatchResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagsPatchResource.

type TagsResource 

type TagsResource struct {
	// REQUIRED; The set of tags.
	Properties *Tags

	// READ-ONLY; The ID of the tags wrapper resource.
	ID *string

	// READ-ONLY; The name of the tags wrapper resource.
	Name *string

	// READ-ONLY; The type of the tags wrapper resource.
	Type *string
}

TagsResource - Wrapper resource for tags API requests and responses.

func (TagsResource) MarshalJSON 

func (t TagsResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsResource.

func (*TagsResource) UnmarshalJSON 

func (t *TagsResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagsResource.

type TargetResource 

type TargetResource struct {
	// The ID of the resource.
	ID *string

	// The name of the resource.
	ResourceName *string

	// The type of the resource.
	ResourceType *string
}

TargetResource - Target resource.

func (TargetResource) MarshalJSON 

func (t TargetResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TargetResource.

func (*TargetResource) UnmarshalJSON 

func (t *TargetResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TargetResource.

type TemplateHashResult 

type TemplateHashResult struct {
	// The minified template string.
	MinifiedTemplate *string

	// The template hash.
	TemplateHash *string
}

TemplateHashResult - Result of the request to calculate template hash. It contains a string of minified template and its hash.

func (TemplateHashResult) MarshalJSON 

func (t TemplateHashResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TemplateHashResult.

func (*TemplateHashResult) UnmarshalJSON 

func (t *TemplateHashResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TemplateHashResult. 

type TemplateLink struct {
	// If included, must match the ContentVersion in the template.
	ContentVersion *string

	// The resource id of a Template Spec. Use either the id or uri property, but not both.
	ID *string

	// The query string (for example, a SAS token) to be used with the templateLink URI.
	QueryString *string

	// The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template
	// was linked with a TemplateSpec, this will reference an artifact in the
	// TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath
	// URIs
	RelativePath *string

	// The URI of the template to deploy. Use either the uri or id property, but not both.
	URI *string
}

TemplateLink - Entity representing the reference to the template.

func (TemplateLink) MarshalJSON 

func (t TemplateLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TemplateLink.

func (*TemplateLink) UnmarshalJSON 

func (t *TemplateLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TemplateLink.

type ValidationLevel 

type ValidationLevel string

ValidationLevel - The level of validation performed on the deployment. 

const (
	// ValidationLevelProvider - Static analysis of the template is performed and resource declarations are sent to resource providers
	// for semantic validation. Validates that the caller has RBAC write permissions on each resource.
	ValidationLevelProvider ValidationLevel = "Provider"
	// ValidationLevelProviderNoRbac - Static analysis of the template is performed and resource declarations are sent to resource
	// providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource.
	ValidationLevelProviderNoRbac ValidationLevel = "ProviderNoRbac"
	// ValidationLevelTemplate - Static analysis of the template is performed.
	ValidationLevelTemplate ValidationLevel = "Template"
)

func PossibleValidationLevelValues 

func PossibleValidationLevelValues() []ValidationLevel

PossibleValidationLevelValues returns the possible values for the ValidationLevel const type.

type WhatIfChange 

type WhatIfChange struct {
	// REQUIRED; Type of change that will be made to the resource when the deployment is executed.
	ChangeType *ChangeType

	// REQUIRED; Resource ID
	ResourceID *string

	// The predicted snapshot of the resource after the deployment is executed.
	After any

	// The snapshot of the resource before the deployment is executed.
	Before any

	// The predicted changes to resource properties.
	Delta []*WhatIfPropertyChange

	// The resource id of the Deployment responsible for this change.
	DeploymentID *string

	// A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure
	// resource has.
	Identifiers any

	// The symbolic name of the resource responsible for this change.
	SymbolicName *string

	// The explanation about why the resource is unsupported by What-If.
	UnsupportedReason *string
}

WhatIfChange - Information about a single resource change predicted by What-If operation.

func (WhatIfChange) MarshalJSON 

func (w WhatIfChange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WhatIfChange.

func (*WhatIfChange) UnmarshalJSON 

func (w *WhatIfChange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WhatIfChange.

type WhatIfOperationProperties 

type WhatIfOperationProperties struct {
	// List of resource changes predicted by What-If operation.
	Changes []*WhatIfChange

	// List of resource changes predicted by What-If operation.
	PotentialChanges []*WhatIfChange

	// READ-ONLY; List of resource diagnostics detected by What-If operation.
	Diagnostics []*DeploymentDiagnosticsDefinition
}

WhatIfOperationProperties - Deployment operation properties.

func (WhatIfOperationProperties) MarshalJSON 

func (w WhatIfOperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WhatIfOperationProperties.

func (*WhatIfOperationProperties) UnmarshalJSON 

func (w *WhatIfOperationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WhatIfOperationProperties.

type WhatIfOperationResult 

type WhatIfOperationResult struct {
	// Error when What-If operation fails.
	Error *ErrorResponse

	// What-If operation properties.
	Properties *WhatIfOperationProperties

	// Status of the What-If operation.
	Status *string
}

WhatIfOperationResult - Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.

func (WhatIfOperationResult) MarshalJSON 

func (w WhatIfOperationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WhatIfOperationResult.

func (*WhatIfOperationResult) UnmarshalJSON 

func (w *WhatIfOperationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WhatIfOperationResult.

type WhatIfPropertyChange 

type WhatIfPropertyChange struct {
	// REQUIRED; The path of the property.
	Path *string

	// REQUIRED; The type of property change.
	PropertyChangeType *PropertyChangeType

	// The value of the property after the deployment is executed.
	After any

	// The value of the property before the deployment is executed.
	Before any

	// Nested property changes.
	Children []*WhatIfPropertyChange
}

WhatIfPropertyChange - The predicted change to the resource property.

func (WhatIfPropertyChange) MarshalJSON 

func (w WhatIfPropertyChange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WhatIfPropertyChange.

func (*WhatIfPropertyChange) UnmarshalJSON 

func (w *WhatIfPropertyChange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WhatIfPropertyChange.

type WhatIfResultFormat 

type WhatIfResultFormat string

WhatIfResultFormat - The format of the What-If results 

const (
	WhatIfResultFormatFullResourcePayloads WhatIfResultFormat = "FullResourcePayloads"
	WhatIfResultFormatResourceIDOnly       WhatIfResultFormat = "ResourceIdOnly"
)

func PossibleWhatIfResultFormatValues 

func PossibleWhatIfResultFormatValues() []WhatIfResultFormat

PossibleWhatIfResultFormatValues returns the possible values for the WhatIfResultFormat const type.

type ZoneMapping 

type ZoneMapping struct {
	// The location of the zone mapping.
	Location *string
	Zones    []*string
}

func (ZoneMapping) MarshalJSON 

func (z ZoneMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ZoneMapping.

func (*ZoneMapping) UnmarshalJSON 

func (z *ZoneMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ZoneMapping.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.