armresources

package module
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Jan 13, 2022 License: MIT Imports: 15 Imported by: 192

README

Azure Resources Module for Go

PkgGoDev

The armresources module provides operations for working with Azure Resources.

Source code

Getting started

Prerequisites

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

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.

Clients

Azure Resources modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armresources.NewResourcesClient(<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{
    Host: arm.AzureChina,
}
client := armresources.NewResourcesClient(<subscription ID>, cred, &options)

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 `json:"apiVersion,omitempty" azure:"ro"`

	// READ-ONLY; The profile version.
	ProfileVersion *string `json:"profileVersion,omitempty" azure:"ro"`
}

type Alias 

type Alias struct {
	// The default path for an alias.
	DefaultPath *string `json:"defaultPath,omitempty"`

	// The default pattern for an alias.
	DefaultPattern *AliasPattern `json:"defaultPattern,omitempty"`

	// The alias name.
	Name *string `json:"name,omitempty"`

	// The paths for an alias.
	Paths []*AliasPath `json:"paths,omitempty"`

	// The type of the alias.
	Type *AliasType `json:"type,omitempty"`

	// READ-ONLY; The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata
	DefaultMetadata *AliasPathMetadata `json:"defaultMetadata,omitempty" azure:"ro"`
}

Alias - The alias type.

func (Alias) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Alias.

type AliasPath 

type AliasPath struct {
	// The API versions.
	APIVersions []*string `json:"apiVersions,omitempty"`

	// The path of an alias.
	Path *string `json:"path,omitempty"`

	// The pattern for an alias path.
	Pattern *AliasPattern `json:"pattern,omitempty"`

	// READ-ONLY; The metadata of the alias path. If missing, fall back to the default metadata of the alias.
	Metadata *AliasPathMetadata `json:"metadata,omitempty" azure:"ro"`
}

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.

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.

func (AliasPathAttributes) ToPtr 

func (c AliasPathAttributes) ToPtr() *AliasPathAttributes

ToPtr returns a *AliasPathAttributes pointing to the current value.

type AliasPathMetadata 

type AliasPathMetadata struct {
	// READ-ONLY; The attributes of the token that the alias path is referring to.
	Attributes *AliasPathAttributes `json:"attributes,omitempty" azure:"ro"`

	// READ-ONLY; The type of the token that the alias path is referring to.
	Type *AliasPathTokenType `json:"type,omitempty" azure:"ro"`
}

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.

func (AliasPathTokenType) ToPtr 

func (c AliasPathTokenType) ToPtr() *AliasPathTokenType

ToPtr returns a *AliasPathTokenType pointing to the current value.

type AliasPattern 

type AliasPattern struct {
	// The alias pattern phrase.
	Phrase *string `json:"phrase,omitempty"`

	// The type of alias pattern
	Type *AliasPatternType `json:"type,omitempty"`

	// The alias pattern variable.
	Variable *string `json:"variable,omitempty"`
}

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

type AliasPatternType 

type AliasPatternType string

AliasPatternType - The type of alias pattern 

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

func PossibleAliasPatternTypeValues 

func PossibleAliasPatternTypeValues() []AliasPatternType

PossibleAliasPatternTypeValues returns the possible values for the AliasPatternType const type.

func (AliasPatternType) ToPtr 

func (c AliasPatternType) ToPtr() *AliasPatternType

ToPtr returns a *AliasPatternType pointing to the current value.

type AliasType 

type AliasType string

AliasType - The type of the alias. 

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

func PossibleAliasTypeValues 

func PossibleAliasTypeValues() []AliasType

PossibleAliasTypeValues returns the possible values for the AliasType const type.

func (AliasType) ToPtr 

func (c AliasType) ToPtr() *AliasType

ToPtr returns a *AliasType pointing to the current value.

type BasicDependency 

type BasicDependency struct {
	// The ID of the dependency.
	ID *string `json:"id,omitempty"`

	// The dependency resource name.
	ResourceName *string `json:"resourceName,omitempty"`

	// The dependency resource type.
	ResourceType *string `json:"resourceType,omitempty"`
}

BasicDependency - Deployment dependency information.

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"
	// 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"
	// 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"
	// 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"
	// 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"
	// 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.

func (ChangeType) ToPtr 

func (c ChangeType) ToPtr() *ChangeType

ToPtr returns a *ChangeType pointing to the current value.

type Client added in v0.3.0 

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 added in v0.3.0 

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

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 added in v0.3.0 

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

BeginCreateOrUpdate - Creates a resource. If the operation fails it returns an *azcore.ResponseError type. 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 added in v0.3.0 

func (client *Client) BeginCreateOrUpdateByID(ctx context.Context, resourceID string, apiVersion string, parameters GenericResource, options *ClientBeginCreateOrUpdateByIDOptions) (ClientCreateOrUpdateByIDPollerResponse, error)

BeginCreateOrUpdateByID - Create a resource by ID. If the operation fails it returns an *azcore.ResponseError type. 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 added in v0.3.0 

func (client *Client) BeginDelete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, options *ClientBeginDeleteOptions) (ClientDeletePollerResponse, error)

BeginDelete - Deletes a resource. If the operation fails it returns an *azcore.ResponseError type. 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 added in v0.3.0 

func (client *Client) BeginDeleteByID(ctx context.Context, resourceID string, apiVersion string, options *ClientBeginDeleteByIDOptions) (ClientDeleteByIDPollerResponse, error)

BeginDeleteByID - Deletes a resource by ID. If the operation fails it returns an *azcore.ResponseError type. 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 added in v0.3.0 

func (client *Client) BeginMoveResources(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo, options *ClientBeginMoveResourcesOptions) (ClientMoveResourcesPollerResponse, 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. 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 added in v0.3.0 

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

BeginUpdate - Updates a resource. If the operation fails it returns an *azcore.ResponseError type. 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 added in v0.3.0 

func (client *Client) BeginUpdateByID(ctx context.Context, resourceID string, apiVersion string, parameters GenericResource, options *ClientBeginUpdateByIDOptions) (ClientUpdateByIDPollerResponse, error)

BeginUpdateByID - Updates a resource by ID. If the operation fails it returns an *azcore.ResponseError type. 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 added in v0.3.0 

func (client *Client) BeginValidateMoveResources(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo, options *ClientBeginValidateMoveResourcesOptions) (ClientValidateMoveResourcesPollerResponse, 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. 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 added in v0.3.0 

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. 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 added in v0.3.0 

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

CheckExistenceByID - Checks by ID whether a resource exists. 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 added in v0.3.0 

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. 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 added in v0.3.0 

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. 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) List added in v0.3.0 

func (client *Client) List(options *ClientListOptions) *ClientListPager

List - Get all the resources in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ClientListOptions contains the optional parameters for the Client.List method.

func (*Client) ListByResourceGroup added in v0.3.0 

func (client *Client) ListByResourceGroup(resourceGroupName string, options *ClientListByResourceGroupOptions) *ClientListByResourceGroupPager

ListByResourceGroup - Get all the resources for a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group with the resources to get. options - ClientListByResourceGroupOptions contains the optional parameters for the Client.ListByResourceGroup method.

type ClientBeginCreateOrUpdateByIDOptions added in v0.3.0 

type ClientBeginCreateOrUpdateByIDOptions struct {
}

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

type ClientBeginCreateOrUpdateOptions added in v0.3.0 

type ClientBeginCreateOrUpdateOptions struct {
}

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

type ClientBeginDeleteByIDOptions added in v0.3.0 

type ClientBeginDeleteByIDOptions struct {
}

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

type ClientBeginDeleteOptions added in v0.3.0 

type ClientBeginDeleteOptions struct {
}

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

type ClientBeginMoveResourcesOptions added in v0.3.0 

type ClientBeginMoveResourcesOptions struct {
}

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

type ClientBeginUpdateByIDOptions added in v0.3.0 

type ClientBeginUpdateByIDOptions struct {
}

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

type ClientBeginUpdateOptions added in v0.3.0 

type ClientBeginUpdateOptions struct {
}

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

type ClientBeginValidateMoveResourcesOptions added in v0.3.0 

type ClientBeginValidateMoveResourcesOptions struct {
}

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

type ClientCheckExistenceByIDOptions added in v0.3.0 

type ClientCheckExistenceByIDOptions struct {
}

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

type ClientCheckExistenceByIDResponse added in v0.3.0 

type ClientCheckExistenceByIDResponse struct {
	ClientCheckExistenceByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientCheckExistenceByIDResponse contains the response from method Client.CheckExistenceByID.

type ClientCheckExistenceByIDResult added in v0.3.0 

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

ClientCheckExistenceByIDResult contains the result from method Client.CheckExistenceByID.

type ClientCheckExistenceOptions added in v0.3.0 

type ClientCheckExistenceOptions struct {
}

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

type ClientCheckExistenceResponse added in v0.3.0 

type ClientCheckExistenceResponse struct {
	ClientCheckExistenceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientCheckExistenceResponse contains the response from method Client.CheckExistence.

type ClientCheckExistenceResult added in v0.3.0 

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

ClientCheckExistenceResult contains the result from method Client.CheckExistence.

type ClientCreateOrUpdateByIDPoller added in v0.3.0 

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

ClientCreateOrUpdateByIDPoller provides polling facilities until the operation reaches a terminal state.

func (*ClientCreateOrUpdateByIDPoller) Done added in v0.3.0 

func (p *ClientCreateOrUpdateByIDPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientCreateOrUpdateByIDPoller) FinalResponse added in v0.3.0 

func (p *ClientCreateOrUpdateByIDPoller) FinalResponse(ctx context.Context) (ClientCreateOrUpdateByIDResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientCreateOrUpdateByIDResponse will be returned.

func (*ClientCreateOrUpdateByIDPoller) Poll added in v0.3.0 

func (p *ClientCreateOrUpdateByIDPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientCreateOrUpdateByIDPoller) ResumeToken added in v0.3.0 

func (p *ClientCreateOrUpdateByIDPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientCreateOrUpdateByIDPollerResponse added in v0.3.0 

type ClientCreateOrUpdateByIDPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientCreateOrUpdateByIDPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientCreateOrUpdateByIDPollerResponse contains the response from method Client.CreateOrUpdateByID.

func (ClientCreateOrUpdateByIDPollerResponse) PollUntilDone added in v0.3.0 

func (l ClientCreateOrUpdateByIDPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientCreateOrUpdateByIDResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientCreateOrUpdateByIDPollerResponse) Resume added in v0.3.0 

func (l *ClientCreateOrUpdateByIDPollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientCreateOrUpdateByIDPollerResponse from the provided client and resume token.

type ClientCreateOrUpdateByIDResponse added in v0.3.0 

type ClientCreateOrUpdateByIDResponse struct {
	ClientCreateOrUpdateByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientCreateOrUpdateByIDResponse contains the response from method Client.CreateOrUpdateByID.

type ClientCreateOrUpdateByIDResult added in v0.3.0 

type ClientCreateOrUpdateByIDResult struct {
	GenericResource
}

ClientCreateOrUpdateByIDResult contains the result from method Client.CreateOrUpdateByID.

type ClientCreateOrUpdatePoller added in v0.3.0 

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

ClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientCreateOrUpdateResponse will be returned.

func (*ClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientCreateOrUpdatePollerResponse added in v0.3.0 

type ClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientCreateOrUpdatePollerResponse contains the response from method Client.CreateOrUpdate.

func (ClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ClientCreateOrUpdateResponse added in v0.3.0 

type ClientCreateOrUpdateResponse struct {
	ClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientCreateOrUpdateResponse contains the response from method Client.CreateOrUpdate.

type ClientCreateOrUpdateResult added in v0.3.0 

type ClientCreateOrUpdateResult struct {
	GenericResource
}

ClientCreateOrUpdateResult contains the result from method Client.CreateOrUpdate.

type ClientDeleteByIDPoller added in v0.3.0 

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

ClientDeleteByIDPoller provides polling facilities until the operation reaches a terminal state.

func (*ClientDeleteByIDPoller) Done added in v0.3.0 

func (p *ClientDeleteByIDPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientDeleteByIDPoller) FinalResponse added in v0.3.0 

func (p *ClientDeleteByIDPoller) FinalResponse(ctx context.Context) (ClientDeleteByIDResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientDeleteByIDResponse will be returned.

func (*ClientDeleteByIDPoller) Poll added in v0.3.0 

func (p *ClientDeleteByIDPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientDeleteByIDPoller) ResumeToken added in v0.3.0 

func (p *ClientDeleteByIDPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientDeleteByIDPollerResponse added in v0.3.0 

type ClientDeleteByIDPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientDeleteByIDPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientDeleteByIDPollerResponse contains the response from method Client.DeleteByID.

func (ClientDeleteByIDPollerResponse) PollUntilDone added in v0.3.0 

func (l ClientDeleteByIDPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientDeleteByIDResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientDeleteByIDPollerResponse) Resume added in v0.3.0 

func (l *ClientDeleteByIDPollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientDeleteByIDPollerResponse from the provided client and resume token.

type ClientDeleteByIDResponse added in v0.3.0 

type ClientDeleteByIDResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientDeleteByIDResponse contains the response from method Client.DeleteByID.

type ClientDeletePoller added in v0.3.0 

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

ClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ClientDeletePoller) Done added in v0.3.0 

func (p *ClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ClientDeletePoller) FinalResponse(ctx context.Context) (ClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientDeleteResponse will be returned.

func (*ClientDeletePoller) Poll added in v0.3.0 

func (p *ClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientDeletePollerResponse added in v0.3.0 

type ClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientDeletePollerResponse contains the response from method Client.Delete.

func (ClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ClientDeletePollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientDeletePollerResponse from the provided client and resume token.

type ClientDeleteResponse added in v0.3.0 

type ClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientDeleteResponse contains the response from method Client.Delete.

type ClientGetByIDOptions added in v0.3.0 

type ClientGetByIDOptions struct {
}

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

type ClientGetByIDResponse added in v0.3.0 

type ClientGetByIDResponse struct {
	ClientGetByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientGetByIDResponse contains the response from method Client.GetByID.

type ClientGetByIDResult added in v0.3.0 

type ClientGetByIDResult struct {
	GenericResource
}

ClientGetByIDResult contains the result from method Client.GetByID.

type ClientGetOptions added in v0.3.0 

type ClientGetOptions struct {
}

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

type ClientGetResponse added in v0.3.0 

type ClientGetResponse struct {
	ClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientGetResponse contains the response from method Client.Get.

type ClientGetResult added in v0.3.0 

type ClientGetResult struct {
	GenericResource
}

ClientGetResult contains the result from method Client.Get.

type ClientListByResourceGroupOptions added in v0.3.0 

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.ListByResourceGroup method.

type ClientListByResourceGroupPager added in v0.3.0 

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

ClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ClientListByResourceGroupPager) Err added in v0.3.0 

func (p *ClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *ClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *ClientListByResourceGroupPager) PageResponse() ClientListByResourceGroupResponse

PageResponse returns the current ClientListByResourceGroupResponse page.

type ClientListByResourceGroupResponse added in v0.3.0 

type ClientListByResourceGroupResponse struct {
	ClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientListByResourceGroupResponse contains the response from method Client.ListByResourceGroup.

type ClientListByResourceGroupResult added in v0.3.0 

type ClientListByResourceGroupResult struct {
	ResourceListResult
}

ClientListByResourceGroupResult contains the result from method Client.ListByResourceGroup.

type ClientListOptions added in v0.3.0 

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 results to return. If null is passed, returns all resources.
	Top *int32
}

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

type ClientListPager added in v0.3.0 

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

ClientListPager provides operations for iterating over paged responses.

func (*ClientListPager) Err added in v0.3.0 

func (p *ClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ClientListPager) NextPage added in v0.3.0 

func (p *ClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ClientListPager) PageResponse added in v0.3.0 

func (p *ClientListPager) PageResponse() ClientListResponse

PageResponse returns the current ClientListResponse page.

type ClientListResponse added in v0.3.0 

type ClientListResponse struct {
	ClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientListResponse contains the response from method Client.List.

type ClientListResult added in v0.3.0 

type ClientListResult struct {
	ResourceListResult
}

ClientListResult contains the result from method Client.List.

type ClientMoveResourcesPoller added in v0.3.0 

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

ClientMoveResourcesPoller provides polling facilities until the operation reaches a terminal state.

func (*ClientMoveResourcesPoller) Done added in v0.3.0 

func (p *ClientMoveResourcesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientMoveResourcesPoller) FinalResponse added in v0.3.0 

func (p *ClientMoveResourcesPoller) FinalResponse(ctx context.Context) (ClientMoveResourcesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientMoveResourcesResponse will be returned.

func (*ClientMoveResourcesPoller) Poll added in v0.3.0 

func (p *ClientMoveResourcesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientMoveResourcesPoller) ResumeToken added in v0.3.0 

func (p *ClientMoveResourcesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientMoveResourcesPollerResponse added in v0.3.0 

type ClientMoveResourcesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientMoveResourcesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientMoveResourcesPollerResponse contains the response from method Client.MoveResources.

func (ClientMoveResourcesPollerResponse) PollUntilDone added in v0.3.0 

func (l ClientMoveResourcesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientMoveResourcesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientMoveResourcesPollerResponse) Resume added in v0.3.0 

func (l *ClientMoveResourcesPollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientMoveResourcesPollerResponse from the provided client and resume token.

type ClientMoveResourcesResponse added in v0.3.0 

type ClientMoveResourcesResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientMoveResourcesResponse contains the response from method Client.MoveResources.

type ClientUpdateByIDPoller added in v0.3.0 

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

ClientUpdateByIDPoller provides polling facilities until the operation reaches a terminal state.

func (*ClientUpdateByIDPoller) Done added in v0.3.0 

func (p *ClientUpdateByIDPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientUpdateByIDPoller) FinalResponse added in v0.3.0 

func (p *ClientUpdateByIDPoller) FinalResponse(ctx context.Context) (ClientUpdateByIDResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientUpdateByIDResponse will be returned.

func (*ClientUpdateByIDPoller) Poll added in v0.3.0 

func (p *ClientUpdateByIDPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientUpdateByIDPoller) ResumeToken added in v0.3.0 

func (p *ClientUpdateByIDPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientUpdateByIDPollerResponse added in v0.3.0 

type ClientUpdateByIDPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientUpdateByIDPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientUpdateByIDPollerResponse contains the response from method Client.UpdateByID.

func (ClientUpdateByIDPollerResponse) PollUntilDone added in v0.3.0 

func (l ClientUpdateByIDPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientUpdateByIDResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientUpdateByIDPollerResponse) Resume added in v0.3.0 

func (l *ClientUpdateByIDPollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientUpdateByIDPollerResponse from the provided client and resume token.

type ClientUpdateByIDResponse added in v0.3.0 

type ClientUpdateByIDResponse struct {
	ClientUpdateByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientUpdateByIDResponse contains the response from method Client.UpdateByID.

type ClientUpdateByIDResult added in v0.3.0 

type ClientUpdateByIDResult struct {
	GenericResource
}

ClientUpdateByIDResult contains the result from method Client.UpdateByID.

type ClientUpdatePoller added in v0.3.0 

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

ClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ClientUpdatePoller) Done added in v0.3.0 

func (p *ClientUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientUpdatePoller) FinalResponse added in v0.3.0 

func (p *ClientUpdatePoller) FinalResponse(ctx context.Context) (ClientUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientUpdateResponse will be returned.

func (*ClientUpdatePoller) Poll added in v0.3.0 

func (p *ClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientUpdatePoller) ResumeToken added in v0.3.0 

func (p *ClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientUpdatePollerResponse added in v0.3.0 

type ClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientUpdatePollerResponse contains the response from method Client.Update.

func (ClientUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientUpdatePollerResponse) Resume added in v0.3.0 

func (l *ClientUpdatePollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientUpdatePollerResponse from the provided client and resume token.

type ClientUpdateResponse added in v0.3.0 

type ClientUpdateResponse struct {
	ClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientUpdateResponse contains the response from method Client.Update.

type ClientUpdateResult added in v0.3.0 

type ClientUpdateResult struct {
	GenericResource
}

ClientUpdateResult contains the result from method Client.Update.

type ClientValidateMoveResourcesPoller added in v0.3.0 

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

ClientValidateMoveResourcesPoller provides polling facilities until the operation reaches a terminal state.

func (*ClientValidateMoveResourcesPoller) Done added in v0.3.0 

func (p *ClientValidateMoveResourcesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ClientValidateMoveResourcesPoller) FinalResponse added in v0.3.0 

func (p *ClientValidateMoveResourcesPoller) FinalResponse(ctx context.Context) (ClientValidateMoveResourcesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ClientValidateMoveResourcesResponse will be returned.

func (*ClientValidateMoveResourcesPoller) Poll added in v0.3.0 

func (p *ClientValidateMoveResourcesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ClientValidateMoveResourcesPoller) ResumeToken added in v0.3.0 

func (p *ClientValidateMoveResourcesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ClientValidateMoveResourcesPollerResponse added in v0.3.0 

type ClientValidateMoveResourcesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientValidateMoveResourcesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientValidateMoveResourcesPollerResponse contains the response from method Client.ValidateMoveResources.

func (ClientValidateMoveResourcesPollerResponse) PollUntilDone added in v0.3.0 

func (l ClientValidateMoveResourcesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientValidateMoveResourcesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientValidateMoveResourcesPollerResponse) Resume added in v0.3.0 

func (l *ClientValidateMoveResourcesPollerResponse) Resume(ctx context.Context, client *Client, token string) error

Resume rehydrates a ClientValidateMoveResourcesPollerResponse from the provided client and resume token.

type ClientValidateMoveResourcesResponse added in v0.3.0 

type ClientValidateMoveResourcesResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClientValidateMoveResourcesResponse contains the response from method Client.ValidateMoveResources.

type CloudError 

type CloudError struct {
	// Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows
	// the OData error response format.)
	Error *ErrorResponse `json:"error,omitempty"`
}

CloudError - An error response for a resource management request.

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 `json:"detailLevel,omitempty"`
}

DebugSetting - The debug setting.

type Dependency 

type Dependency struct {
	// The list of dependencies.
	DependsOn []*BasicDependency `json:"dependsOn,omitempty"`

	// The ID of the dependency.
	ID *string `json:"id,omitempty"`

	// The dependency resource name.
	ResourceName *string `json:"resourceName,omitempty"`

	// The dependency resource type.
	ResourceType *string `json:"resourceType,omitempty"`
}

Dependency - Deployment dependency information.

func (Dependency) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Dependency.

type Deployment 

type Deployment struct {
	// REQUIRED; The deployment properties.
	Properties *DeploymentProperties `json:"properties,omitempty"`

	// The location to store the deployment data.
	Location *string `json:"location,omitempty"`

	// Deployment tags
	Tags map[string]*string `json:"tags,omitempty"`
}

Deployment operation parameters.

func (Deployment) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Deployment.

type DeploymentExportResult 

type DeploymentExportResult struct {
	// The template content.
	Template map[string]interface{} `json:"template,omitempty"`
}

DeploymentExportResult - The deployment export result.

type DeploymentExtended 

type DeploymentExtended struct {
	// the location of the deployment.
	Location *string `json:"location,omitempty"`

	// Deployment properties.
	Properties *DeploymentPropertiesExtended `json:"properties,omitempty"`

	// Deployment tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The ID of the deployment.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the deployment.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the deployment.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DeploymentExtended - Deployment information.

func (DeploymentExtended) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentExtended.

type DeploymentExtendedFilter 

type DeploymentExtendedFilter struct {
	// The provisioning state.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

DeploymentExtendedFilter - Deployment filter.

type DeploymentListResult 

type DeploymentListResult struct {
	// An array of deployments.
	Value []*DeploymentExtended `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DeploymentListResult - List of deployments.

func (DeploymentListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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 (
	DeploymentModeIncremental DeploymentMode = "Incremental"
	DeploymentModeComplete    DeploymentMode = "Complete"
)

func PossibleDeploymentModeValues 

func PossibleDeploymentModeValues() []DeploymentMode

PossibleDeploymentModeValues returns the possible values for the DeploymentMode const type.

func (DeploymentMode) ToPtr 

func (c DeploymentMode) ToPtr() *DeploymentMode

ToPtr returns a *DeploymentMode pointing to the current value.

type DeploymentOperation 

type DeploymentOperation struct {
	// Deployment properties.
	Properties *DeploymentOperationProperties `json:"properties,omitempty"`

	// READ-ONLY; Full deployment operation ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Deployment operation ID.
	OperationID *string `json:"operationId,omitempty" azure:"ro"`
}

DeploymentOperation - Deployment operation information.

type DeploymentOperationProperties 

type DeploymentOperationProperties struct {
	// READ-ONLY; The duration of the operation.
	Duration *string `json:"duration,omitempty" azure:"ro"`

	// READ-ONLY; The name of the current provisioning operation.
	ProvisioningOperation *ProvisioningOperation `json:"provisioningOperation,omitempty" azure:"ro"`

	// READ-ONLY; The state of the provisioning.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The HTTP request message.
	Request *HTTPMessage `json:"request,omitempty" azure:"ro"`

	// READ-ONLY; The HTTP response message.
	Response *HTTPMessage `json:"response,omitempty" azure:"ro"`

	// READ-ONLY; Deployment operation service request id.
	ServiceRequestID *string `json:"serviceRequestId,omitempty" azure:"ro"`

	// 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 `json:"statusCode,omitempty" azure:"ro"`

	// 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 `json:"statusMessage,omitempty" azure:"ro"`

	// READ-ONLY; The target resource.
	TargetResource *TargetResource `json:"targetResource,omitempty" azure:"ro"`

	// READ-ONLY; The date and time of the operation.
	Timestamp *time.Time `json:"timestamp,omitempty" azure:"ro"`
}

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

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. 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. 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. 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. 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. 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) List 

func (client *DeploymentOperationsClient) List(resourceGroupName string, deploymentName string, options *DeploymentOperationsClientListOptions) *DeploymentOperationsClientListPager

List - Gets all deployments operations for a deployment. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

func (*DeploymentOperationsClient) ListAtManagementGroupScope 

func (client *DeploymentOperationsClient) ListAtManagementGroupScope(groupID string, deploymentName string, options *DeploymentOperationsClientListAtManagementGroupScopeOptions) *DeploymentOperationsClientListAtManagementGroupScopePager

ListAtManagementGroupScope - Gets all deployments operations for a deployment. If the operation fails it returns an *azcore.ResponseError type. groupID - The management group ID. deploymentName - The name of the deployment. options - DeploymentOperationsClientListAtManagementGroupScopeOptions contains the optional parameters for the DeploymentOperationsClient.ListAtManagementGroupScope method.

func (*DeploymentOperationsClient) ListAtScope 

func (client *DeploymentOperationsClient) ListAtScope(scope string, deploymentName string, options *DeploymentOperationsClientListAtScopeOptions) *DeploymentOperationsClientListAtScopePager

ListAtScope - Gets all deployments operations for a deployment. If the operation fails it returns an *azcore.ResponseError type. scope - The resource scope. deploymentName - The name of the deployment. options - DeploymentOperationsClientListAtScopeOptions contains the optional parameters for the DeploymentOperationsClient.ListAtScope method.

func (*DeploymentOperationsClient) ListAtSubscriptionScope 

func (client *DeploymentOperationsClient) ListAtSubscriptionScope(deploymentName string, options *DeploymentOperationsClientListAtSubscriptionScopeOptions) *DeploymentOperationsClientListAtSubscriptionScopePager

ListAtSubscriptionScope - Gets all deployments operations for a deployment. If the operation fails it returns an *azcore.ResponseError type. deploymentName - The name of the deployment. options - DeploymentOperationsClientListAtSubscriptionScopeOptions contains the optional parameters for the DeploymentOperationsClient.ListAtSubscriptionScope method.

func (*DeploymentOperationsClient) ListAtTenantScope 

func (client *DeploymentOperationsClient) ListAtTenantScope(deploymentName string, options *DeploymentOperationsClientListAtTenantScopeOptions) *DeploymentOperationsClientListAtTenantScopePager

ListAtTenantScope - Gets all deployments operations for a deployment. If the operation fails it returns an *azcore.ResponseError type. deploymentName - The name of the deployment. options - DeploymentOperationsClientListAtTenantScopeOptions contains the optional parameters for the DeploymentOperationsClient.ListAtTenantScope method.

type DeploymentOperationsClientGetAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentOperationsClientGetAtManagementGroupScopeOptions struct {
}

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

type DeploymentOperationsClientGetAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentOperationsClientGetAtManagementGroupScopeResponse struct {
	DeploymentOperationsClientGetAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientGetAtManagementGroupScopeResponse contains the response from method DeploymentOperationsClient.GetAtManagementGroupScope.

type DeploymentOperationsClientGetAtManagementGroupScopeResult added in v0.3.0 

type DeploymentOperationsClientGetAtManagementGroupScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsClientGetAtManagementGroupScopeResult contains the result from method DeploymentOperationsClient.GetAtManagementGroupScope.

type DeploymentOperationsClientGetAtScopeOptions added in v0.3.0 

type DeploymentOperationsClientGetAtScopeOptions struct {
}

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

type DeploymentOperationsClientGetAtScopeResponse added in v0.3.0 

type DeploymentOperationsClientGetAtScopeResponse struct {
	DeploymentOperationsClientGetAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientGetAtScopeResponse contains the response from method DeploymentOperationsClient.GetAtScope.

type DeploymentOperationsClientGetAtScopeResult added in v0.3.0 

type DeploymentOperationsClientGetAtScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsClientGetAtScopeResult contains the result from method DeploymentOperationsClient.GetAtScope.

type DeploymentOperationsClientGetAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentOperationsClientGetAtSubscriptionScopeOptions struct {
}

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

type DeploymentOperationsClientGetAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentOperationsClientGetAtSubscriptionScopeResponse struct {
	DeploymentOperationsClientGetAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientGetAtSubscriptionScopeResponse contains the response from method DeploymentOperationsClient.GetAtSubscriptionScope.

type DeploymentOperationsClientGetAtSubscriptionScopeResult added in v0.3.0 

type DeploymentOperationsClientGetAtSubscriptionScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsClientGetAtSubscriptionScopeResult contains the result from method DeploymentOperationsClient.GetAtSubscriptionScope.

type DeploymentOperationsClientGetAtTenantScopeOptions added in v0.3.0 

type DeploymentOperationsClientGetAtTenantScopeOptions struct {
}

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

type DeploymentOperationsClientGetAtTenantScopeResponse added in v0.3.0 

type DeploymentOperationsClientGetAtTenantScopeResponse struct {
	DeploymentOperationsClientGetAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientGetAtTenantScopeResponse contains the response from method DeploymentOperationsClient.GetAtTenantScope.

type DeploymentOperationsClientGetAtTenantScopeResult added in v0.3.0 

type DeploymentOperationsClientGetAtTenantScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsClientGetAtTenantScopeResult contains the result from method DeploymentOperationsClient.GetAtTenantScope.

type DeploymentOperationsClientGetOptions added in v0.3.0 

type DeploymentOperationsClientGetOptions struct {
}

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

type DeploymentOperationsClientGetResponse added in v0.3.0 

type DeploymentOperationsClientGetResponse struct {
	DeploymentOperationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientGetResponse contains the response from method DeploymentOperationsClient.Get.

type DeploymentOperationsClientGetResult added in v0.3.0 

type DeploymentOperationsClientGetResult struct {
	DeploymentOperation
}

DeploymentOperationsClientGetResult contains the result from method DeploymentOperationsClient.Get.

type DeploymentOperationsClientListAtManagementGroupScopeOptions added in v0.3.0 

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

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

type DeploymentOperationsClientListAtManagementGroupScopePager added in v0.3.0 

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

DeploymentOperationsClientListAtManagementGroupScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsClientListAtManagementGroupScopePager) Err added in v0.3.0 

func (p *DeploymentOperationsClientListAtManagementGroupScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentOperationsClientListAtManagementGroupScopePager) NextPage added in v0.3.0 

func (p *DeploymentOperationsClientListAtManagementGroupScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentOperationsClientListAtManagementGroupScopePager) PageResponse added in v0.3.0 

func (p *DeploymentOperationsClientListAtManagementGroupScopePager) PageResponse() DeploymentOperationsClientListAtManagementGroupScopeResponse

PageResponse returns the current DeploymentOperationsClientListAtManagementGroupScopeResponse page.

type DeploymentOperationsClientListAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentOperationsClientListAtManagementGroupScopeResponse struct {
	DeploymentOperationsClientListAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientListAtManagementGroupScopeResponse contains the response from method DeploymentOperationsClient.ListAtManagementGroupScope.

type DeploymentOperationsClientListAtManagementGroupScopeResult added in v0.3.0 

type DeploymentOperationsClientListAtManagementGroupScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtManagementGroupScopeResult contains the result from method DeploymentOperationsClient.ListAtManagementGroupScope.

type DeploymentOperationsClientListAtScopeOptions added in v0.3.0 

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

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

type DeploymentOperationsClientListAtScopePager added in v0.3.0 

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

DeploymentOperationsClientListAtScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsClientListAtScopePager) Err added in v0.3.0 

func (p *DeploymentOperationsClientListAtScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentOperationsClientListAtScopePager) NextPage added in v0.3.0 

func (p *DeploymentOperationsClientListAtScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentOperationsClientListAtScopePager) PageResponse added in v0.3.0 

func (p *DeploymentOperationsClientListAtScopePager) PageResponse() DeploymentOperationsClientListAtScopeResponse

PageResponse returns the current DeploymentOperationsClientListAtScopeResponse page.

type DeploymentOperationsClientListAtScopeResponse added in v0.3.0 

type DeploymentOperationsClientListAtScopeResponse struct {
	DeploymentOperationsClientListAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientListAtScopeResponse contains the response from method DeploymentOperationsClient.ListAtScope.

type DeploymentOperationsClientListAtScopeResult added in v0.3.0 

type DeploymentOperationsClientListAtScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtScopeResult contains the result from method DeploymentOperationsClient.ListAtScope.

type DeploymentOperationsClientListAtSubscriptionScopeOptions added in v0.3.0 

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

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

type DeploymentOperationsClientListAtSubscriptionScopePager added in v0.3.0 

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

DeploymentOperationsClientListAtSubscriptionScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsClientListAtSubscriptionScopePager) Err added in v0.3.0 

func (p *DeploymentOperationsClientListAtSubscriptionScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentOperationsClientListAtSubscriptionScopePager) NextPage added in v0.3.0 

func (p *DeploymentOperationsClientListAtSubscriptionScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentOperationsClientListAtSubscriptionScopePager) PageResponse added in v0.3.0 

func (p *DeploymentOperationsClientListAtSubscriptionScopePager) PageResponse() DeploymentOperationsClientListAtSubscriptionScopeResponse

PageResponse returns the current DeploymentOperationsClientListAtSubscriptionScopeResponse page.

type DeploymentOperationsClientListAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentOperationsClientListAtSubscriptionScopeResponse struct {
	DeploymentOperationsClientListAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientListAtSubscriptionScopeResponse contains the response from method DeploymentOperationsClient.ListAtSubscriptionScope.

type DeploymentOperationsClientListAtSubscriptionScopeResult added in v0.3.0 

type DeploymentOperationsClientListAtSubscriptionScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtSubscriptionScopeResult contains the result from method DeploymentOperationsClient.ListAtSubscriptionScope.

type DeploymentOperationsClientListAtTenantScopeOptions added in v0.3.0 

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

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

type DeploymentOperationsClientListAtTenantScopePager added in v0.3.0 

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

DeploymentOperationsClientListAtTenantScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsClientListAtTenantScopePager) Err added in v0.3.0 

func (p *DeploymentOperationsClientListAtTenantScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentOperationsClientListAtTenantScopePager) NextPage added in v0.3.0 

func (p *DeploymentOperationsClientListAtTenantScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentOperationsClientListAtTenantScopePager) PageResponse added in v0.3.0 

func (p *DeploymentOperationsClientListAtTenantScopePager) PageResponse() DeploymentOperationsClientListAtTenantScopeResponse

PageResponse returns the current DeploymentOperationsClientListAtTenantScopeResponse page.

type DeploymentOperationsClientListAtTenantScopeResponse added in v0.3.0 

type DeploymentOperationsClientListAtTenantScopeResponse struct {
	DeploymentOperationsClientListAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientListAtTenantScopeResponse contains the response from method DeploymentOperationsClient.ListAtTenantScope.

type DeploymentOperationsClientListAtTenantScopeResult added in v0.3.0 

type DeploymentOperationsClientListAtTenantScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsClientListAtTenantScopeResult contains the result from method DeploymentOperationsClient.ListAtTenantScope.

type DeploymentOperationsClientListOptions added in v0.3.0 

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

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

type DeploymentOperationsClientListPager added in v0.3.0 

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

DeploymentOperationsClientListPager provides operations for iterating over paged responses.

func (*DeploymentOperationsClientListPager) Err added in v0.3.0 

func (p *DeploymentOperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentOperationsClientListPager) NextPage added in v0.3.0 

func (p *DeploymentOperationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentOperationsClientListPager) PageResponse added in v0.3.0 

func (p *DeploymentOperationsClientListPager) PageResponse() DeploymentOperationsClientListResponse

PageResponse returns the current DeploymentOperationsClientListResponse page.

type DeploymentOperationsClientListResponse added in v0.3.0 

type DeploymentOperationsClientListResponse struct {
	DeploymentOperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentOperationsClientListResponse contains the response from method DeploymentOperationsClient.List.

type DeploymentOperationsClientListResult added in v0.3.0 

type DeploymentOperationsClientListResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsClientListResult contains the result from method DeploymentOperationsClient.List.

type DeploymentOperationsListResult 

type DeploymentOperationsListResult struct {
	// An array of deployment operations.
	Value []*DeploymentOperation `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DeploymentOperationsListResult - List of deployment operations.

func (DeploymentOperationsListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentOperationsListResult.

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 `json:"mode,omitempty"`

	// The debug setting of the deployment.
	DebugSetting *DebugSetting `json:"debugSetting,omitempty"`

	// 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 `json:"expressionEvaluationOptions,omitempty"`

	// The deployment on error behavior.
	OnErrorDeployment *OnErrorDeployment `json:"onErrorDeployment,omitempty"`

	// 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]interface{} `json:"parameters,omitempty"`

	// 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 `json:"parametersLink,omitempty"`

	// 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 map[string]interface{} `json:"template,omitempty"`

	// The URI of the template. Use either the templateLink property or the template property, but not both.
	TemplateLink *TemplateLink `json:"templateLink,omitempty"`
}

DeploymentProperties - Deployment properties.

type DeploymentPropertiesExtended 

type DeploymentPropertiesExtended struct {
	// READ-ONLY; The correlation ID of the deployment.
	CorrelationID *string `json:"correlationId,omitempty" azure:"ro"`

	// READ-ONLY; The debug setting of the deployment.
	DebugSetting *DebugSetting `json:"debugSetting,omitempty" azure:"ro"`

	// READ-ONLY; The list of deployment dependencies.
	Dependencies []*Dependency `json:"dependencies,omitempty" azure:"ro"`

	// READ-ONLY; The duration of the template deployment.
	Duration *string `json:"duration,omitempty" azure:"ro"`

	// READ-ONLY; The deployment error.
	Error *ErrorResponse `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; The deployment mode. Possible values are Incremental and Complete.
	Mode *DeploymentMode `json:"mode,omitempty" azure:"ro"`

	// READ-ONLY; The deployment on error behavior.
	OnErrorDeployment *OnErrorDeploymentExtended `json:"onErrorDeployment,omitempty" azure:"ro"`

	// READ-ONLY; Array of provisioned resources.
	OutputResources []*ResourceReference `json:"outputResources,omitempty" azure:"ro"`

	// READ-ONLY; Key/value pairs that represent deployment output.
	Outputs map[string]interface{} `json:"outputs,omitempty" azure:"ro"`

	// READ-ONLY; Deployment parameters.
	Parameters map[string]interface{} `json:"parameters,omitempty" azure:"ro"`

	// READ-ONLY; The URI referencing the parameters.
	ParametersLink *ParametersLink `json:"parametersLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of resource providers needed for the deployment.
	Providers []*Provider `json:"providers,omitempty" azure:"ro"`

	// READ-ONLY; Denotes the state of provisioning.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The hash produced for the template.
	TemplateHash *string `json:"templateHash,omitempty" azure:"ro"`

	// READ-ONLY; The URI referencing the template.
	TemplateLink *TemplateLink `json:"templateLink,omitempty" azure:"ro"`

	// READ-ONLY; The timestamp of the template deployment.
	Timestamp *time.Time `json:"timestamp,omitempty" azure:"ro"`

	// READ-ONLY; Array of validated resources.
	ValidatedResources []*ResourceReference `json:"validatedResources,omitempty" azure:"ro"`
}

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 `json:"properties,omitempty"`

	// READ-ONLY; The deployment validation error.
	Error *ErrorResponse `json:"error,omitempty" azure:"ro"`
}

DeploymentValidateResult - Information from validate template deployment response.

type DeploymentWhatIf 

type DeploymentWhatIf struct {
	// REQUIRED; The deployment properties.
	Properties *DeploymentWhatIfProperties `json:"properties,omitempty"`

	// The location to store the deployment data.
	Location *string `json:"location,omitempty"`
}

DeploymentWhatIf - Deployment What-if operation parameters.

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 `json:"mode,omitempty"`

	// The debug setting of the deployment.
	DebugSetting *DebugSetting `json:"debugSetting,omitempty"`

	// 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 `json:"expressionEvaluationOptions,omitempty"`

	// The deployment on error behavior.
	OnErrorDeployment *OnErrorDeployment `json:"onErrorDeployment,omitempty"`

	// 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]interface{} `json:"parameters,omitempty"`

	// 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 `json:"parametersLink,omitempty"`

	// 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 map[string]interface{} `json:"template,omitempty"`

	// The URI of the template. Use either the templateLink property or the template property, but not both.
	TemplateLink *TemplateLink `json:"templateLink,omitempty"`

	// Optional What-If operation settings.
	WhatIfSettings *DeploymentWhatIfSettings `json:"whatIfSettings,omitempty"`
}

DeploymentWhatIfProperties - Deployment What-if properties.

type DeploymentWhatIfSettings 

type DeploymentWhatIfSettings struct {
	// The format of the What-If results
	ResultFormat *WhatIfResultFormat `json:"resultFormat,omitempty"`
}

DeploymentWhatIfSettings - Deployment What-If operation settings.

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

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) (DeploymentsClientCreateOrUpdatePollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentResourceGroup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<deployment-name>",
		armresources.Deployment{
			Properties: &armresources.DeploymentProperties{
				Mode:       armresources.DeploymentModeIncremental.ToPtr(),
				Parameters: map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{
					QueryString: to.StringPtr("<query-string>"),
					URI:         to.StringPtr("<uri>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientCreateOrUpdateResult)
}

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtManagementGroupScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions) (DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentAtManagementGroup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdateAtManagementGroupScope(ctx,
		"<group-id>",
		"<deployment-name>",
		armresources.ScopedDeployment{
			Location: to.StringPtr("<location>"),
			Properties: &armresources.DeploymentProperties{
				Mode:       armresources.DeploymentModeIncremental.ToPtr(),
				Parameters: map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{
					URI: to.StringPtr("<uri>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientCreateOrUpdateAtManagementGroupScopeResult)
}

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtScope(ctx context.Context, scope string, deploymentName string, parameters Deployment, options *DeploymentsClientBeginCreateOrUpdateAtScopeOptions) (DeploymentsClientCreateOrUpdateAtScopePollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentAtScope.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdateAtScope(ctx,
		"<scope>",
		"<deployment-name>",
		armresources.Deployment{
			Location: to.StringPtr("<location>"),
			Properties: &armresources.DeploymentProperties{
				Mode:       armresources.DeploymentModeIncremental.ToPtr(),
				Parameters: map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{
					URI: to.StringPtr("<uri>"),
				},
			},
			Tags: map[string]*string{
				"tagKey1": to.StringPtr("tag-value-1"),
				"tagKey2": to.StringPtr("tag-value-2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientCreateOrUpdateAtScopeResult)
}

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtSubscriptionScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtSubscriptionScope(ctx context.Context, deploymentName string, parameters Deployment, options *DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions) (DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdateAtSubscriptionScope(ctx,
		"<deployment-name>",
		armresources.Deployment{
			Location: to.StringPtr("<location>"),
			Properties: &armresources.DeploymentProperties{
				Mode:       armresources.DeploymentModeIncremental.ToPtr(),
				Parameters: map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientCreateOrUpdateAtSubscriptionScopeResult)
}

Output:

func (*DeploymentsClient) BeginCreateOrUpdateAtTenantScope 

func (client *DeploymentsClient) BeginCreateOrUpdateAtTenantScope(ctx context.Context, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions) (DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentAtTenant.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdateAtTenantScope(ctx,
		"<deployment-name>",
		armresources.ScopedDeployment{
			Location: to.StringPtr("<location>"),
			Properties: &armresources.DeploymentProperties{
				Mode:       armresources.DeploymentModeIncremental.ToPtr(),
				Parameters: map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{
					URI: to.StringPtr("<uri>"),
				},
			},
			Tags: map[string]*string{
				"tagKey1": to.StringPtr("tag-value-1"),
				"tagKey2": to.StringPtr("tag-value-2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientCreateOrUpdateAtTenantScopeResult)
}

Output:

func (*DeploymentsClient) BeginDelete 

func (client *DeploymentsClient) BeginDelete(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsClientBeginDeleteOptions) (DeploymentsClientDeletePollerResponse, 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. 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) (DeploymentsClientDeleteAtManagementGroupScopePollerResponse, 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. 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) (DeploymentsClientDeleteAtScopePollerResponse, 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. 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) (DeploymentsClientDeleteAtSubscriptionScopePollerResponse, 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. 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) (DeploymentsClientDeleteAtTenantScopePollerResponse, 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. 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) (DeploymentsClientValidatePollerResponse, 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. 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.

func (*DeploymentsClient) BeginValidateAtManagementGroupScope 

func (client *DeploymentsClient) BeginValidateAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginValidateAtManagementGroupScopeOptions) (DeploymentsClientValidateAtManagementGroupScopePollerResponse, 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. 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.

func (*DeploymentsClient) BeginValidateAtScope 

func (client *DeploymentsClient) BeginValidateAtScope(ctx context.Context, scope string, deploymentName string, parameters Deployment, options *DeploymentsClientBeginValidateAtScopeOptions) (DeploymentsClientValidateAtScopePollerResponse, 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. 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.

func (*DeploymentsClient) BeginValidateAtSubscriptionScope 

func (client *DeploymentsClient) BeginValidateAtSubscriptionScope(ctx context.Context, deploymentName string, parameters Deployment, options *DeploymentsClientBeginValidateAtSubscriptionScopeOptions) (DeploymentsClientValidateAtSubscriptionScopePollerResponse, 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. deploymentName - The name of the deployment. parameters - Parameters to validate. options - DeploymentsClientBeginValidateAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtSubscriptionScope method.

func (*DeploymentsClient) BeginValidateAtTenantScope 

func (client *DeploymentsClient) BeginValidateAtTenantScope(ctx context.Context, deploymentName string, parameters ScopedDeployment, options *DeploymentsClientBeginValidateAtTenantScopeOptions) (DeploymentsClientValidateAtTenantScopePollerResponse, 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. deploymentName - The name of the deployment. parameters - Parameters to validate. options - DeploymentsClientBeginValidateAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginValidateAtTenantScope method.

func (*DeploymentsClient) BeginWhatIf 

func (client *DeploymentsClient) BeginWhatIf(ctx context.Context, resourceGroupName string, deploymentName string, parameters DeploymentWhatIf, options *DeploymentsClientBeginWhatIfOptions) (DeploymentsClientWhatIfPollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnResourceGroup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginWhatIf(ctx,
		"<resource-group-name>",
		"<deployment-name>",
		armresources.DeploymentWhatIf{
			Properties: &armresources.DeploymentWhatIfProperties{
				Mode:         armresources.DeploymentModeIncremental.ToPtr(),
				Parameters:   map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientWhatIfResult)
}

Output:

func (*DeploymentsClient) BeginWhatIfAtManagementGroupScope 

func (client *DeploymentsClient) BeginWhatIfAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, parameters ScopedDeploymentWhatIf, options *DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions) (DeploymentsClientWhatIfAtManagementGroupScopePollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnManagementGroup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginWhatIfAtManagementGroupScope(ctx,
		"<group-id>",
		"<deployment-name>",
		armresources.ScopedDeploymentWhatIf{
			Location: to.StringPtr("<location>"),
			Properties: &armresources.DeploymentWhatIfProperties{
				Mode:         armresources.DeploymentModeIncremental.ToPtr(),
				Parameters:   map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientWhatIfAtManagementGroupScopeResult)
}

Output:

func (*DeploymentsClient) BeginWhatIfAtSubscriptionScope 

func (client *DeploymentsClient) BeginWhatIfAtSubscriptionScope(ctx context.Context, deploymentName string, parameters DeploymentWhatIf, options *DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions) (DeploymentsClientWhatIfAtSubscriptionScopePollerResponse, 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. deploymentName - The name of the deployment. parameters - Parameters to What If. options - DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtSubscriptionScope method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnSubscription.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginWhatIfAtSubscriptionScope(ctx,
		"<deployment-name>",
		armresources.DeploymentWhatIf{
			Location: to.StringPtr("<location>"),
			Properties: &armresources.DeploymentWhatIfProperties{
				Mode:         armresources.DeploymentModeIncremental.ToPtr(),
				Parameters:   map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientWhatIfAtSubscriptionScopeResult)
}

Output:

func (*DeploymentsClient) BeginWhatIfAtTenantScope 

func (client *DeploymentsClient) BeginWhatIfAtTenantScope(ctx context.Context, deploymentName string, parameters ScopedDeploymentWhatIf, options *DeploymentsClientBeginWhatIfAtTenantScopeOptions) (DeploymentsClientWhatIfAtTenantScopePollerResponse, 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. deploymentName - The name of the deployment. parameters - Parameters to validate. options - DeploymentsClientBeginWhatIfAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.BeginWhatIfAtTenantScope method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnTenant.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginWhatIfAtTenantScope(ctx,
		"<deployment-name>",
		armresources.ScopedDeploymentWhatIf{
			Location: to.StringPtr("<location>"),
			Properties: &armresources.DeploymentWhatIfProperties{
				Mode:         armresources.DeploymentModeIncremental.ToPtr(),
				Parameters:   map[string]interface{}{},
				TemplateLink: &armresources.TemplateLink{},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientWhatIfAtTenantScopeResult)
}

Output:

func (*DeploymentsClient) CalculateTemplateHash 

func (client *DeploymentsClient) CalculateTemplateHash(ctx context.Context, templateParam map[string]interface{}, options *DeploymentsClientCalculateTemplateHashOptions) (DeploymentsClientCalculateTemplateHashResponse, error)

CalculateTemplateHash - Calculate the hash of the given template. If the operation fails it returns an *azcore.ResponseError type. templateParam - The template provided to calculate hash. options - DeploymentsClientCalculateTemplateHashOptions contains the optional parameters for the DeploymentsClient.CalculateTemplateHash method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/CalculateTemplateHash.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewDeploymentsClient("<subscription-id>", cred, nil)
	res, err := client.CalculateTemplateHash(ctx,
		map[string]interface{}{
			"$schema":        "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview",
			"contentVersion": "1.0.0.0",
			"outputs": map[string]interface{}{
				"string": map[string]interface{}{
					"type":  "string",
					"value": "myvalue",
				},
			},
			"parameters": map[string]interface{}{
				"string": map[string]interface{}{
					"type": "string",
				},
			},
			"resources": []interface{}{},
			"variables": map[string]interface{}{
				"array": []interface{}{
					float64(1),
					float64(2),
					float64(3),
					float64(4),
				},
				"bool": true,
				"int":  float64(42),
				"object": map[string]interface{}{
					"object": map[string]interface{}{
						"location": "West US",
						"vmSize":   "Large",
					},
				},
				"string": "string",
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DeploymentsClientCalculateTemplateHashResult)
}

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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. deploymentName - The name of the deployment. options - DeploymentsClientGetAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.GetAtTenantScope method.

func (*DeploymentsClient) ListAtManagementGroupScope 

func (client *DeploymentsClient) ListAtManagementGroupScope(groupID string, options *DeploymentsClientListAtManagementGroupScopeOptions) *DeploymentsClientListAtManagementGroupScopePager

ListAtManagementGroupScope - Get all the deployments for a management group. If the operation fails it returns an *azcore.ResponseError type. groupID - The management group ID. options - DeploymentsClientListAtManagementGroupScopeOptions contains the optional parameters for the DeploymentsClient.ListAtManagementGroupScope method.

func (*DeploymentsClient) ListAtScope 

func (client *DeploymentsClient) ListAtScope(scope string, options *DeploymentsClientListAtScopeOptions) *DeploymentsClientListAtScopePager

ListAtScope - Get all the deployments at the given scope. If the operation fails it returns an *azcore.ResponseError type. scope - The resource scope. options - DeploymentsClientListAtScopeOptions contains the optional parameters for the DeploymentsClient.ListAtScope method.

func (*DeploymentsClient) ListAtSubscriptionScope 

func (client *DeploymentsClient) ListAtSubscriptionScope(options *DeploymentsClientListAtSubscriptionScopeOptions) *DeploymentsClientListAtSubscriptionScopePager

ListAtSubscriptionScope - Get all the deployments for a subscription. If the operation fails it returns an *azcore.ResponseError type. options - DeploymentsClientListAtSubscriptionScopeOptions contains the optional parameters for the DeploymentsClient.ListAtSubscriptionScope method.

func (*DeploymentsClient) ListAtTenantScope 

func (client *DeploymentsClient) ListAtTenantScope(options *DeploymentsClientListAtTenantScopeOptions) *DeploymentsClientListAtTenantScopePager

ListAtTenantScope - Get all the deployments at the tenant scope. If the operation fails it returns an *azcore.ResponseError type. options - DeploymentsClientListAtTenantScopeOptions contains the optional parameters for the DeploymentsClient.ListAtTenantScope method.

func (*DeploymentsClient) ListByResourceGroup 

func (client *DeploymentsClient) ListByResourceGroup(resourceGroupName string, options *DeploymentsClientListByResourceGroupOptions) *DeploymentsClientListByResourceGroupPager

ListByResourceGroup - Get all the deployments for a resource group. If the operation fails it returns an *azcore.ResponseError type. 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.ListByResourceGroup method.

type DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientBeginCreateOrUpdateAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientBeginCreateOrUpdateAtScopeOptions added in v0.3.0 

type DeploymentsClientBeginCreateOrUpdateAtScopeOptions struct {
}

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

type DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientBeginCreateOrUpdateAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientBeginCreateOrUpdateAtTenantScopeOptions struct {
}

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

type DeploymentsClientBeginCreateOrUpdateOptions added in v0.3.0 

type DeploymentsClientBeginCreateOrUpdateOptions struct {
}

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

type DeploymentsClientBeginDeleteAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientBeginDeleteAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientBeginDeleteAtScopeOptions added in v0.3.0 

type DeploymentsClientBeginDeleteAtScopeOptions struct {
}

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

type DeploymentsClientBeginDeleteAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientBeginDeleteAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientBeginDeleteAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientBeginDeleteAtTenantScopeOptions struct {
}

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

type DeploymentsClientBeginDeleteOptions added in v0.3.0 

type DeploymentsClientBeginDeleteOptions struct {
}

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

type DeploymentsClientBeginValidateAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientBeginValidateAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientBeginValidateAtScopeOptions added in v0.3.0 

type DeploymentsClientBeginValidateAtScopeOptions struct {
}

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

type DeploymentsClientBeginValidateAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientBeginValidateAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientBeginValidateAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientBeginValidateAtTenantScopeOptions struct {
}

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

type DeploymentsClientBeginValidateOptions added in v0.3.0 

type DeploymentsClientBeginValidateOptions struct {
}

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

type DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientBeginWhatIfAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientBeginWhatIfAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientBeginWhatIfAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientBeginWhatIfAtTenantScopeOptions struct {
}

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

type DeploymentsClientBeginWhatIfOptions added in v0.3.0 

type DeploymentsClientBeginWhatIfOptions struct {
}

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

type DeploymentsClientCalculateTemplateHashOptions added in v0.3.0 

type DeploymentsClientCalculateTemplateHashOptions struct {
}

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

type DeploymentsClientCalculateTemplateHashResponse added in v0.3.0 

type DeploymentsClientCalculateTemplateHashResponse struct {
	DeploymentsClientCalculateTemplateHashResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCalculateTemplateHashResponse contains the response from method DeploymentsClient.CalculateTemplateHash.

type DeploymentsClientCalculateTemplateHashResult added in v0.3.0 

type DeploymentsClientCalculateTemplateHashResult struct {
	TemplateHashResult
}

DeploymentsClientCalculateTemplateHashResult contains the result from method DeploymentsClient.CalculateTemplateHash.

type DeploymentsClientCancelAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientCancelAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientCancelAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientCancelAtManagementGroupScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCancelAtManagementGroupScopeResponse contains the response from method DeploymentsClient.CancelAtManagementGroupScope.

type DeploymentsClientCancelAtScopeOptions added in v0.3.0 

type DeploymentsClientCancelAtScopeOptions struct {
}

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

type DeploymentsClientCancelAtScopeResponse added in v0.3.0 

type DeploymentsClientCancelAtScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCancelAtScopeResponse contains the response from method DeploymentsClient.CancelAtScope.

type DeploymentsClientCancelAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientCancelAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientCancelAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientCancelAtSubscriptionScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCancelAtSubscriptionScopeResponse contains the response from method DeploymentsClient.CancelAtSubscriptionScope.

type DeploymentsClientCancelAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientCancelAtTenantScopeOptions struct {
}

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

type DeploymentsClientCancelAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientCancelAtTenantScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCancelAtTenantScopeResponse contains the response from method DeploymentsClient.CancelAtTenantScope.

type DeploymentsClientCancelOptions added in v0.3.0 

type DeploymentsClientCancelOptions struct {
}

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

type DeploymentsClientCancelResponse added in v0.3.0 

type DeploymentsClientCancelResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCancelResponse contains the response from method DeploymentsClient.Cancel.

type DeploymentsClientCheckExistenceAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientCheckExistenceAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientCheckExistenceAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientCheckExistenceAtManagementGroupScopeResponse struct {
	DeploymentsClientCheckExistenceAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCheckExistenceAtManagementGroupScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtManagementGroupScope.

type DeploymentsClientCheckExistenceAtManagementGroupScopeResult added in v0.3.0 

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

DeploymentsClientCheckExistenceAtManagementGroupScopeResult contains the result from method DeploymentsClient.CheckExistenceAtManagementGroupScope.

type DeploymentsClientCheckExistenceAtScopeOptions added in v0.3.0 

type DeploymentsClientCheckExistenceAtScopeOptions struct {
}

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

type DeploymentsClientCheckExistenceAtScopeResponse added in v0.3.0 

type DeploymentsClientCheckExistenceAtScopeResponse struct {
	DeploymentsClientCheckExistenceAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCheckExistenceAtScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtScope.

type DeploymentsClientCheckExistenceAtScopeResult added in v0.3.0 

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

DeploymentsClientCheckExistenceAtScopeResult contains the result from method DeploymentsClient.CheckExistenceAtScope.

type DeploymentsClientCheckExistenceAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientCheckExistenceAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientCheckExistenceAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientCheckExistenceAtSubscriptionScopeResponse struct {
	DeploymentsClientCheckExistenceAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCheckExistenceAtSubscriptionScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtSubscriptionScope.

type DeploymentsClientCheckExistenceAtSubscriptionScopeResult added in v0.3.0 

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

DeploymentsClientCheckExistenceAtSubscriptionScopeResult contains the result from method DeploymentsClient.CheckExistenceAtSubscriptionScope.

type DeploymentsClientCheckExistenceAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientCheckExistenceAtTenantScopeOptions struct {
}

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

type DeploymentsClientCheckExistenceAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientCheckExistenceAtTenantScopeResponse struct {
	DeploymentsClientCheckExistenceAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCheckExistenceAtTenantScopeResponse contains the response from method DeploymentsClient.CheckExistenceAtTenantScope.

type DeploymentsClientCheckExistenceAtTenantScopeResult added in v0.3.0 

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

DeploymentsClientCheckExistenceAtTenantScopeResult contains the result from method DeploymentsClient.CheckExistenceAtTenantScope.

type DeploymentsClientCheckExistenceOptions added in v0.3.0 

type DeploymentsClientCheckExistenceOptions struct {
}

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

type DeploymentsClientCheckExistenceResponse added in v0.3.0 

type DeploymentsClientCheckExistenceResponse struct {
	DeploymentsClientCheckExistenceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCheckExistenceResponse contains the response from method DeploymentsClient.CheckExistence.

type DeploymentsClientCheckExistenceResult added in v0.3.0 

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

DeploymentsClientCheckExistenceResult contains the result from method DeploymentsClient.CheckExistence.

type DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller added in v0.3.0 

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

DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse will be returned.

func (*DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientCreateOrUpdateAtManagementGroupScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse contains the response from method DeploymentsClient.CreateOrUpdateAtManagementGroupScope.

func (DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientCreateOrUpdateAtManagementGroupScopePollerResponse from the provided client and resume token.

type DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse struct {
	DeploymentsClientCreateOrUpdateAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtManagementGroupScopeResponse contains the response from method DeploymentsClient.CreateOrUpdateAtManagementGroupScope.

type DeploymentsClientCreateOrUpdateAtManagementGroupScopeResult added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtManagementGroupScopeResult struct {
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtManagementGroupScopeResult contains the result from method DeploymentsClient.CreateOrUpdateAtManagementGroupScope.

type DeploymentsClientCreateOrUpdateAtScopePoller added in v0.3.0 

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

DeploymentsClientCreateOrUpdateAtScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientCreateOrUpdateAtScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientCreateOrUpdateAtScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientCreateOrUpdateAtScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientCreateOrUpdateAtScopeResponse will be returned.

func (*DeploymentsClientCreateOrUpdateAtScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientCreateOrUpdateAtScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientCreateOrUpdateAtScopePollerResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientCreateOrUpdateAtScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtScopePollerResponse contains the response from method DeploymentsClient.CreateOrUpdateAtScope.

func (DeploymentsClientCreateOrUpdateAtScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientCreateOrUpdateAtScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientCreateOrUpdateAtScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientCreateOrUpdateAtScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientCreateOrUpdateAtScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientCreateOrUpdateAtScopePollerResponse from the provided client and resume token.

type DeploymentsClientCreateOrUpdateAtScopeResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtScopeResponse struct {
	DeploymentsClientCreateOrUpdateAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtScopeResponse contains the response from method DeploymentsClient.CreateOrUpdateAtScope.

type DeploymentsClientCreateOrUpdateAtScopeResult added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtScopeResult struct {
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtScopeResult contains the result from method DeploymentsClient.CreateOrUpdateAtScope.

type DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller added in v0.3.0 

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

DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse will be returned.

func (*DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientCreateOrUpdateAtSubscriptionScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse contains the response from method DeploymentsClient.CreateOrUpdateAtSubscriptionScope.

func (DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientCreateOrUpdateAtSubscriptionScopePollerResponse from the provided client and resume token.

type DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse struct {
	DeploymentsClientCreateOrUpdateAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtSubscriptionScopeResponse contains the response from method DeploymentsClient.CreateOrUpdateAtSubscriptionScope.

type DeploymentsClientCreateOrUpdateAtSubscriptionScopeResult added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtSubscriptionScopeResult struct {
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtSubscriptionScopeResult contains the result from method DeploymentsClient.CreateOrUpdateAtSubscriptionScope.

type DeploymentsClientCreateOrUpdateAtTenantScopePoller added in v0.3.0 

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

DeploymentsClientCreateOrUpdateAtTenantScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientCreateOrUpdateAtTenantScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtTenantScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientCreateOrUpdateAtTenantScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtTenantScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientCreateOrUpdateAtTenantScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientCreateOrUpdateAtTenantScopeResponse will be returned.

func (*DeploymentsClientCreateOrUpdateAtTenantScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtTenantScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientCreateOrUpdateAtTenantScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdateAtTenantScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientCreateOrUpdateAtTenantScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse contains the response from method DeploymentsClient.CreateOrUpdateAtTenantScope.

func (DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientCreateOrUpdateAtTenantScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientCreateOrUpdateAtTenantScopePollerResponse from the provided client and resume token.

type DeploymentsClientCreateOrUpdateAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtTenantScopeResponse struct {
	DeploymentsClientCreateOrUpdateAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateAtTenantScopeResponse contains the response from method DeploymentsClient.CreateOrUpdateAtTenantScope.

type DeploymentsClientCreateOrUpdateAtTenantScopeResult added in v0.3.0 

type DeploymentsClientCreateOrUpdateAtTenantScopeResult struct {
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateAtTenantScopeResult contains the result from method DeploymentsClient.CreateOrUpdateAtTenantScope.

type DeploymentsClientCreateOrUpdatePoller added in v0.3.0 

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

DeploymentsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (DeploymentsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientCreateOrUpdateResponse will be returned.

func (*DeploymentsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientCreateOrUpdatePollerResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdatePollerResponse contains the response from method DeploymentsClient.CreateOrUpdate.

func (DeploymentsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type DeploymentsClientCreateOrUpdateResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateResponse struct {
	DeploymentsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientCreateOrUpdateResponse contains the response from method DeploymentsClient.CreateOrUpdate.

type DeploymentsClientCreateOrUpdateResult added in v0.3.0 

type DeploymentsClientCreateOrUpdateResult struct {
	DeploymentExtended
}

DeploymentsClientCreateOrUpdateResult contains the result from method DeploymentsClient.CreateOrUpdate.

type DeploymentsClientDeleteAtManagementGroupScopePoller added in v0.3.0 

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

DeploymentsClientDeleteAtManagementGroupScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientDeleteAtManagementGroupScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientDeleteAtManagementGroupScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientDeleteAtManagementGroupScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientDeleteAtManagementGroupScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientDeleteAtManagementGroupScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientDeleteAtManagementGroupScopeResponse will be returned.

func (*DeploymentsClientDeleteAtManagementGroupScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientDeleteAtManagementGroupScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientDeleteAtManagementGroupScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientDeleteAtManagementGroupScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientDeleteAtManagementGroupScopePollerResponse added in v0.3.0 

type DeploymentsClientDeleteAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientDeleteAtManagementGroupScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtManagementGroupScopePollerResponse contains the response from method DeploymentsClient.DeleteAtManagementGroupScope.

func (DeploymentsClientDeleteAtManagementGroupScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientDeleteAtManagementGroupScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientDeleteAtManagementGroupScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientDeleteAtManagementGroupScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientDeleteAtManagementGroupScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientDeleteAtManagementGroupScopePollerResponse from the provided client and resume token.

type DeploymentsClientDeleteAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientDeleteAtManagementGroupScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtManagementGroupScopeResponse contains the response from method DeploymentsClient.DeleteAtManagementGroupScope.

type DeploymentsClientDeleteAtScopePoller added in v0.3.0 

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

DeploymentsClientDeleteAtScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientDeleteAtScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientDeleteAtScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientDeleteAtScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientDeleteAtScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientDeleteAtScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientDeleteAtScopeResponse will be returned.

func (*DeploymentsClientDeleteAtScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientDeleteAtScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientDeleteAtScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientDeleteAtScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientDeleteAtScopePollerResponse added in v0.3.0 

type DeploymentsClientDeleteAtScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientDeleteAtScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtScopePollerResponse contains the response from method DeploymentsClient.DeleteAtScope.

func (DeploymentsClientDeleteAtScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientDeleteAtScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientDeleteAtScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientDeleteAtScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientDeleteAtScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientDeleteAtScopePollerResponse from the provided client and resume token.

type DeploymentsClientDeleteAtScopeResponse added in v0.3.0 

type DeploymentsClientDeleteAtScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtScopeResponse contains the response from method DeploymentsClient.DeleteAtScope.

type DeploymentsClientDeleteAtSubscriptionScopePoller added in v0.3.0 

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

DeploymentsClientDeleteAtSubscriptionScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientDeleteAtSubscriptionScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientDeleteAtSubscriptionScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientDeleteAtSubscriptionScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientDeleteAtSubscriptionScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientDeleteAtSubscriptionScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientDeleteAtSubscriptionScopeResponse will be returned.

func (*DeploymentsClientDeleteAtSubscriptionScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientDeleteAtSubscriptionScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientDeleteAtSubscriptionScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientDeleteAtSubscriptionScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientDeleteAtSubscriptionScopePollerResponse added in v0.3.0 

type DeploymentsClientDeleteAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientDeleteAtSubscriptionScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtSubscriptionScopePollerResponse contains the response from method DeploymentsClient.DeleteAtSubscriptionScope.

func (DeploymentsClientDeleteAtSubscriptionScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientDeleteAtSubscriptionScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientDeleteAtSubscriptionScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientDeleteAtSubscriptionScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientDeleteAtSubscriptionScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientDeleteAtSubscriptionScopePollerResponse from the provided client and resume token.

type DeploymentsClientDeleteAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientDeleteAtSubscriptionScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtSubscriptionScopeResponse contains the response from method DeploymentsClient.DeleteAtSubscriptionScope.

type DeploymentsClientDeleteAtTenantScopePoller added in v0.3.0 

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

DeploymentsClientDeleteAtTenantScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientDeleteAtTenantScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientDeleteAtTenantScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientDeleteAtTenantScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientDeleteAtTenantScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientDeleteAtTenantScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientDeleteAtTenantScopeResponse will be returned.

func (*DeploymentsClientDeleteAtTenantScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientDeleteAtTenantScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientDeleteAtTenantScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientDeleteAtTenantScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientDeleteAtTenantScopePollerResponse added in v0.3.0 

type DeploymentsClientDeleteAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientDeleteAtTenantScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtTenantScopePollerResponse contains the response from method DeploymentsClient.DeleteAtTenantScope.

func (DeploymentsClientDeleteAtTenantScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientDeleteAtTenantScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientDeleteAtTenantScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientDeleteAtTenantScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientDeleteAtTenantScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientDeleteAtTenantScopePollerResponse from the provided client and resume token.

type DeploymentsClientDeleteAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientDeleteAtTenantScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteAtTenantScopeResponse contains the response from method DeploymentsClient.DeleteAtTenantScope.

type DeploymentsClientDeletePoller added in v0.3.0 

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

DeploymentsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientDeletePoller) Done added in v0.3.0 

func (p *DeploymentsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientDeletePoller) FinalResponse(ctx context.Context) (DeploymentsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientDeleteResponse will be returned.

func (*DeploymentsClientDeletePoller) Poll added in v0.3.0 

func (p *DeploymentsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientDeletePollerResponse added in v0.3.0 

type DeploymentsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeletePollerResponse contains the response from method DeploymentsClient.Delete.

func (DeploymentsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientDeletePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientDeletePollerResponse from the provided client and resume token.

type DeploymentsClientDeleteResponse added in v0.3.0 

type DeploymentsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientDeleteResponse contains the response from method DeploymentsClient.Delete.

type DeploymentsClientExportTemplateAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientExportTemplateAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientExportTemplateAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientExportTemplateAtManagementGroupScopeResponse struct {
	DeploymentsClientExportTemplateAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientExportTemplateAtManagementGroupScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtManagementGroupScope.

type DeploymentsClientExportTemplateAtManagementGroupScopeResult added in v0.3.0 

type DeploymentsClientExportTemplateAtManagementGroupScopeResult struct {
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtManagementGroupScopeResult contains the result from method DeploymentsClient.ExportTemplateAtManagementGroupScope.

type DeploymentsClientExportTemplateAtScopeOptions added in v0.3.0 

type DeploymentsClientExportTemplateAtScopeOptions struct {
}

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

type DeploymentsClientExportTemplateAtScopeResponse added in v0.3.0 

type DeploymentsClientExportTemplateAtScopeResponse struct {
	DeploymentsClientExportTemplateAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientExportTemplateAtScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtScope.

type DeploymentsClientExportTemplateAtScopeResult added in v0.3.0 

type DeploymentsClientExportTemplateAtScopeResult struct {
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtScopeResult contains the result from method DeploymentsClient.ExportTemplateAtScope.

type DeploymentsClientExportTemplateAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientExportTemplateAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientExportTemplateAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientExportTemplateAtSubscriptionScopeResponse struct {
	DeploymentsClientExportTemplateAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientExportTemplateAtSubscriptionScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtSubscriptionScope.

type DeploymentsClientExportTemplateAtSubscriptionScopeResult added in v0.3.0 

type DeploymentsClientExportTemplateAtSubscriptionScopeResult struct {
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtSubscriptionScopeResult contains the result from method DeploymentsClient.ExportTemplateAtSubscriptionScope.

type DeploymentsClientExportTemplateAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientExportTemplateAtTenantScopeOptions struct {
}

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

type DeploymentsClientExportTemplateAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientExportTemplateAtTenantScopeResponse struct {
	DeploymentsClientExportTemplateAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientExportTemplateAtTenantScopeResponse contains the response from method DeploymentsClient.ExportTemplateAtTenantScope.

type DeploymentsClientExportTemplateAtTenantScopeResult added in v0.3.0 

type DeploymentsClientExportTemplateAtTenantScopeResult struct {
	DeploymentExportResult
}

DeploymentsClientExportTemplateAtTenantScopeResult contains the result from method DeploymentsClient.ExportTemplateAtTenantScope.

type DeploymentsClientExportTemplateOptions added in v0.3.0 

type DeploymentsClientExportTemplateOptions struct {
}

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

type DeploymentsClientExportTemplateResponse added in v0.3.0 

type DeploymentsClientExportTemplateResponse struct {
	DeploymentsClientExportTemplateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientExportTemplateResponse contains the response from method DeploymentsClient.ExportTemplate.

type DeploymentsClientExportTemplateResult added in v0.3.0 

type DeploymentsClientExportTemplateResult struct {
	DeploymentExportResult
}

DeploymentsClientExportTemplateResult contains the result from method DeploymentsClient.ExportTemplate.

type DeploymentsClientGetAtManagementGroupScopeOptions added in v0.3.0 

type DeploymentsClientGetAtManagementGroupScopeOptions struct {
}

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

type DeploymentsClientGetAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientGetAtManagementGroupScopeResponse struct {
	DeploymentsClientGetAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientGetAtManagementGroupScopeResponse contains the response from method DeploymentsClient.GetAtManagementGroupScope.

type DeploymentsClientGetAtManagementGroupScopeResult added in v0.3.0 

type DeploymentsClientGetAtManagementGroupScopeResult struct {
	DeploymentExtended
}

DeploymentsClientGetAtManagementGroupScopeResult contains the result from method DeploymentsClient.GetAtManagementGroupScope.

type DeploymentsClientGetAtScopeOptions added in v0.3.0 

type DeploymentsClientGetAtScopeOptions struct {
}

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

type DeploymentsClientGetAtScopeResponse added in v0.3.0 

type DeploymentsClientGetAtScopeResponse struct {
	DeploymentsClientGetAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientGetAtScopeResponse contains the response from method DeploymentsClient.GetAtScope.

type DeploymentsClientGetAtScopeResult added in v0.3.0 

type DeploymentsClientGetAtScopeResult struct {
	DeploymentExtended
}

DeploymentsClientGetAtScopeResult contains the result from method DeploymentsClient.GetAtScope.

type DeploymentsClientGetAtSubscriptionScopeOptions added in v0.3.0 

type DeploymentsClientGetAtSubscriptionScopeOptions struct {
}

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

type DeploymentsClientGetAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientGetAtSubscriptionScopeResponse struct {
	DeploymentsClientGetAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientGetAtSubscriptionScopeResponse contains the response from method DeploymentsClient.GetAtSubscriptionScope.

type DeploymentsClientGetAtSubscriptionScopeResult added in v0.3.0 

type DeploymentsClientGetAtSubscriptionScopeResult struct {
	DeploymentExtended
}

DeploymentsClientGetAtSubscriptionScopeResult contains the result from method DeploymentsClient.GetAtSubscriptionScope.

type DeploymentsClientGetAtTenantScopeOptions added in v0.3.0 

type DeploymentsClientGetAtTenantScopeOptions struct {
}

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

type DeploymentsClientGetAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientGetAtTenantScopeResponse struct {
	DeploymentsClientGetAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientGetAtTenantScopeResponse contains the response from method DeploymentsClient.GetAtTenantScope.

type DeploymentsClientGetAtTenantScopeResult added in v0.3.0 

type DeploymentsClientGetAtTenantScopeResult struct {
	DeploymentExtended
}

DeploymentsClientGetAtTenantScopeResult contains the result from method DeploymentsClient.GetAtTenantScope.

type DeploymentsClientGetOptions added in v0.3.0 

type DeploymentsClientGetOptions struct {
}

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

type DeploymentsClientGetResponse added in v0.3.0 

type DeploymentsClientGetResponse struct {
	DeploymentsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientGetResponse contains the response from method DeploymentsClient.Get.

type DeploymentsClientGetResult added in v0.3.0 

type DeploymentsClientGetResult struct {
	DeploymentExtended
}

DeploymentsClientGetResult contains the result from method DeploymentsClient.Get.

type DeploymentsClientListAtManagementGroupScopeOptions added in v0.3.0 

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.ListAtManagementGroupScope method.

type DeploymentsClientListAtManagementGroupScopePager added in v0.3.0 

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

DeploymentsClientListAtManagementGroupScopePager provides operations for iterating over paged responses.

func (*DeploymentsClientListAtManagementGroupScopePager) Err added in v0.3.0 

func (p *DeploymentsClientListAtManagementGroupScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentsClientListAtManagementGroupScopePager) NextPage added in v0.3.0 

func (p *DeploymentsClientListAtManagementGroupScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentsClientListAtManagementGroupScopePager) PageResponse added in v0.3.0 

func (p *DeploymentsClientListAtManagementGroupScopePager) PageResponse() DeploymentsClientListAtManagementGroupScopeResponse

PageResponse returns the current DeploymentsClientListAtManagementGroupScopeResponse page.

type DeploymentsClientListAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientListAtManagementGroupScopeResponse struct {
	DeploymentsClientListAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientListAtManagementGroupScopeResponse contains the response from method DeploymentsClient.ListAtManagementGroupScope.

type DeploymentsClientListAtManagementGroupScopeResult added in v0.3.0 

type DeploymentsClientListAtManagementGroupScopeResult struct {
	DeploymentListResult
}

DeploymentsClientListAtManagementGroupScopeResult contains the result from method DeploymentsClient.ListAtManagementGroupScope.

type DeploymentsClientListAtScopeOptions added in v0.3.0 

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.ListAtScope method.

type DeploymentsClientListAtScopePager added in v0.3.0 

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

DeploymentsClientListAtScopePager provides operations for iterating over paged responses.

func (*DeploymentsClientListAtScopePager) Err added in v0.3.0 

func (p *DeploymentsClientListAtScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentsClientListAtScopePager) NextPage added in v0.3.0 

func (p *DeploymentsClientListAtScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentsClientListAtScopePager) PageResponse added in v0.3.0 

func (p *DeploymentsClientListAtScopePager) PageResponse() DeploymentsClientListAtScopeResponse

PageResponse returns the current DeploymentsClientListAtScopeResponse page.

type DeploymentsClientListAtScopeResponse added in v0.3.0 

type DeploymentsClientListAtScopeResponse struct {
	DeploymentsClientListAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientListAtScopeResponse contains the response from method DeploymentsClient.ListAtScope.

type DeploymentsClientListAtScopeResult added in v0.3.0 

type DeploymentsClientListAtScopeResult struct {
	DeploymentListResult
}

DeploymentsClientListAtScopeResult contains the result from method DeploymentsClient.ListAtScope.

type DeploymentsClientListAtSubscriptionScopeOptions added in v0.3.0 

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.ListAtSubscriptionScope method.

type DeploymentsClientListAtSubscriptionScopePager added in v0.3.0 

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

DeploymentsClientListAtSubscriptionScopePager provides operations for iterating over paged responses.

func (*DeploymentsClientListAtSubscriptionScopePager) Err added in v0.3.0 

func (p *DeploymentsClientListAtSubscriptionScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentsClientListAtSubscriptionScopePager) NextPage added in v0.3.0 

func (p *DeploymentsClientListAtSubscriptionScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentsClientListAtSubscriptionScopePager) PageResponse added in v0.3.0 

func (p *DeploymentsClientListAtSubscriptionScopePager) PageResponse() DeploymentsClientListAtSubscriptionScopeResponse

PageResponse returns the current DeploymentsClientListAtSubscriptionScopeResponse page.

type DeploymentsClientListAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientListAtSubscriptionScopeResponse struct {
	DeploymentsClientListAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientListAtSubscriptionScopeResponse contains the response from method DeploymentsClient.ListAtSubscriptionScope.

type DeploymentsClientListAtSubscriptionScopeResult added in v0.3.0 

type DeploymentsClientListAtSubscriptionScopeResult struct {
	DeploymentListResult
}

DeploymentsClientListAtSubscriptionScopeResult contains the result from method DeploymentsClient.ListAtSubscriptionScope.

type DeploymentsClientListAtTenantScopeOptions added in v0.3.0 

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.ListAtTenantScope method.

type DeploymentsClientListAtTenantScopePager added in v0.3.0 

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

DeploymentsClientListAtTenantScopePager provides operations for iterating over paged responses.

func (*DeploymentsClientListAtTenantScopePager) Err added in v0.3.0 

func (p *DeploymentsClientListAtTenantScopePager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentsClientListAtTenantScopePager) NextPage added in v0.3.0 

func (p *DeploymentsClientListAtTenantScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentsClientListAtTenantScopePager) PageResponse added in v0.3.0 

func (p *DeploymentsClientListAtTenantScopePager) PageResponse() DeploymentsClientListAtTenantScopeResponse

PageResponse returns the current DeploymentsClientListAtTenantScopeResponse page.

type DeploymentsClientListAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientListAtTenantScopeResponse struct {
	DeploymentsClientListAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientListAtTenantScopeResponse contains the response from method DeploymentsClient.ListAtTenantScope.

type DeploymentsClientListAtTenantScopeResult added in v0.3.0 

type DeploymentsClientListAtTenantScopeResult struct {
	DeploymentListResult
}

DeploymentsClientListAtTenantScopeResult contains the result from method DeploymentsClient.ListAtTenantScope.

type DeploymentsClientListByResourceGroupOptions added in v0.3.0 

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.ListByResourceGroup method.

type DeploymentsClientListByResourceGroupPager added in v0.3.0 

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

DeploymentsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*DeploymentsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *DeploymentsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*DeploymentsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *DeploymentsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeploymentsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *DeploymentsClientListByResourceGroupPager) PageResponse() DeploymentsClientListByResourceGroupResponse

PageResponse returns the current DeploymentsClientListByResourceGroupResponse page.

type DeploymentsClientListByResourceGroupResponse added in v0.3.0 

type DeploymentsClientListByResourceGroupResponse struct {
	DeploymentsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientListByResourceGroupResponse contains the response from method DeploymentsClient.ListByResourceGroup.

type DeploymentsClientListByResourceGroupResult added in v0.3.0 

type DeploymentsClientListByResourceGroupResult struct {
	DeploymentListResult
}

DeploymentsClientListByResourceGroupResult contains the result from method DeploymentsClient.ListByResourceGroup.

type DeploymentsClientValidateAtManagementGroupScopePoller added in v0.3.0 

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

DeploymentsClientValidateAtManagementGroupScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientValidateAtManagementGroupScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientValidateAtManagementGroupScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientValidateAtManagementGroupScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientValidateAtManagementGroupScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientValidateAtManagementGroupScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientValidateAtManagementGroupScopeResponse will be returned.

func (*DeploymentsClientValidateAtManagementGroupScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientValidateAtManagementGroupScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientValidateAtManagementGroupScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientValidateAtManagementGroupScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientValidateAtManagementGroupScopePollerResponse added in v0.3.0 

type DeploymentsClientValidateAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientValidateAtManagementGroupScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtManagementGroupScopePollerResponse contains the response from method DeploymentsClient.ValidateAtManagementGroupScope.

func (DeploymentsClientValidateAtManagementGroupScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientValidateAtManagementGroupScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientValidateAtManagementGroupScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientValidateAtManagementGroupScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientValidateAtManagementGroupScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientValidateAtManagementGroupScopePollerResponse from the provided client and resume token.

type DeploymentsClientValidateAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientValidateAtManagementGroupScopeResponse struct {
	DeploymentsClientValidateAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtManagementGroupScopeResponse contains the response from method DeploymentsClient.ValidateAtManagementGroupScope.

type DeploymentsClientValidateAtManagementGroupScopeResult added in v0.3.0 

type DeploymentsClientValidateAtManagementGroupScopeResult struct {
	DeploymentValidateResult
}

DeploymentsClientValidateAtManagementGroupScopeResult contains the result from method DeploymentsClient.ValidateAtManagementGroupScope.

type DeploymentsClientValidateAtScopePoller added in v0.3.0 

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

DeploymentsClientValidateAtScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientValidateAtScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientValidateAtScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientValidateAtScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientValidateAtScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientValidateAtScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientValidateAtScopeResponse will be returned.

func (*DeploymentsClientValidateAtScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientValidateAtScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientValidateAtScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientValidateAtScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientValidateAtScopePollerResponse added in v0.3.0 

type DeploymentsClientValidateAtScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientValidateAtScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtScopePollerResponse contains the response from method DeploymentsClient.ValidateAtScope.

func (DeploymentsClientValidateAtScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientValidateAtScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientValidateAtScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientValidateAtScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientValidateAtScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientValidateAtScopePollerResponse from the provided client and resume token.

type DeploymentsClientValidateAtScopeResponse added in v0.3.0 

type DeploymentsClientValidateAtScopeResponse struct {
	DeploymentsClientValidateAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtScopeResponse contains the response from method DeploymentsClient.ValidateAtScope.

type DeploymentsClientValidateAtScopeResult added in v0.3.0 

type DeploymentsClientValidateAtScopeResult struct {
	DeploymentValidateResult
}

DeploymentsClientValidateAtScopeResult contains the result from method DeploymentsClient.ValidateAtScope.

type DeploymentsClientValidateAtSubscriptionScopePoller added in v0.3.0 

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

DeploymentsClientValidateAtSubscriptionScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientValidateAtSubscriptionScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientValidateAtSubscriptionScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientValidateAtSubscriptionScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientValidateAtSubscriptionScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientValidateAtSubscriptionScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientValidateAtSubscriptionScopeResponse will be returned.

func (*DeploymentsClientValidateAtSubscriptionScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientValidateAtSubscriptionScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientValidateAtSubscriptionScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientValidateAtSubscriptionScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientValidateAtSubscriptionScopePollerResponse added in v0.3.0 

type DeploymentsClientValidateAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientValidateAtSubscriptionScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtSubscriptionScopePollerResponse contains the response from method DeploymentsClient.ValidateAtSubscriptionScope.

func (DeploymentsClientValidateAtSubscriptionScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientValidateAtSubscriptionScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientValidateAtSubscriptionScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientValidateAtSubscriptionScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientValidateAtSubscriptionScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientValidateAtSubscriptionScopePollerResponse from the provided client and resume token.

type DeploymentsClientValidateAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientValidateAtSubscriptionScopeResponse struct {
	DeploymentsClientValidateAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtSubscriptionScopeResponse contains the response from method DeploymentsClient.ValidateAtSubscriptionScope.

type DeploymentsClientValidateAtSubscriptionScopeResult added in v0.3.0 

type DeploymentsClientValidateAtSubscriptionScopeResult struct {
	DeploymentValidateResult
}

DeploymentsClientValidateAtSubscriptionScopeResult contains the result from method DeploymentsClient.ValidateAtSubscriptionScope.

type DeploymentsClientValidateAtTenantScopePoller added in v0.3.0 

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

DeploymentsClientValidateAtTenantScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientValidateAtTenantScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientValidateAtTenantScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientValidateAtTenantScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientValidateAtTenantScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientValidateAtTenantScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientValidateAtTenantScopeResponse will be returned.

func (*DeploymentsClientValidateAtTenantScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientValidateAtTenantScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientValidateAtTenantScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientValidateAtTenantScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientValidateAtTenantScopePollerResponse added in v0.3.0 

type DeploymentsClientValidateAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientValidateAtTenantScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtTenantScopePollerResponse contains the response from method DeploymentsClient.ValidateAtTenantScope.

func (DeploymentsClientValidateAtTenantScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientValidateAtTenantScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientValidateAtTenantScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientValidateAtTenantScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientValidateAtTenantScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientValidateAtTenantScopePollerResponse from the provided client and resume token.

type DeploymentsClientValidateAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientValidateAtTenantScopeResponse struct {
	DeploymentsClientValidateAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateAtTenantScopeResponse contains the response from method DeploymentsClient.ValidateAtTenantScope.

type DeploymentsClientValidateAtTenantScopeResult added in v0.3.0 

type DeploymentsClientValidateAtTenantScopeResult struct {
	DeploymentValidateResult
}

DeploymentsClientValidateAtTenantScopeResult contains the result from method DeploymentsClient.ValidateAtTenantScope.

type DeploymentsClientValidatePoller added in v0.3.0 

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

DeploymentsClientValidatePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientValidatePoller) Done added in v0.3.0 

func (p *DeploymentsClientValidatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientValidatePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientValidatePoller) FinalResponse(ctx context.Context) (DeploymentsClientValidateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientValidateResponse will be returned.

func (*DeploymentsClientValidatePoller) Poll added in v0.3.0 

func (p *DeploymentsClientValidatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientValidatePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientValidatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientValidatePollerResponse added in v0.3.0 

type DeploymentsClientValidatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientValidatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidatePollerResponse contains the response from method DeploymentsClient.Validate.

func (DeploymentsClientValidatePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientValidatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientValidateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientValidatePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientValidatePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientValidatePollerResponse from the provided client and resume token.

type DeploymentsClientValidateResponse added in v0.3.0 

type DeploymentsClientValidateResponse struct {
	DeploymentsClientValidateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientValidateResponse contains the response from method DeploymentsClient.Validate.

type DeploymentsClientValidateResult added in v0.3.0 

type DeploymentsClientValidateResult struct {
	DeploymentValidateResult
}

DeploymentsClientValidateResult contains the result from method DeploymentsClient.Validate.

type DeploymentsClientWhatIfAtManagementGroupScopePoller added in v0.3.0 

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

DeploymentsClientWhatIfAtManagementGroupScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientWhatIfAtManagementGroupScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientWhatIfAtManagementGroupScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientWhatIfAtManagementGroupScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientWhatIfAtManagementGroupScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientWhatIfAtManagementGroupScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientWhatIfAtManagementGroupScopeResponse will be returned.

func (*DeploymentsClientWhatIfAtManagementGroupScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientWhatIfAtManagementGroupScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientWhatIfAtManagementGroupScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientWhatIfAtManagementGroupScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientWhatIfAtManagementGroupScopePollerResponse added in v0.3.0 

type DeploymentsClientWhatIfAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientWhatIfAtManagementGroupScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfAtManagementGroupScopePollerResponse contains the response from method DeploymentsClient.WhatIfAtManagementGroupScope.

func (DeploymentsClientWhatIfAtManagementGroupScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientWhatIfAtManagementGroupScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientWhatIfAtManagementGroupScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientWhatIfAtManagementGroupScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientWhatIfAtManagementGroupScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientWhatIfAtManagementGroupScopePollerResponse from the provided client and resume token.

type DeploymentsClientWhatIfAtManagementGroupScopeResponse added in v0.3.0 

type DeploymentsClientWhatIfAtManagementGroupScopeResponse struct {
	DeploymentsClientWhatIfAtManagementGroupScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfAtManagementGroupScopeResponse contains the response from method DeploymentsClient.WhatIfAtManagementGroupScope.

type DeploymentsClientWhatIfAtManagementGroupScopeResult added in v0.3.0 

type DeploymentsClientWhatIfAtManagementGroupScopeResult struct {
	WhatIfOperationResult
}

DeploymentsClientWhatIfAtManagementGroupScopeResult contains the result from method DeploymentsClient.WhatIfAtManagementGroupScope.

type DeploymentsClientWhatIfAtSubscriptionScopePoller added in v0.3.0 

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

DeploymentsClientWhatIfAtSubscriptionScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientWhatIfAtSubscriptionScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientWhatIfAtSubscriptionScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientWhatIfAtSubscriptionScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientWhatIfAtSubscriptionScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientWhatIfAtSubscriptionScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientWhatIfAtSubscriptionScopeResponse will be returned.

func (*DeploymentsClientWhatIfAtSubscriptionScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientWhatIfAtSubscriptionScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientWhatIfAtSubscriptionScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientWhatIfAtSubscriptionScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientWhatIfAtSubscriptionScopePollerResponse added in v0.3.0 

type DeploymentsClientWhatIfAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientWhatIfAtSubscriptionScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfAtSubscriptionScopePollerResponse contains the response from method DeploymentsClient.WhatIfAtSubscriptionScope.

func (DeploymentsClientWhatIfAtSubscriptionScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientWhatIfAtSubscriptionScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientWhatIfAtSubscriptionScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientWhatIfAtSubscriptionScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientWhatIfAtSubscriptionScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientWhatIfAtSubscriptionScopePollerResponse from the provided client and resume token.

type DeploymentsClientWhatIfAtSubscriptionScopeResponse added in v0.3.0 

type DeploymentsClientWhatIfAtSubscriptionScopeResponse struct {
	DeploymentsClientWhatIfAtSubscriptionScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfAtSubscriptionScopeResponse contains the response from method DeploymentsClient.WhatIfAtSubscriptionScope.

type DeploymentsClientWhatIfAtSubscriptionScopeResult added in v0.3.0 

type DeploymentsClientWhatIfAtSubscriptionScopeResult struct {
	WhatIfOperationResult
}

DeploymentsClientWhatIfAtSubscriptionScopeResult contains the result from method DeploymentsClient.WhatIfAtSubscriptionScope.

type DeploymentsClientWhatIfAtTenantScopePoller added in v0.3.0 

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

DeploymentsClientWhatIfAtTenantScopePoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientWhatIfAtTenantScopePoller) Done added in v0.3.0 

func (p *DeploymentsClientWhatIfAtTenantScopePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientWhatIfAtTenantScopePoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientWhatIfAtTenantScopePoller) FinalResponse(ctx context.Context) (DeploymentsClientWhatIfAtTenantScopeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientWhatIfAtTenantScopeResponse will be returned.

func (*DeploymentsClientWhatIfAtTenantScopePoller) Poll added in v0.3.0 

func (p *DeploymentsClientWhatIfAtTenantScopePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientWhatIfAtTenantScopePoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientWhatIfAtTenantScopePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientWhatIfAtTenantScopePollerResponse added in v0.3.0 

type DeploymentsClientWhatIfAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientWhatIfAtTenantScopePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfAtTenantScopePollerResponse contains the response from method DeploymentsClient.WhatIfAtTenantScope.

func (DeploymentsClientWhatIfAtTenantScopePollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientWhatIfAtTenantScopePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientWhatIfAtTenantScopeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientWhatIfAtTenantScopePollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientWhatIfAtTenantScopePollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientWhatIfAtTenantScopePollerResponse from the provided client and resume token.

type DeploymentsClientWhatIfAtTenantScopeResponse added in v0.3.0 

type DeploymentsClientWhatIfAtTenantScopeResponse struct {
	DeploymentsClientWhatIfAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfAtTenantScopeResponse contains the response from method DeploymentsClient.WhatIfAtTenantScope.

type DeploymentsClientWhatIfAtTenantScopeResult added in v0.3.0 

type DeploymentsClientWhatIfAtTenantScopeResult struct {
	WhatIfOperationResult
}

DeploymentsClientWhatIfAtTenantScopeResult contains the result from method DeploymentsClient.WhatIfAtTenantScope.

type DeploymentsClientWhatIfPoller added in v0.3.0 

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

DeploymentsClientWhatIfPoller provides polling facilities until the operation reaches a terminal state.

func (*DeploymentsClientWhatIfPoller) Done added in v0.3.0 

func (p *DeploymentsClientWhatIfPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeploymentsClientWhatIfPoller) FinalResponse added in v0.3.0 

func (p *DeploymentsClientWhatIfPoller) FinalResponse(ctx context.Context) (DeploymentsClientWhatIfResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeploymentsClientWhatIfResponse will be returned.

func (*DeploymentsClientWhatIfPoller) Poll added in v0.3.0 

func (p *DeploymentsClientWhatIfPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeploymentsClientWhatIfPoller) ResumeToken added in v0.3.0 

func (p *DeploymentsClientWhatIfPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeploymentsClientWhatIfPollerResponse added in v0.3.0 

type DeploymentsClientWhatIfPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsClientWhatIfPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfPollerResponse contains the response from method DeploymentsClient.WhatIf.

func (DeploymentsClientWhatIfPollerResponse) PollUntilDone added in v0.3.0 

func (l DeploymentsClientWhatIfPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeploymentsClientWhatIfResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeploymentsClientWhatIfPollerResponse) Resume added in v0.3.0 

func (l *DeploymentsClientWhatIfPollerResponse) Resume(ctx context.Context, client *DeploymentsClient, token string) error

Resume rehydrates a DeploymentsClientWhatIfPollerResponse from the provided client and resume token.

type DeploymentsClientWhatIfResponse added in v0.3.0 

type DeploymentsClientWhatIfResponse struct {
	DeploymentsClientWhatIfResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeploymentsClientWhatIfResponse contains the response from method DeploymentsClient.WhatIf.

type DeploymentsClientWhatIfResult added in v0.3.0 

type DeploymentsClientWhatIfResult struct {
	WhatIfOperationResult
}

DeploymentsClientWhatIfResult contains the result from method DeploymentsClient.WhatIf.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorResponse 

type ErrorResponse struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorResponse `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

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.

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 `json:"options,omitempty"`

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

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.

type ExpressionEvaluationOptions 

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

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

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.

func (ExpressionEvaluationOptionsScopeType) ToPtr 

func (c ExpressionEvaluationOptionsScopeType) ToPtr() *ExpressionEvaluationOptionsScopeType

ToPtr returns a *ExpressionEvaluationOptionsScopeType pointing to the current value.

type ExtendedLocation 

type ExtendedLocation struct {
	// The extended location name.
	Name *string `json:"name,omitempty"`

	// The extended location type.
	Type *ExtendedLocationType `json:"type,omitempty"`
}

ExtendedLocation - Resource extended location.

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.

func (ExtendedLocationType) ToPtr 

func (c ExtendedLocationType) ToPtr() *ExtendedLocationType

ToPtr returns a *ExtendedLocationType pointing to the current value.

type GenericResource 

type GenericResource struct {
	// Resource extended location.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`

	// The kind of the resource.
	Kind *string `json:"kind,omitempty"`

	// Resource location
	Location *string `json:"location,omitempty"`

	// ID of the resource that manages this resource.
	ManagedBy *string `json:"managedBy,omitempty"`

	// The plan of the resource.
	Plan *Plan `json:"plan,omitempty"`

	// The resource properties.
	Properties map[string]interface{} `json:"properties,omitempty"`

	// The SKU of the resource.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource ID
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

GenericResource - Resource information.

func (GenericResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GenericResource.

type GenericResourceExpanded 

type GenericResourceExpanded struct {
	// Resource extended location.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`

	// The kind of the resource.
	Kind *string `json:"kind,omitempty"`

	// Resource location
	Location *string `json:"location,omitempty"`

	// ID of the resource that manages this resource.
	ManagedBy *string `json:"managedBy,omitempty"`

	// The plan of the resource.
	Plan *Plan `json:"plan,omitempty"`

	// The resource properties.
	Properties map[string]interface{} `json:"properties,omitempty"`

	// The SKU of the resource.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The changed time of the resource. This is only present if requested via the $expand query parameter.
	ChangedTime *time.Time `json:"changedTime,omitempty" azure:"ro"`

	// READ-ONLY; The created time of the resource. This is only present if requested via the $expand query parameter.
	CreatedTime *time.Time `json:"createdTime,omitempty" azure:"ro"`

	// READ-ONLY; Resource ID
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the resource. This is only present if requested via the $expand query parameter.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

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 `json:"resourceType,omitempty"`

	// The tag name.
	Tagname *string `json:"tagname,omitempty"`

	// The tag value.
	Tagvalue *string `json:"tagvalue,omitempty"`
}

GenericResourceFilter - Resource filter.

type HTTPMessage 

type HTTPMessage struct {
	// HTTP message content.
	Content map[string]interface{} `json:"content,omitempty"`
}

HTTPMessage - HTTP message.

type Identity 

type Identity struct {
	// The identity type.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// 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 `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

Identity for the resource.

func (Identity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Identity.

type IdentityUserAssignedIdentitiesValue 

type IdentityUserAssignedIdentitiesValue struct {
	// READ-ONLY; The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

type MoveInfo added in v0.3.0 

type MoveInfo struct {
	// The IDs of the resources.
	Resources []*string `json:"resources,omitempty"`

	// The target resource group.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
}

MoveInfo - Parameters of move resources.

func (MoveInfo) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type MoveInfo.

type OnErrorDeployment 

type OnErrorDeployment struct {
	// The deployment to be used on error case.
	DeploymentName *string `json:"deploymentName,omitempty"`

	// The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.
	Type *OnErrorDeploymentType `json:"type,omitempty"`
}

OnErrorDeployment - Deployment on error behavior.

type OnErrorDeploymentExtended 

type OnErrorDeploymentExtended struct {
	// The deployment to be used on error case.
	DeploymentName *string `json:"deploymentName,omitempty"`

	// The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.
	Type *OnErrorDeploymentType `json:"type,omitempty"`

	// READ-ONLY; The state of the provisioning for the on error deployment.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

OnErrorDeploymentExtended - Deployment on error behavior with additional details.

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.

func (OnErrorDeploymentType) ToPtr 

func (c OnErrorDeploymentType) ToPtr() *OnErrorDeploymentType

ToPtr returns a *OnErrorDeploymentType pointing to the current value.

type Operation 

type Operation struct {
	// The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
}

Operation - Microsoft.Resources operation

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation.
	Description *string `json:"description,omitempty"`

	// Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft.Resources
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed: Profile, endpoint, etc.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - The object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Microsoft.Resources operations.
	Value []*Operation `json:"value,omitempty"`
}

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.

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

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) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - Lists all of the available Microsoft.Resources REST API operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

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

type OperationsClientListPager added in v0.3.0 

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

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.3.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.3.0 

func (p *OperationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsClientListPager) PageResponse added in v0.3.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.3.0 

type OperationsClientListResponse struct {
	OperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.3.0 

type OperationsClientListResult struct {
	OperationListResult
}

OperationsClientListResult contains the result from method OperationsClient.List. 

type ParametersLink struct {
	// REQUIRED; The URI of the parameters file.
	URI *string `json:"uri,omitempty"`

	// If included, must match the ContentVersion in the template.
	ContentVersion *string `json:"contentVersion,omitempty"`
}

ParametersLink - Entity representing the reference to the deployment parameters.

type Permission 

type Permission struct {
	// Allowed actions.
	Actions []*string `json:"actions,omitempty"`

	// Allowed Data actions.
	DataActions []*string `json:"dataActions,omitempty"`

	// Denied actions.
	NotActions []*string `json:"notActions,omitempty"`

	// Denied Data actions.
	NotDataActions []*string `json:"notDataActions,omitempty"`
}

Permission - Role definition permissions.

func (Permission) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Permission.

type Plan 

type Plan struct {
	// The plan ID.
	Name *string `json:"name,omitempty"`

	// The offer ID.
	Product *string `json:"product,omitempty"`

	// The promotion code.
	PromotionCode *string `json:"promotionCode,omitempty"`

	// The publisher ID.
	Publisher *string `json:"publisher,omitempty"`

	// The plan's version.
	Version *string `json:"version,omitempty"`
}

Plan for the resource.

type PropertyChangeType 

type PropertyChangeType string

PropertyChangeType - The type of property change. 

const (
	// 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"
	// PropertyChangeTypeArray - The property is an array and contains nested changes.
	PropertyChangeTypeArray PropertyChangeType = "Array"
	// 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.

func (PropertyChangeType) ToPtr 

func (c PropertyChangeType) ToPtr() *PropertyChangeType

ToPtr returns a *PropertyChangeType pointing to the current value.

type Provider 

type Provider struct {
	// The namespace of the resource provider.
	Namespace *string `json:"namespace,omitempty"`

	// The provider authorization consent state.
	ProviderAuthorizationConsentState *ProviderAuthorizationConsentState `json:"providerAuthorizationConsentState,omitempty"`

	// READ-ONLY; The provider ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The registration policy of the resource provider.
	RegistrationPolicy *string `json:"registrationPolicy,omitempty" azure:"ro"`

	// READ-ONLY; The registration state of the resource provider.
	RegistrationState *string `json:"registrationState,omitempty" azure:"ro"`

	// READ-ONLY; The collection of provider resource types.
	ResourceTypes []*ProviderResourceType `json:"resourceTypes,omitempty" azure:"ro"`
}

Provider - Resource provider information.

func (Provider) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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.

func (ProviderAuthorizationConsentState) ToPtr 

func (c ProviderAuthorizationConsentState) ToPtr() *ProviderAuthorizationConsentState

ToPtr returns a *ProviderAuthorizationConsentState pointing to the current value.

type ProviderConsentDefinition 

type ProviderConsentDefinition struct {
	// A value indicating whether authorization is consented or not.
	ConsentToAuthorization *bool `json:"consentToAuthorization,omitempty"`
}

ProviderConsentDefinition - The provider consent.

type ProviderExtendedLocation 

type ProviderExtendedLocation struct {
	// The extended locations for the azure location.
	ExtendedLocations []*string `json:"extendedLocations,omitempty"`

	// The azure location.
	Location *string `json:"location,omitempty"`

	// The extended location type.
	Type *string `json:"type,omitempty"`
}

ProviderExtendedLocation - The provider extended location.

func (ProviderExtendedLocation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProviderExtendedLocation.

type ProviderListResult 

type ProviderListResult struct {
	// An array of resource providers.
	Value []*Provider `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ProviderListResult - List of resource providers.

func (ProviderListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProviderListResult.

type ProviderPermission 

type ProviderPermission struct {
	// The application id.
	ApplicationID *string `json:"applicationId,omitempty"`

	// Role definition properties.
	ManagedByRoleDefinition *RoleDefinition `json:"managedByRoleDefinition,omitempty"`

	// The provider authorization consent state.
	ProviderAuthorizationConsentState *ProviderAuthorizationConsentState `json:"providerAuthorizationConsentState,omitempty"`

	// Role definition properties.
	RoleDefinition *RoleDefinition `json:"roleDefinition,omitempty"`
}

ProviderPermission - The provider permission

type ProviderPermissionListResult 

type ProviderPermissionListResult struct {
	// An array of provider permissions.
	Value []*ProviderPermission `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ProviderPermissionListResult - List of provider permissions.

func (ProviderPermissionListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProviderPermissionListResult.

type ProviderRegistrationRequest 

type ProviderRegistrationRequest struct {
	// The provider consent.
	ThirdPartyProviderConsent *ProviderConsentDefinition `json:"thirdPartyProviderConsent,omitempty"`
}

ProviderRegistrationRequest - The provider registration definition.

type ProviderResourceType 

type ProviderResourceType struct {
	// The API version.
	APIVersions []*string `json:"apiVersions,omitempty"`

	// The aliases that are supported by this resource type.
	Aliases []*Alias `json:"aliases,omitempty"`

	// The additional capabilities offered by this resource type.
	Capabilities *string `json:"capabilities,omitempty"`

	// The location mappings that are supported by this resource type.
	LocationMappings []*ProviderExtendedLocation `json:"locationMappings,omitempty"`

	// The collection of locations where this resource type can be created.
	Locations []*string `json:"locations,omitempty"`

	// The properties.
	Properties map[string]*string `json:"properties,omitempty"`

	// The resource type.
	ResourceType *string        `json:"resourceType,omitempty"`
	ZoneMappings []*ZoneMapping `json:"zoneMappings,omitempty"`

	// READ-ONLY; The API profiles for the resource provider.
	APIProfiles []*APIProfile `json:"apiProfiles,omitempty" azure:"ro"`

	// READ-ONLY; The default API version.
	DefaultAPIVersion *string `json:"defaultApiVersion,omitempty" azure:"ro"`
}

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.

type ProviderResourceTypeListResult 

type ProviderResourceTypeListResult struct {
	// An array of resource types.
	Value []*ProviderResourceType `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

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.

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

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. resourceProviderNamespace - The namespace of the resource provider. options - ProviderResourceTypesClientListOptions contains the optional parameters for the ProviderResourceTypesClient.List method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProviderResourceTypes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewProviderResourceTypesClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-provider-namespace>",
		&armresources.ProviderResourceTypesClientListOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProviderResourceTypesClientListResult)
}

Output:

type ProviderResourceTypesClientListOptions added in v0.3.0 

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 added in v0.3.0 

type ProviderResourceTypesClientListResponse struct {
	ProviderResourceTypesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProviderResourceTypesClientListResponse contains the response from method ProviderResourceTypesClient.List.

type ProviderResourceTypesClientListResult added in v0.3.0 

type ProviderResourceTypesClientListResult struct {
	ProviderResourceTypeListResult
}

ProviderResourceTypesClientListResult contains the result 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

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. resourceProviderNamespace - The namespace of the resource provider. options - ProvidersClientGetOptions contains the optional parameters for the ProvidersClient.Get method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProvider.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewProvidersClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-provider-namespace>",
		&armresources.ProvidersClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProvidersClientGetResult)
}

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. resourceProviderNamespace - The namespace of the resource provider. options - ProvidersClientGetAtTenantScopeOptions contains the optional parameters for the ProvidersClient.GetAtTenantScope method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetNamedProviderAtTenant.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewProvidersClient("<subscription-id>", cred, nil)
	res, err := client.GetAtTenantScope(ctx,
		"<resource-provider-namespace>",
		&armresources.ProvidersClientGetAtTenantScopeOptions{Expand: to.StringPtr("<expand>")})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProvidersClientGetAtTenantScopeResult)
}

Output:

func (*ProvidersClient) List 

func (client *ProvidersClient) List(options *ProvidersClientListOptions) *ProvidersClientListPager

List - Gets all resource providers for a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ProvidersClientListOptions contains the optional parameters for the ProvidersClient.List method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProviders.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewProvidersClient("<subscription-id>", cred, nil)
	pager := client.List(&armresources.ProvidersClientListOptions{Expand: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ProvidersClient) ListAtTenantScope 

func (client *ProvidersClient) ListAtTenantScope(options *ProvidersClientListAtTenantScopeOptions) *ProvidersClientListAtTenantScopePager

ListAtTenantScope - Gets all resource providers for the tenant. If the operation fails it returns an *azcore.ResponseError type. options - ProvidersClientListAtTenantScopeOptions contains the optional parameters for the ProvidersClient.ListAtTenantScope method.

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. resourceProviderNamespace - The namespace of the resource provider. options - ProvidersClientProviderPermissionsOptions contains the optional parameters for the ProvidersClient.ProviderPermissions method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProviderPermissions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewProvidersClient("<subscription-id>", cred, nil)
	res, err := client.ProviderPermissions(ctx,
		"<resource-provider-namespace>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProvidersClientProviderPermissionsResult)
}

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. 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. If the operation fails it returns an *azcore.ResponseError type. 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. resourceProviderNamespace - The namespace of the resource provider to unregister. options - ProvidersClientUnregisterOptions contains the optional parameters for the ProvidersClient.Unregister method.

type ProvidersClientGetAtTenantScopeOptions added in v0.3.0 

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 added in v0.3.0 

type ProvidersClientGetAtTenantScopeResponse struct {
	ProvidersClientGetAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientGetAtTenantScopeResponse contains the response from method ProvidersClient.GetAtTenantScope.

type ProvidersClientGetAtTenantScopeResult added in v0.3.0 

type ProvidersClientGetAtTenantScopeResult struct {
	Provider
}

ProvidersClientGetAtTenantScopeResult contains the result from method ProvidersClient.GetAtTenantScope.

type ProvidersClientGetOptions added in v0.3.0 

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 added in v0.3.0 

type ProvidersClientGetResponse struct {
	ProvidersClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientGetResponse contains the response from method ProvidersClient.Get.

type ProvidersClientGetResult added in v0.3.0 

type ProvidersClientGetResult struct {
	Provider
}

ProvidersClientGetResult contains the result from method ProvidersClient.Get.

type ProvidersClientListAtTenantScopeOptions added in v0.3.0 

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.ListAtTenantScope method.

type ProvidersClientListAtTenantScopePager added in v0.3.0 

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

ProvidersClientListAtTenantScopePager provides operations for iterating over paged responses.

func (*ProvidersClientListAtTenantScopePager) Err added in v0.3.0 

func (p *ProvidersClientListAtTenantScopePager) Err() error

Err returns the last error encountered while paging.

func (*ProvidersClientListAtTenantScopePager) NextPage added in v0.3.0 

func (p *ProvidersClientListAtTenantScopePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProvidersClientListAtTenantScopePager) PageResponse added in v0.3.0 

func (p *ProvidersClientListAtTenantScopePager) PageResponse() ProvidersClientListAtTenantScopeResponse

PageResponse returns the current ProvidersClientListAtTenantScopeResponse page.

type ProvidersClientListAtTenantScopeResponse added in v0.3.0 

type ProvidersClientListAtTenantScopeResponse struct {
	ProvidersClientListAtTenantScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientListAtTenantScopeResponse contains the response from method ProvidersClient.ListAtTenantScope.

type ProvidersClientListAtTenantScopeResult added in v0.3.0 

type ProvidersClientListAtTenantScopeResult struct {
	ProviderListResult
}

ProvidersClientListAtTenantScopeResult contains the result from method ProvidersClient.ListAtTenantScope.

type ProvidersClientListOptions added in v0.3.0 

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.List method.

type ProvidersClientListPager added in v0.3.0 

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

ProvidersClientListPager provides operations for iterating over paged responses.

func (*ProvidersClientListPager) Err added in v0.3.0 

func (p *ProvidersClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ProvidersClientListPager) NextPage added in v0.3.0 

func (p *ProvidersClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProvidersClientListPager) PageResponse added in v0.3.0 

func (p *ProvidersClientListPager) PageResponse() ProvidersClientListResponse

PageResponse returns the current ProvidersClientListResponse page.

type ProvidersClientListResponse added in v0.3.0 

type ProvidersClientListResponse struct {
	ProvidersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientListResponse contains the response from method ProvidersClient.List.

type ProvidersClientListResult added in v0.3.0 

type ProvidersClientListResult struct {
	ProviderListResult
}

ProvidersClientListResult contains the result from method ProvidersClient.List.

type ProvidersClientProviderPermissionsOptions added in v0.3.0 

type ProvidersClientProviderPermissionsOptions struct {
}

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

type ProvidersClientProviderPermissionsResponse added in v0.3.0 

type ProvidersClientProviderPermissionsResponse struct {
	ProvidersClientProviderPermissionsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientProviderPermissionsResponse contains the response from method ProvidersClient.ProviderPermissions.

type ProvidersClientProviderPermissionsResult added in v0.3.0 

type ProvidersClientProviderPermissionsResult struct {
	ProviderPermissionListResult
}

ProvidersClientProviderPermissionsResult contains the result from method ProvidersClient.ProviderPermissions.

type ProvidersClientRegisterAtManagementGroupScopeOptions added in v0.3.0 

type ProvidersClientRegisterAtManagementGroupScopeOptions struct {
}

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

type ProvidersClientRegisterAtManagementGroupScopeResponse added in v0.3.0 

type ProvidersClientRegisterAtManagementGroupScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientRegisterAtManagementGroupScopeResponse contains the response from method ProvidersClient.RegisterAtManagementGroupScope.

type ProvidersClientRegisterOptions added in v0.3.0 

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

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

type ProvidersClientRegisterResponse added in v0.3.0 

type ProvidersClientRegisterResponse struct {
	ProvidersClientRegisterResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientRegisterResponse contains the response from method ProvidersClient.Register.

type ProvidersClientRegisterResult added in v0.3.0 

type ProvidersClientRegisterResult struct {
	Provider
}

ProvidersClientRegisterResult contains the result from method ProvidersClient.Register.

type ProvidersClientUnregisterOptions added in v0.3.0 

type ProvidersClientUnregisterOptions struct {
}

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

type ProvidersClientUnregisterResponse added in v0.3.0 

type ProvidersClientUnregisterResponse struct {
	ProvidersClientUnregisterResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProvidersClientUnregisterResponse contains the response from method ProvidersClient.Unregister.

type ProvidersClientUnregisterResult added in v0.3.0 

type ProvidersClientUnregisterResult struct {
	Provider
}

ProvidersClientUnregisterResult contains the result from method ProvidersClient.Unregister.

type ProvisioningOperation 

type ProvisioningOperation string

ProvisioningOperation - The name of the current provisioning operation. 

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

func PossibleProvisioningOperationValues 

func PossibleProvisioningOperationValues() []ProvisioningOperation

PossibleProvisioningOperationValues returns the possible values for the ProvisioningOperation const type.

func (ProvisioningOperation) ToPtr 

func (c ProvisioningOperation) ToPtr() *ProvisioningOperation

ToPtr returns a *ProvisioningOperation pointing to the current value.

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.

func (ProvisioningState) ToPtr 

func (c ProvisioningState) ToPtr() *ProvisioningState

ToPtr returns a *ProvisioningState pointing to the current value.

type Resource 

type Resource struct {
	// Resource extended location.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource location
	Location *string `json:"location,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource ID
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Specified resource.

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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 `json:"location,omitempty"`

	// The ID of the resource that manages this resource group.
	ManagedBy *string `json:"managedBy,omitempty"`

	// The resource group properties.
	Properties *ResourceGroupProperties `json:"properties,omitempty"`

	// The tags attached to the resource group.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The ID of the resource group.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource group.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource group.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ResourceGroup - Resource group information.

func (ResourceGroup) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceGroup.

type ResourceGroupExportResult 

type ResourceGroupExportResult struct {
	// The template export error.
	Error *ErrorResponse `json:"error,omitempty"`

	// The template content.
	Template map[string]interface{} `json:"template,omitempty"`
}

ResourceGroupExportResult - Resource group export result.

type ResourceGroupFilter 

type ResourceGroupFilter struct {
	// The tag name.
	TagName *string `json:"tagName,omitempty"`

	// The tag value.
	TagValue *string `json:"tagValue,omitempty"`
}

ResourceGroupFilter - Resource group filter.

type ResourceGroupListResult 

type ResourceGroupListResult struct {
	// An array of resource groups.
	Value []*ResourceGroup `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ResourceGroupListResult - List of resource groups.

func (ResourceGroupListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceGroupListResult.

type ResourceGroupPatchable 

type ResourceGroupPatchable struct {
	// The ID of the resource that manages this resource group.
	ManagedBy *string `json:"managedBy,omitempty"`

	// The name of the resource group.
	Name *string `json:"name,omitempty"`

	// The resource group properties.
	Properties *ResourceGroupProperties `json:"properties,omitempty"`

	// The tags attached to the resource group.
	Tags map[string]*string `json:"tags,omitempty"`
}

ResourceGroupPatchable - Resource group information.

func (ResourceGroupPatchable) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceGroupPatchable.

type ResourceGroupProperties 

type ResourceGroupProperties struct {
	// READ-ONLY; The provisioning state.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

ResourceGroupProperties - The resource group properties.

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

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) (ResourceGroupsClientDeletePollerResponse, 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewResourceGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		&armresources.ResourceGroupsClientBeginDeleteOptions{ForceDeletionTypes: to.StringPtr("<force-deletion-types>")})
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ResourceGroupsClient) BeginExportTemplate 

func (client *ResourceGroupsClient) BeginExportTemplate(ctx context.Context, resourceGroupName string, parameters ExportTemplateRequest, options *ResourceGroupsClientBeginExportTemplateOptions) (ResourceGroupsClientExportTemplatePollerResponse, error)

BeginExportTemplate - Captures the specified resource group as a template. If the operation fails it returns an *azcore.ResponseError type. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/ExportResourceGroup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewResourceGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginExportTemplate(ctx,
		"<resource-group-name>",
		armresources.ExportTemplateRequest{
			Options: to.StringPtr("<options>"),
			Resources: []*string{
				to.StringPtr("*")},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceGroupsClientExportTemplateResult)
}

Output:

func (*ResourceGroupsClient) CheckExistence 

func (client *ResourceGroupsClient) CheckExistence(ctx context.Context, resourceGroupName string, options *ResourceGroupsClientCheckExistenceOptions) (ResourceGroupsClientCheckExistenceResponse, error)

CheckExistence - Checks whether a resource group exists. 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. 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

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/CreateResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewResourceGroupsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		armresources.ResourceGroup{
			Location: to.StringPtr("<location>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceGroupsClientCreateOrUpdateResult)
}

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. 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) List 

func (client *ResourceGroupsClient) List(options *ResourceGroupsClientListOptions) *ResourceGroupsClientListPager

List - Gets all the resource groups for a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ResourceGroupsClientListOptions contains the optional parameters for the ResourceGroupsClient.List 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. 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 added in v0.3.0 

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
}

ResourceGroupsClientBeginDeleteOptions contains the optional parameters for the ResourceGroupsClient.BeginDelete method.

type ResourceGroupsClientBeginExportTemplateOptions added in v0.3.0 

type ResourceGroupsClientBeginExportTemplateOptions struct {
}

ResourceGroupsClientBeginExportTemplateOptions contains the optional parameters for the ResourceGroupsClient.BeginExportTemplate method.

type ResourceGroupsClientCheckExistenceOptions added in v0.3.0 

type ResourceGroupsClientCheckExistenceOptions struct {
}

ResourceGroupsClientCheckExistenceOptions contains the optional parameters for the ResourceGroupsClient.CheckExistence method.

type ResourceGroupsClientCheckExistenceResponse added in v0.3.0 

type ResourceGroupsClientCheckExistenceResponse struct {
	ResourceGroupsClientCheckExistenceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientCheckExistenceResponse contains the response from method ResourceGroupsClient.CheckExistence.

type ResourceGroupsClientCheckExistenceResult added in v0.3.0 

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

ResourceGroupsClientCheckExistenceResult contains the result from method ResourceGroupsClient.CheckExistence.

type ResourceGroupsClientCreateOrUpdateOptions added in v0.3.0 

type ResourceGroupsClientCreateOrUpdateOptions struct {
}

ResourceGroupsClientCreateOrUpdateOptions contains the optional parameters for the ResourceGroupsClient.CreateOrUpdate method.

type ResourceGroupsClientCreateOrUpdateResponse added in v0.3.0 

type ResourceGroupsClientCreateOrUpdateResponse struct {
	ResourceGroupsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientCreateOrUpdateResponse contains the response from method ResourceGroupsClient.CreateOrUpdate.

type ResourceGroupsClientCreateOrUpdateResult added in v0.3.0 

type ResourceGroupsClientCreateOrUpdateResult struct {
	ResourceGroup
}

ResourceGroupsClientCreateOrUpdateResult contains the result from method ResourceGroupsClient.CreateOrUpdate.

type ResourceGroupsClientDeletePoller added in v0.3.0 

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

ResourceGroupsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ResourceGroupsClientDeletePoller) Done added in v0.3.0 

func (p *ResourceGroupsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ResourceGroupsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ResourceGroupsClientDeletePoller) FinalResponse(ctx context.Context) (ResourceGroupsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ResourceGroupsClientDeleteResponse will be returned.

func (*ResourceGroupsClientDeletePoller) Poll added in v0.3.0 

func (p *ResourceGroupsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ResourceGroupsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ResourceGroupsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ResourceGroupsClientDeletePollerResponse added in v0.3.0 

type ResourceGroupsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourceGroupsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientDeletePollerResponse contains the response from method ResourceGroupsClient.Delete.

func (ResourceGroupsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ResourceGroupsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ResourceGroupsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ResourceGroupsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ResourceGroupsClientDeletePollerResponse) Resume(ctx context.Context, client *ResourceGroupsClient, token string) error

Resume rehydrates a ResourceGroupsClientDeletePollerResponse from the provided client and resume token.

type ResourceGroupsClientDeleteResponse added in v0.3.0 

type ResourceGroupsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientDeleteResponse contains the response from method ResourceGroupsClient.Delete.

type ResourceGroupsClientExportTemplatePoller added in v0.3.0 

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

ResourceGroupsClientExportTemplatePoller provides polling facilities until the operation reaches a terminal state.

func (*ResourceGroupsClientExportTemplatePoller) Done added in v0.3.0 

func (p *ResourceGroupsClientExportTemplatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ResourceGroupsClientExportTemplatePoller) FinalResponse added in v0.3.0 

func (p *ResourceGroupsClientExportTemplatePoller) FinalResponse(ctx context.Context) (ResourceGroupsClientExportTemplateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ResourceGroupsClientExportTemplateResponse will be returned.

func (*ResourceGroupsClientExportTemplatePoller) Poll added in v0.3.0 

func (p *ResourceGroupsClientExportTemplatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ResourceGroupsClientExportTemplatePoller) ResumeToken added in v0.3.0 

func (p *ResourceGroupsClientExportTemplatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ResourceGroupsClientExportTemplatePollerResponse added in v0.3.0 

type ResourceGroupsClientExportTemplatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourceGroupsClientExportTemplatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientExportTemplatePollerResponse contains the response from method ResourceGroupsClient.ExportTemplate.

func (ResourceGroupsClientExportTemplatePollerResponse) PollUntilDone added in v0.3.0 

func (l ResourceGroupsClientExportTemplatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ResourceGroupsClientExportTemplateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ResourceGroupsClientExportTemplatePollerResponse) Resume added in v0.3.0 

func (l *ResourceGroupsClientExportTemplatePollerResponse) Resume(ctx context.Context, client *ResourceGroupsClient, token string) error

Resume rehydrates a ResourceGroupsClientExportTemplatePollerResponse from the provided client and resume token.

type ResourceGroupsClientExportTemplateResponse added in v0.3.0 

type ResourceGroupsClientExportTemplateResponse struct {
	ResourceGroupsClientExportTemplateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientExportTemplateResponse contains the response from method ResourceGroupsClient.ExportTemplate.

type ResourceGroupsClientExportTemplateResult added in v0.3.0 

type ResourceGroupsClientExportTemplateResult struct {
	ResourceGroupExportResult
}

ResourceGroupsClientExportTemplateResult contains the result from method ResourceGroupsClient.ExportTemplate.

type ResourceGroupsClientGetOptions added in v0.3.0 

type ResourceGroupsClientGetOptions struct {
}

ResourceGroupsClientGetOptions contains the optional parameters for the ResourceGroupsClient.Get method.

type ResourceGroupsClientGetResponse added in v0.3.0 

type ResourceGroupsClientGetResponse struct {
	ResourceGroupsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientGetResponse contains the response from method ResourceGroupsClient.Get.

type ResourceGroupsClientGetResult added in v0.3.0 

type ResourceGroupsClientGetResult struct {
	ResourceGroup
}

ResourceGroupsClientGetResult contains the result from method ResourceGroupsClient.Get.

type ResourceGroupsClientListOptions added in v0.3.0 

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.List method.

type ResourceGroupsClientListPager added in v0.3.0 

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

ResourceGroupsClientListPager provides operations for iterating over paged responses.

func (*ResourceGroupsClientListPager) Err added in v0.3.0 

func (p *ResourceGroupsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceGroupsClientListPager) NextPage added in v0.3.0 

func (p *ResourceGroupsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ResourceGroupsClientListPager) PageResponse added in v0.3.0 

func (p *ResourceGroupsClientListPager) PageResponse() ResourceGroupsClientListResponse

PageResponse returns the current ResourceGroupsClientListResponse page.

type ResourceGroupsClientListResponse added in v0.3.0 

type ResourceGroupsClientListResponse struct {
	ResourceGroupsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientListResponse contains the response from method ResourceGroupsClient.List.

type ResourceGroupsClientListResult added in v0.3.0 

type ResourceGroupsClientListResult struct {
	ResourceGroupListResult
}

ResourceGroupsClientListResult contains the result from method ResourceGroupsClient.List.

type ResourceGroupsClientUpdateOptions added in v0.3.0 

type ResourceGroupsClientUpdateOptions struct {
}

ResourceGroupsClientUpdateOptions contains the optional parameters for the ResourceGroupsClient.Update method.

type ResourceGroupsClientUpdateResponse added in v0.3.0 

type ResourceGroupsClientUpdateResponse struct {
	ResourceGroupsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceGroupsClientUpdateResponse contains the response from method ResourceGroupsClient.Update.

type ResourceGroupsClientUpdateResult added in v0.3.0 

type ResourceGroupsClientUpdateResult struct {
	ResourceGroup
}

ResourceGroupsClientUpdateResult contains the result from method ResourceGroupsClient.Update.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The identity type. 

const (
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeUserAssigned               ResourceIdentityType = "UserAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

func (ResourceIdentityType) ToPtr 

func (c ResourceIdentityType) ToPtr() *ResourceIdentityType

ToPtr returns a *ResourceIdentityType pointing to the current value.

type ResourceListResult 

type ResourceListResult struct {
	// An array of resources.
	Value []*GenericResourceExpanded `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ResourceListResult - List of resource groups.

func (ResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceListResult.

type ResourceProviderOperationDisplayProperties 

type ResourceProviderOperationDisplayProperties struct {
	// Operation description.
	Description *string `json:"description,omitempty"`

	// Resource provider operation.
	Operation *string `json:"operation,omitempty"`

	// Operation provider.
	Provider *string `json:"provider,omitempty"`

	// Operation description.
	Publisher *string `json:"publisher,omitempty"`

	// Operation resource.
	Resource *string `json:"resource,omitempty"`
}

ResourceProviderOperationDisplayProperties - Resource provider operation's display properties.

type ResourceReference 

type ResourceReference struct {
	// READ-ONLY; The fully qualified resource Id.
	ID *string `json:"id,omitempty" azure:"ro"`
}

ResourceReference - The resource Id model.

type RoleDefinition 

type RoleDefinition struct {
	// The role definition ID.
	ID *string `json:"id,omitempty"`

	// If this is a service role.
	IsServiceRole *bool `json:"isServiceRole,omitempty"`

	// The role definition name.
	Name *string `json:"name,omitempty"`

	// Role definition permissions.
	Permissions []*Permission `json:"permissions,omitempty"`

	// Role definition assignable scopes.
	Scopes []*string `json:"scopes,omitempty"`
}

RoleDefinition - Role definition properties.

func (RoleDefinition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleDefinition.

type SKU 

type SKU struct {
	// The SKU capacity.
	Capacity *int32 `json:"capacity,omitempty"`

	// The SKU family.
	Family *string `json:"family,omitempty"`

	// The SKU model.
	Model *string `json:"model,omitempty"`

	// The SKU name.
	Name *string `json:"name,omitempty"`

	// The SKU size.
	Size *string `json:"size,omitempty"`

	// The SKU tier.
	Tier *string `json:"tier,omitempty"`
}

SKU for the resource.

type ScopedDeployment 

type ScopedDeployment struct {
	// REQUIRED; The location to store the deployment data.
	Location *string `json:"location,omitempty"`

	// REQUIRED; The deployment properties.
	Properties *DeploymentProperties `json:"properties,omitempty"`

	// Deployment tags
	Tags map[string]*string `json:"tags,omitempty"`
}

ScopedDeployment - Deployment operation parameters.

func (ScopedDeployment) MarshalJSON 

func (s ScopedDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScopedDeployment.

type ScopedDeploymentWhatIf 

type ScopedDeploymentWhatIf struct {
	// REQUIRED; The location to store the deployment data.
	Location *string `json:"location,omitempty"`

	// REQUIRED; The deployment properties.
	Properties *DeploymentWhatIfProperties `json:"properties,omitempty"`
}

ScopedDeploymentWhatIf - Deployment What-if operation parameters.

type StatusMessage 

type StatusMessage struct {
	// The error reported by the operation.
	Error *ErrorResponse `json:"error,omitempty"`

	// Status of the deployment operation.
	Status *string `json:"status,omitempty"`
}

StatusMessage - Operation status message object.

type SubResource 

type SubResource struct {
	// Resource ID
	ID *string `json:"id,omitempty"`
}

SubResource - Sub-resource.

type TagCount 

type TagCount struct {
	// Type of count.
	Type *string `json:"type,omitempty"`

	// Value of count.
	Value *int32 `json:"value,omitempty"`
}

TagCount - Tag count.

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 `json:"count,omitempty"`

	// The tag name.
	TagName *string `json:"tagName,omitempty"`

	// The list of tag values.
	Values []*TagValue `json:"values,omitempty"`

	// READ-ONLY; The tag name ID.
	ID *string `json:"id,omitempty" azure:"ro"`
}

TagDetails - Tag details.

func (TagDetails) MarshalJSON 

func (t TagDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagDetails.

type TagValue 

type TagValue struct {
	// The tag value count.
	Count *TagCount `json:"count,omitempty"`

	// The tag value.
	TagValue *string `json:"tagValue,omitempty"`

	// READ-ONLY; The tag value ID.
	ID *string `json:"id,omitempty" azure:"ro"`
}

TagValue - Tag information.

type Tags 

type Tags struct {
	// Dictionary of
	Tags map[string]*string `json:"tags,omitempty"`
}

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.

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

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) 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. tagName - The name of the tag to create. options - TagsClientCreateOrUpdateOptions contains the optional parameters for the TagsClient.CreateOrUpdate method.

func (*TagsClient) CreateOrUpdateAtScope 

func (client *TagsClient) CreateOrUpdateAtScope(ctx context.Context, scope string, parameters TagsResource, options *TagsClientCreateOrUpdateAtScopeOptions) (TagsClientCreateOrUpdateAtScopeResponse, error)

CreateOrUpdateAtScope - 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. scope - The resource scope. options - TagsClientCreateOrUpdateAtScopeOptions contains the optional parameters for the TagsClient.CreateOrUpdateAtScope method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutTagsResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewTagsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdateAtScope(ctx,
		"<scope>",
		armresources.TagsResource{
			Properties: &armresources.Tags{
				Tags: map[string]*string{
					"tagKey1": to.StringPtr("tag-value-1"),
					"tagKey2": to.StringPtr("tag-value-2"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.TagsClientCreateOrUpdateAtScopeResult)
}

Output:

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. 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. tagName - The name of the tag. options - TagsClientDeleteOptions contains the optional parameters for the TagsClient.Delete method.

func (*TagsClient) DeleteAtScope 

func (client *TagsClient) DeleteAtScope(ctx context.Context, scope string, options *TagsClientDeleteAtScopeOptions) (TagsClientDeleteAtScopeResponse, error)

DeleteAtScope - Deletes the entire set of tags on a resource or subscription. If the operation fails it returns an *azcore.ResponseError type. scope - The resource scope. options - TagsClientDeleteAtScopeOptions contains the optional parameters for the TagsClient.DeleteAtScope 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. 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. scope - The resource scope. options - TagsClientGetAtScopeOptions contains the optional parameters for the TagsClient.GetAtScope method.

Example

x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetTagsResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresources.NewTagsClient("<subscription-id>", cred, nil)
	res, err := client.GetAtScope(ctx,
		"<scope>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.TagsClientGetAtScopeResult)
}

Output:

func (*TagsClient) List 

func (client *TagsClient) List(options *TagsClientListOptions) *TagsClientListPager

List - 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. If the operation fails it returns an *azcore.ResponseError type. options - TagsClientListOptions contains the optional parameters for the TagsClient.List method.

func (*TagsClient) UpdateAtScope 

func (client *TagsClient) UpdateAtScope(ctx context.Context, scope string, parameters TagsPatchResource, options *TagsClientUpdateAtScopeOptions) (TagsClientUpdateAtScopeResponse, error)

UpdateAtScope - 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. scope - The resource scope. options - TagsClientUpdateAtScopeOptions contains the optional parameters for the TagsClient.UpdateAtScope method.

type TagsClientCreateOrUpdateAtScopeOptions added in v0.3.0 

type TagsClientCreateOrUpdateAtScopeOptions struct {
}

TagsClientCreateOrUpdateAtScopeOptions contains the optional parameters for the TagsClient.CreateOrUpdateAtScope method.

type TagsClientCreateOrUpdateAtScopeResponse added in v0.3.0 

type TagsClientCreateOrUpdateAtScopeResponse struct {
	TagsClientCreateOrUpdateAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientCreateOrUpdateAtScopeResponse contains the response from method TagsClient.CreateOrUpdateAtScope.

type TagsClientCreateOrUpdateAtScopeResult added in v0.3.0 

type TagsClientCreateOrUpdateAtScopeResult struct {
	TagsResource
}

TagsClientCreateOrUpdateAtScopeResult contains the result from method TagsClient.CreateOrUpdateAtScope.

type TagsClientCreateOrUpdateOptions added in v0.3.0 

type TagsClientCreateOrUpdateOptions struct {
}

TagsClientCreateOrUpdateOptions contains the optional parameters for the TagsClient.CreateOrUpdate method.

type TagsClientCreateOrUpdateResponse added in v0.3.0 

type TagsClientCreateOrUpdateResponse struct {
	TagsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientCreateOrUpdateResponse contains the response from method TagsClient.CreateOrUpdate.

type TagsClientCreateOrUpdateResult added in v0.3.0 

type TagsClientCreateOrUpdateResult struct {
	TagDetails
}

TagsClientCreateOrUpdateResult contains the result from method TagsClient.CreateOrUpdate.

type TagsClientCreateOrUpdateValueOptions added in v0.3.0 

type TagsClientCreateOrUpdateValueOptions struct {
}

TagsClientCreateOrUpdateValueOptions contains the optional parameters for the TagsClient.CreateOrUpdateValue method.

type TagsClientCreateOrUpdateValueResponse added in v0.3.0 

type TagsClientCreateOrUpdateValueResponse struct {
	TagsClientCreateOrUpdateValueResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientCreateOrUpdateValueResponse contains the response from method TagsClient.CreateOrUpdateValue.

type TagsClientCreateOrUpdateValueResult added in v0.3.0 

type TagsClientCreateOrUpdateValueResult struct {
	TagValue
}

TagsClientCreateOrUpdateValueResult contains the result from method TagsClient.CreateOrUpdateValue.

type TagsClientDeleteAtScopeOptions added in v0.3.0 

type TagsClientDeleteAtScopeOptions struct {
}

TagsClientDeleteAtScopeOptions contains the optional parameters for the TagsClient.DeleteAtScope method.

type TagsClientDeleteAtScopeResponse added in v0.3.0 

type TagsClientDeleteAtScopeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientDeleteAtScopeResponse contains the response from method TagsClient.DeleteAtScope.

type TagsClientDeleteOptions added in v0.3.0 

type TagsClientDeleteOptions struct {
}

TagsClientDeleteOptions contains the optional parameters for the TagsClient.Delete method.

type TagsClientDeleteResponse added in v0.3.0 

type TagsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientDeleteResponse contains the response from method TagsClient.Delete.

type TagsClientDeleteValueOptions added in v0.3.0 

type TagsClientDeleteValueOptions struct {
}

TagsClientDeleteValueOptions contains the optional parameters for the TagsClient.DeleteValue method.

type TagsClientDeleteValueResponse added in v0.3.0 

type TagsClientDeleteValueResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientDeleteValueResponse contains the response from method TagsClient.DeleteValue.

type TagsClientGetAtScopeOptions added in v0.3.0 

type TagsClientGetAtScopeOptions struct {
}

TagsClientGetAtScopeOptions contains the optional parameters for the TagsClient.GetAtScope method.

type TagsClientGetAtScopeResponse added in v0.3.0 

type TagsClientGetAtScopeResponse struct {
	TagsClientGetAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientGetAtScopeResponse contains the response from method TagsClient.GetAtScope.

type TagsClientGetAtScopeResult added in v0.3.0 

type TagsClientGetAtScopeResult struct {
	TagsResource
}

TagsClientGetAtScopeResult contains the result from method TagsClient.GetAtScope.

type TagsClientListOptions added in v0.3.0 

type TagsClientListOptions struct {
}

TagsClientListOptions contains the optional parameters for the TagsClient.List method.

type TagsClientListPager added in v0.3.0 

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

TagsClientListPager provides operations for iterating over paged responses.

func (*TagsClientListPager) Err added in v0.3.0 

func (p *TagsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*TagsClientListPager) NextPage added in v0.3.0 

func (p *TagsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TagsClientListPager) PageResponse added in v0.3.0 

func (p *TagsClientListPager) PageResponse() TagsClientListResponse

PageResponse returns the current TagsClientListResponse page.

type TagsClientListResponse added in v0.3.0 

type TagsClientListResponse struct {
	TagsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientListResponse contains the response from method TagsClient.List.

type TagsClientListResult added in v0.3.0 

type TagsClientListResult struct {
	TagsListResult
}

TagsClientListResult contains the result from method TagsClient.List.

type TagsClientUpdateAtScopeOptions added in v0.3.0 

type TagsClientUpdateAtScopeOptions struct {
}

TagsClientUpdateAtScopeOptions contains the optional parameters for the TagsClient.UpdateAtScope method.

type TagsClientUpdateAtScopeResponse added in v0.3.0 

type TagsClientUpdateAtScopeResponse struct {
	TagsClientUpdateAtScopeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagsClientUpdateAtScopeResponse contains the response from method TagsClient.UpdateAtScope.

type TagsClientUpdateAtScopeResult added in v0.3.0 

type TagsClientUpdateAtScopeResult struct {
	TagsResource
}

TagsClientUpdateAtScopeResult contains the result from method TagsClient.UpdateAtScope.

type TagsListResult 

type TagsListResult struct {
	// An array of tags.
	Value []*TagDetails `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

TagsListResult - List of subscription tags.

func (TagsListResult) MarshalJSON 

func (t TagsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller 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.

func (TagsPatchOperation) ToPtr 

func (c TagsPatchOperation) ToPtr() *TagsPatchOperation

ToPtr returns a *TagsPatchOperation pointing to the current value.

type TagsPatchResource 

type TagsPatchResource struct {
	// The operation type for the patch API.
	Operation *TagsPatchOperation `json:"operation,omitempty"`

	// The set of tags.
	Properties *Tags `json:"properties,omitempty"`
}

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.

type TagsResource 

type TagsResource struct {
	// REQUIRED; The set of tags.
	Properties *Tags `json:"properties,omitempty"`

	// READ-ONLY; The ID of the tags wrapper resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the tags wrapper resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the tags wrapper resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

TagsResource - Wrapper resource for tags API requests and responses.

type TargetResource 

type TargetResource struct {
	// The ID of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the resource.
	ResourceName *string `json:"resourceName,omitempty"`

	// The type of the resource.
	ResourceType *string `json:"resourceType,omitempty"`
}

TargetResource - Target resource.

type TemplateHashResult 

type TemplateHashResult struct {
	// The minified template string.
	MinifiedTemplate *string `json:"minifiedTemplate,omitempty"`

	// The template hash.
	TemplateHash *string `json:"templateHash,omitempty"`
}

TemplateHashResult - Result of the request to calculate template hash. It contains a string of minified template and its hash. 

type TemplateLink struct {
	// If included, must match the ContentVersion in the template.
	ContentVersion *string `json:"contentVersion,omitempty"`

	// The resource id of a Template Spec. Use either the id or uri property, but not both.
	ID *string `json:"id,omitempty"`

	// The query string (for example, a SAS token) to be used with the templateLink URI.
	QueryString *string `json:"queryString,omitempty"`

	// 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 `json:"relativePath,omitempty"`

	// The URI of the template to deploy. Use either the uri or id property, but not both.
	URI *string `json:"uri,omitempty"`
}

TemplateLink - Entity representing the reference to the template.

type WhatIfChange 

type WhatIfChange struct {
	// REQUIRED; Type of change that will be made to the resource when the deployment is executed.
	ChangeType *ChangeType `json:"changeType,omitempty"`

	// REQUIRED; Resource ID
	ResourceID *string `json:"resourceId,omitempty"`

	// The predicted snapshot of the resource after the deployment is executed.
	After map[string]interface{} `json:"after,omitempty"`

	// The snapshot of the resource before the deployment is executed.
	Before map[string]interface{} `json:"before,omitempty"`

	// The predicted changes to resource properties.
	Delta []*WhatIfPropertyChange `json:"delta,omitempty"`

	// The explanation about why the resource is unsupported by What-If.
	UnsupportedReason *string `json:"unsupportedReason,omitempty"`
}

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.

type WhatIfOperationProperties 

type WhatIfOperationProperties struct {
	// List of resource changes predicted by What-If operation.
	Changes []*WhatIfChange `json:"changes,omitempty"`
}

WhatIfOperationProperties - Deployment operation properties.

func (WhatIfOperationProperties) MarshalJSON 

func (w WhatIfOperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WhatIfOperationProperties.

type WhatIfOperationResult 

type WhatIfOperationResult struct {
	// Error when What-If operation fails.
	Error *ErrorResponse `json:"error,omitempty"`

	// What-If operation properties.
	Properties *WhatIfOperationProperties `json:"properties,omitempty"`

	// Status of the What-If operation.
	Status *string `json:"status,omitempty"`
}

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.

type WhatIfPropertyChange 

type WhatIfPropertyChange struct {
	// REQUIRED; The path of the property.
	Path *string `json:"path,omitempty"`

	// REQUIRED; The type of property change.
	PropertyChangeType *PropertyChangeType `json:"propertyChangeType,omitempty"`

	// The value of the property after the deployment is executed.
	After map[string]interface{} `json:"after,omitempty"`

	// The value of the property before the deployment is executed.
	Before map[string]interface{} `json:"before,omitempty"`

	// Nested property changes.
	Children []*WhatIfPropertyChange `json:"children,omitempty"`
}

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.

type WhatIfResultFormat 

type WhatIfResultFormat string

WhatIfResultFormat - The format of the What-If results 

const (
	WhatIfResultFormatResourceIDOnly       WhatIfResultFormat = "ResourceIdOnly"
	WhatIfResultFormatFullResourcePayloads WhatIfResultFormat = "FullResourcePayloads"
)

func PossibleWhatIfResultFormatValues 

func PossibleWhatIfResultFormatValues() []WhatIfResultFormat

PossibleWhatIfResultFormatValues returns the possible values for the WhatIfResultFormat const type.

func (WhatIfResultFormat) ToPtr 

func (c WhatIfResultFormat) ToPtr() *WhatIfResultFormat

ToPtr returns a *WhatIfResultFormat pointing to the current value.

type ZoneMapping added in v0.3.0 

type ZoneMapping struct {
	// The location of the zone mapping.
	Location *string   `json:"location,omitempty"`
	Zones    []*string `json:"zones,omitempty"`
}

func (ZoneMapping) MarshalJSON added in v0.3.0 

func (z ZoneMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ZoneMapping.

Source Files

View all Source files

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.