armresources

package module
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Nov 1, 2021 License: MIT Imports: 16 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

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

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

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 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.)
	InnerError *ErrorResponse `json:"error,omitempty"`
	// contains filtered or unexported fields
}

CloudError - An error response for a resource management request. Implements the error and azcore.HTTPResponse interfaces.

func (CloudError) Error

func (e CloudError) Error() string

Error implements the error interface for type CloudError. The contents of the error text are not contractual and subject to change.

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.

func (*DeploymentOperationsClient) Get

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

Get - Gets a deployments operation. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) GetAtManagementGroupScope

GetAtManagementGroupScope - Gets a deployments operation. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) GetAtScope

GetAtScope - Gets a deployments operation. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) GetAtSubscriptionScope

GetAtSubscriptionScope - Gets a deployments operation. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) GetAtTenantScope

GetAtTenantScope - Gets a deployments operation. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) List

func (client *DeploymentOperationsClient) List(resourceGroupName string, deploymentName string, options *DeploymentOperationsListOptions) *DeploymentOperationsListPager

List - Gets all deployments operations for a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) ListAtManagementGroupScope

ListAtManagementGroupScope - Gets all deployments operations for a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) ListAtScope

ListAtScope - Gets all deployments operations for a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) ListAtSubscriptionScope

ListAtSubscriptionScope - Gets all deployments operations for a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentOperationsClient) ListAtTenantScope

ListAtTenantScope - Gets all deployments operations for a deployment. If the operation fails it returns the *CloudError error type.

type DeploymentOperationsGetAtManagementGroupScopeOptions

type DeploymentOperationsGetAtManagementGroupScopeOptions struct {
}

DeploymentOperationsGetAtManagementGroupScopeOptions contains the optional parameters for the DeploymentOperations.GetAtManagementGroupScope method.

type DeploymentOperationsGetAtManagementGroupScopeResponse

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

DeploymentOperationsGetAtManagementGroupScopeResponse contains the response from method DeploymentOperations.GetAtManagementGroupScope.

type DeploymentOperationsGetAtManagementGroupScopeResult

type DeploymentOperationsGetAtManagementGroupScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsGetAtManagementGroupScopeResult contains the result from method DeploymentOperations.GetAtManagementGroupScope.

type DeploymentOperationsGetAtScopeOptions

type DeploymentOperationsGetAtScopeOptions struct {
}

DeploymentOperationsGetAtScopeOptions contains the optional parameters for the DeploymentOperations.GetAtScope method.

type DeploymentOperationsGetAtScopeResponse

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

DeploymentOperationsGetAtScopeResponse contains the response from method DeploymentOperations.GetAtScope.

type DeploymentOperationsGetAtScopeResult

type DeploymentOperationsGetAtScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsGetAtScopeResult contains the result from method DeploymentOperations.GetAtScope.

type DeploymentOperationsGetAtSubscriptionScopeOptions

type DeploymentOperationsGetAtSubscriptionScopeOptions struct {
}

DeploymentOperationsGetAtSubscriptionScopeOptions contains the optional parameters for the DeploymentOperations.GetAtSubscriptionScope method.

type DeploymentOperationsGetAtSubscriptionScopeResponse

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

DeploymentOperationsGetAtSubscriptionScopeResponse contains the response from method DeploymentOperations.GetAtSubscriptionScope.

type DeploymentOperationsGetAtSubscriptionScopeResult

type DeploymentOperationsGetAtSubscriptionScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsGetAtSubscriptionScopeResult contains the result from method DeploymentOperations.GetAtSubscriptionScope.

type DeploymentOperationsGetAtTenantScopeOptions

type DeploymentOperationsGetAtTenantScopeOptions struct {
}

DeploymentOperationsGetAtTenantScopeOptions contains the optional parameters for the DeploymentOperations.GetAtTenantScope method.

type DeploymentOperationsGetAtTenantScopeResponse

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

DeploymentOperationsGetAtTenantScopeResponse contains the response from method DeploymentOperations.GetAtTenantScope.

type DeploymentOperationsGetAtTenantScopeResult

type DeploymentOperationsGetAtTenantScopeResult struct {
	DeploymentOperation
}

DeploymentOperationsGetAtTenantScopeResult contains the result from method DeploymentOperations.GetAtTenantScope.

type DeploymentOperationsGetOptions

type DeploymentOperationsGetOptions struct {
}

DeploymentOperationsGetOptions contains the optional parameters for the DeploymentOperations.Get method.

type DeploymentOperationsGetResponse

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

DeploymentOperationsGetResponse contains the response from method DeploymentOperations.Get.

type DeploymentOperationsGetResult

type DeploymentOperationsGetResult struct {
	DeploymentOperation
}

DeploymentOperationsGetResult contains the result from method DeploymentOperations.Get.

type DeploymentOperationsListAtManagementGroupScopeOptions

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

DeploymentOperationsListAtManagementGroupScopeOptions contains the optional parameters for the DeploymentOperations.ListAtManagementGroupScope method.

type DeploymentOperationsListAtManagementGroupScopePager

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

DeploymentOperationsListAtManagementGroupScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsListAtManagementGroupScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentOperationsListAtManagementGroupScopePager) NextPage

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

func (*DeploymentOperationsListAtManagementGroupScopePager) PageResponse

PageResponse returns the current DeploymentOperationsListAtManagementGroupScopeResponse page.

type DeploymentOperationsListAtManagementGroupScopeResponse

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

DeploymentOperationsListAtManagementGroupScopeResponse contains the response from method DeploymentOperations.ListAtManagementGroupScope.

type DeploymentOperationsListAtManagementGroupScopeResult

type DeploymentOperationsListAtManagementGroupScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsListAtManagementGroupScopeResult contains the result from method DeploymentOperations.ListAtManagementGroupScope.

type DeploymentOperationsListAtScopeOptions

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

DeploymentOperationsListAtScopeOptions contains the optional parameters for the DeploymentOperations.ListAtScope method.

type DeploymentOperationsListAtScopePager

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

DeploymentOperationsListAtScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsListAtScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentOperationsListAtScopePager) NextPage

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

func (*DeploymentOperationsListAtScopePager) PageResponse

PageResponse returns the current DeploymentOperationsListAtScopeResponse page.

type DeploymentOperationsListAtScopeResponse

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

DeploymentOperationsListAtScopeResponse contains the response from method DeploymentOperations.ListAtScope.

type DeploymentOperationsListAtScopeResult

type DeploymentOperationsListAtScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsListAtScopeResult contains the result from method DeploymentOperations.ListAtScope.

type DeploymentOperationsListAtSubscriptionScopeOptions

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

DeploymentOperationsListAtSubscriptionScopeOptions contains the optional parameters for the DeploymentOperations.ListAtSubscriptionScope method.

type DeploymentOperationsListAtSubscriptionScopePager

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

DeploymentOperationsListAtSubscriptionScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsListAtSubscriptionScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentOperationsListAtSubscriptionScopePager) NextPage

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

func (*DeploymentOperationsListAtSubscriptionScopePager) PageResponse

PageResponse returns the current DeploymentOperationsListAtSubscriptionScopeResponse page.

type DeploymentOperationsListAtSubscriptionScopeResponse

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

DeploymentOperationsListAtSubscriptionScopeResponse contains the response from method DeploymentOperations.ListAtSubscriptionScope.

type DeploymentOperationsListAtSubscriptionScopeResult

type DeploymentOperationsListAtSubscriptionScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsListAtSubscriptionScopeResult contains the result from method DeploymentOperations.ListAtSubscriptionScope.

type DeploymentOperationsListAtTenantScopeOptions

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

DeploymentOperationsListAtTenantScopeOptions contains the optional parameters for the DeploymentOperations.ListAtTenantScope method.

type DeploymentOperationsListAtTenantScopePager

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

DeploymentOperationsListAtTenantScopePager provides operations for iterating over paged responses.

func (*DeploymentOperationsListAtTenantScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentOperationsListAtTenantScopePager) NextPage

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

func (*DeploymentOperationsListAtTenantScopePager) PageResponse

PageResponse returns the current DeploymentOperationsListAtTenantScopeResponse page.

type DeploymentOperationsListAtTenantScopeResponse

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

DeploymentOperationsListAtTenantScopeResponse contains the response from method DeploymentOperations.ListAtTenantScope.

type DeploymentOperationsListAtTenantScopeResult

type DeploymentOperationsListAtTenantScopeResult struct {
	DeploymentOperationsListResult
}

DeploymentOperationsListAtTenantScopeResult contains the result from method DeploymentOperations.ListAtTenantScope.

type DeploymentOperationsListOptions

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

DeploymentOperationsListOptions contains the optional parameters for the DeploymentOperations.List method.

type DeploymentOperationsListPager

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

DeploymentOperationsListPager provides operations for iterating over paged responses.

func (*DeploymentOperationsListPager) Err

Err returns the last error encountered while paging.

func (*DeploymentOperationsListPager) NextPage

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

func (*DeploymentOperationsListPager) PageResponse

PageResponse returns the current DeploymentOperationsListResponse page.

type DeploymentOperationsListResponse

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

DeploymentOperationsListResponse contains the response from method DeploymentOperations.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 DeploymentOperationsListResultEnvelope

type DeploymentOperationsListResultEnvelope struct {
	DeploymentOperationsListResult
}

DeploymentOperationsListResultEnvelope contains the result from method DeploymentOperations.List.

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 {
	DeploymentProperties
	// 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 DeploymentsBeginCreateOrUpdateAtManagementGroupScopeOptions

type DeploymentsBeginCreateOrUpdateAtManagementGroupScopeOptions struct {
}

DeploymentsBeginCreateOrUpdateAtManagementGroupScopeOptions contains the optional parameters for the Deployments.BeginCreateOrUpdateAtManagementGroupScope method.

type DeploymentsBeginCreateOrUpdateAtScopeOptions

type DeploymentsBeginCreateOrUpdateAtScopeOptions struct {
}

DeploymentsBeginCreateOrUpdateAtScopeOptions contains the optional parameters for the Deployments.BeginCreateOrUpdateAtScope method.

type DeploymentsBeginCreateOrUpdateAtSubscriptionScopeOptions

type DeploymentsBeginCreateOrUpdateAtSubscriptionScopeOptions struct {
}

DeploymentsBeginCreateOrUpdateAtSubscriptionScopeOptions contains the optional parameters for the Deployments.BeginCreateOrUpdateAtSubscriptionScope method.

type DeploymentsBeginCreateOrUpdateAtTenantScopeOptions

type DeploymentsBeginCreateOrUpdateAtTenantScopeOptions struct {
}

DeploymentsBeginCreateOrUpdateAtTenantScopeOptions contains the optional parameters for the Deployments.BeginCreateOrUpdateAtTenantScope method.

type DeploymentsBeginCreateOrUpdateOptions

type DeploymentsBeginCreateOrUpdateOptions struct {
}

DeploymentsBeginCreateOrUpdateOptions contains the optional parameters for the Deployments.BeginCreateOrUpdate method.

type DeploymentsBeginDeleteAtManagementGroupScopeOptions

type DeploymentsBeginDeleteAtManagementGroupScopeOptions struct {
}

DeploymentsBeginDeleteAtManagementGroupScopeOptions contains the optional parameters for the Deployments.BeginDeleteAtManagementGroupScope method.

type DeploymentsBeginDeleteAtScopeOptions

type DeploymentsBeginDeleteAtScopeOptions struct {
}

DeploymentsBeginDeleteAtScopeOptions contains the optional parameters for the Deployments.BeginDeleteAtScope method.

type DeploymentsBeginDeleteAtSubscriptionScopeOptions

type DeploymentsBeginDeleteAtSubscriptionScopeOptions struct {
}

DeploymentsBeginDeleteAtSubscriptionScopeOptions contains the optional parameters for the Deployments.BeginDeleteAtSubscriptionScope method.

type DeploymentsBeginDeleteAtTenantScopeOptions

type DeploymentsBeginDeleteAtTenantScopeOptions struct {
}

DeploymentsBeginDeleteAtTenantScopeOptions contains the optional parameters for the Deployments.BeginDeleteAtTenantScope method.

type DeploymentsBeginDeleteOptions

type DeploymentsBeginDeleteOptions struct {
}

DeploymentsBeginDeleteOptions contains the optional parameters for the Deployments.BeginDelete method.

type DeploymentsBeginValidateAtManagementGroupScopeOptions

type DeploymentsBeginValidateAtManagementGroupScopeOptions struct {
}

DeploymentsBeginValidateAtManagementGroupScopeOptions contains the optional parameters for the Deployments.BeginValidateAtManagementGroupScope method.

type DeploymentsBeginValidateAtScopeOptions

type DeploymentsBeginValidateAtScopeOptions struct {
}

DeploymentsBeginValidateAtScopeOptions contains the optional parameters for the Deployments.BeginValidateAtScope method.

type DeploymentsBeginValidateAtSubscriptionScopeOptions

type DeploymentsBeginValidateAtSubscriptionScopeOptions struct {
}

DeploymentsBeginValidateAtSubscriptionScopeOptions contains the optional parameters for the Deployments.BeginValidateAtSubscriptionScope method.

type DeploymentsBeginValidateAtTenantScopeOptions

type DeploymentsBeginValidateAtTenantScopeOptions struct {
}

DeploymentsBeginValidateAtTenantScopeOptions contains the optional parameters for the Deployments.BeginValidateAtTenantScope method.

type DeploymentsBeginValidateOptions

type DeploymentsBeginValidateOptions struct {
}

DeploymentsBeginValidateOptions contains the optional parameters for the Deployments.BeginValidate method.

type DeploymentsBeginWhatIfAtManagementGroupScopeOptions

type DeploymentsBeginWhatIfAtManagementGroupScopeOptions struct {
}

DeploymentsBeginWhatIfAtManagementGroupScopeOptions contains the optional parameters for the Deployments.BeginWhatIfAtManagementGroupScope method.

type DeploymentsBeginWhatIfAtSubscriptionScopeOptions

type DeploymentsBeginWhatIfAtSubscriptionScopeOptions struct {
}

DeploymentsBeginWhatIfAtSubscriptionScopeOptions contains the optional parameters for the Deployments.BeginWhatIfAtSubscriptionScope method.

type DeploymentsBeginWhatIfAtTenantScopeOptions

type DeploymentsBeginWhatIfAtTenantScopeOptions struct {
}

DeploymentsBeginWhatIfAtTenantScopeOptions contains the optional parameters for the Deployments.BeginWhatIfAtTenantScope method.

type DeploymentsBeginWhatIfOptions

type DeploymentsBeginWhatIfOptions struct {
}

DeploymentsBeginWhatIfOptions contains the optional parameters for the Deployments.BeginWhatIf method.

type DeploymentsCalculateTemplateHashOptions

type DeploymentsCalculateTemplateHashOptions struct {
}

DeploymentsCalculateTemplateHashOptions contains the optional parameters for the Deployments.CalculateTemplateHash method.

type DeploymentsCalculateTemplateHashResponse

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

DeploymentsCalculateTemplateHashResponse contains the response from method Deployments.CalculateTemplateHash.

type DeploymentsCalculateTemplateHashResult

type DeploymentsCalculateTemplateHashResult struct {
	TemplateHashResult
}

DeploymentsCalculateTemplateHashResult contains the result from method Deployments.CalculateTemplateHash.

type DeploymentsCancelAtManagementGroupScopeOptions

type DeploymentsCancelAtManagementGroupScopeOptions struct {
}

DeploymentsCancelAtManagementGroupScopeOptions contains the optional parameters for the Deployments.CancelAtManagementGroupScope method.

type DeploymentsCancelAtManagementGroupScopeResponse

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

DeploymentsCancelAtManagementGroupScopeResponse contains the response from method Deployments.CancelAtManagementGroupScope.

type DeploymentsCancelAtScopeOptions

type DeploymentsCancelAtScopeOptions struct {
}

DeploymentsCancelAtScopeOptions contains the optional parameters for the Deployments.CancelAtScope method.

type DeploymentsCancelAtScopeResponse

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

DeploymentsCancelAtScopeResponse contains the response from method Deployments.CancelAtScope.

type DeploymentsCancelAtSubscriptionScopeOptions

type DeploymentsCancelAtSubscriptionScopeOptions struct {
}

DeploymentsCancelAtSubscriptionScopeOptions contains the optional parameters for the Deployments.CancelAtSubscriptionScope method.

type DeploymentsCancelAtSubscriptionScopeResponse

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

DeploymentsCancelAtSubscriptionScopeResponse contains the response from method Deployments.CancelAtSubscriptionScope.

type DeploymentsCancelAtTenantScopeOptions

type DeploymentsCancelAtTenantScopeOptions struct {
}

DeploymentsCancelAtTenantScopeOptions contains the optional parameters for the Deployments.CancelAtTenantScope method.

type DeploymentsCancelAtTenantScopeResponse

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

DeploymentsCancelAtTenantScopeResponse contains the response from method Deployments.CancelAtTenantScope.

type DeploymentsCancelOptions

type DeploymentsCancelOptions struct {
}

DeploymentsCancelOptions contains the optional parameters for the Deployments.Cancel method.

type DeploymentsCancelResponse

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

DeploymentsCancelResponse contains the response from method Deployments.Cancel.

type DeploymentsCheckExistenceAtManagementGroupScopeOptions

type DeploymentsCheckExistenceAtManagementGroupScopeOptions struct {
}

DeploymentsCheckExistenceAtManagementGroupScopeOptions contains the optional parameters for the Deployments.CheckExistenceAtManagementGroupScope method.

type DeploymentsCheckExistenceAtManagementGroupScopeResponse

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

DeploymentsCheckExistenceAtManagementGroupScopeResponse contains the response from method Deployments.CheckExistenceAtManagementGroupScope.

type DeploymentsCheckExistenceAtManagementGroupScopeResult

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

DeploymentsCheckExistenceAtManagementGroupScopeResult contains the result from method Deployments.CheckExistenceAtManagementGroupScope.

type DeploymentsCheckExistenceAtScopeOptions

type DeploymentsCheckExistenceAtScopeOptions struct {
}

DeploymentsCheckExistenceAtScopeOptions contains the optional parameters for the Deployments.CheckExistenceAtScope method.

type DeploymentsCheckExistenceAtScopeResponse

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

DeploymentsCheckExistenceAtScopeResponse contains the response from method Deployments.CheckExistenceAtScope.

type DeploymentsCheckExistenceAtScopeResult

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

DeploymentsCheckExistenceAtScopeResult contains the result from method Deployments.CheckExistenceAtScope.

type DeploymentsCheckExistenceAtSubscriptionScopeOptions

type DeploymentsCheckExistenceAtSubscriptionScopeOptions struct {
}

DeploymentsCheckExistenceAtSubscriptionScopeOptions contains the optional parameters for the Deployments.CheckExistenceAtSubscriptionScope method.

type DeploymentsCheckExistenceAtSubscriptionScopeResponse

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

DeploymentsCheckExistenceAtSubscriptionScopeResponse contains the response from method Deployments.CheckExistenceAtSubscriptionScope.

type DeploymentsCheckExistenceAtSubscriptionScopeResult

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

DeploymentsCheckExistenceAtSubscriptionScopeResult contains the result from method Deployments.CheckExistenceAtSubscriptionScope.

type DeploymentsCheckExistenceAtTenantScopeOptions

type DeploymentsCheckExistenceAtTenantScopeOptions struct {
}

DeploymentsCheckExistenceAtTenantScopeOptions contains the optional parameters for the Deployments.CheckExistenceAtTenantScope method.

type DeploymentsCheckExistenceAtTenantScopeResponse

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

DeploymentsCheckExistenceAtTenantScopeResponse contains the response from method Deployments.CheckExistenceAtTenantScope.

type DeploymentsCheckExistenceAtTenantScopeResult

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

DeploymentsCheckExistenceAtTenantScopeResult contains the result from method Deployments.CheckExistenceAtTenantScope.

type DeploymentsCheckExistenceOptions

type DeploymentsCheckExistenceOptions struct {
}

DeploymentsCheckExistenceOptions contains the optional parameters for the Deployments.CheckExistence method.

type DeploymentsCheckExistenceResponse

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

DeploymentsCheckExistenceResponse contains the response from method Deployments.CheckExistence.

type DeploymentsCheckExistenceResult

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

DeploymentsCheckExistenceResult contains the result from method Deployments.CheckExistence.

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.

func (*DeploymentsClient) BeginCreateOrUpdate

func (client *DeploymentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment, options *DeploymentsBeginCreateOrUpdateOptions) (DeploymentsCreateOrUpdatePollerResponse, error)

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

func (*DeploymentsClient) BeginCreateOrUpdateAtManagementGroupScope

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

func (*DeploymentsClient) BeginCreateOrUpdateAtScope

func (client *DeploymentsClient) BeginCreateOrUpdateAtScope(ctx context.Context, scope string, deploymentName string, parameters Deployment, options *DeploymentsBeginCreateOrUpdateAtScopeOptions) (DeploymentsCreateOrUpdateAtScopePollerResponse, error)

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

func (*DeploymentsClient) BeginCreateOrUpdateAtSubscriptionScope

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

func (*DeploymentsClient) BeginCreateOrUpdateAtTenantScope

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

func (*DeploymentsClient) BeginDelete

func (client *DeploymentsClient) BeginDelete(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsBeginDeleteOptions) (DeploymentsDeletePollerResponse, 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 the *CloudError error type.

func (*DeploymentsClient) BeginDeleteAtManagementGroupScope

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 the *CloudError error type.

func (*DeploymentsClient) BeginDeleteAtScope

func (client *DeploymentsClient) BeginDeleteAtScope(ctx context.Context, scope string, deploymentName string, options *DeploymentsBeginDeleteAtScopeOptions) (DeploymentsDeleteAtScopePollerResponse, 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 the *CloudError error type.

func (*DeploymentsClient) BeginDeleteAtSubscriptionScope

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 the *CloudError error type.

func (*DeploymentsClient) BeginDeleteAtTenantScope

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 the *CloudError error type.

func (*DeploymentsClient) BeginValidate

func (client *DeploymentsClient) BeginValidate(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment, options *DeploymentsBeginValidateOptions) (DeploymentsValidatePollerResponse, error)

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

func (*DeploymentsClient) BeginValidateAtManagementGroupScope

func (client *DeploymentsClient) BeginValidateAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, parameters ScopedDeployment, options *DeploymentsBeginValidateAtManagementGroupScopeOptions) (DeploymentsValidateAtManagementGroupScopePollerResponse, error)

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

func (*DeploymentsClient) BeginValidateAtScope

func (client *DeploymentsClient) BeginValidateAtScope(ctx context.Context, scope string, deploymentName string, parameters Deployment, options *DeploymentsBeginValidateAtScopeOptions) (DeploymentsValidateAtScopePollerResponse, error)

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

func (*DeploymentsClient) BeginValidateAtSubscriptionScope

func (client *DeploymentsClient) BeginValidateAtSubscriptionScope(ctx context.Context, deploymentName string, parameters Deployment, options *DeploymentsBeginValidateAtSubscriptionScopeOptions) (DeploymentsValidateAtSubscriptionScopePollerResponse, error)

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

func (*DeploymentsClient) BeginValidateAtTenantScope

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

func (*DeploymentsClient) BeginWhatIf

func (client *DeploymentsClient) BeginWhatIf(ctx context.Context, resourceGroupName string, deploymentName string, parameters DeploymentWhatIf, options *DeploymentsBeginWhatIfOptions) (DeploymentsWhatIfPollerResponse, 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 the *CloudError error type.

func (*DeploymentsClient) BeginWhatIfAtManagementGroupScope

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 the *CloudError error type.

func (*DeploymentsClient) BeginWhatIfAtSubscriptionScope

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

func (*DeploymentsClient) BeginWhatIfAtTenantScope

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 the *CloudError error type.

func (*DeploymentsClient) CalculateTemplateHash

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

CalculateTemplateHash - Calculate the hash of the given template. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) Cancel

func (client *DeploymentsClient) Cancel(ctx context.Context, resourceGroupName string, deploymentName string, options *DeploymentsCancelOptions) (DeploymentsCancelResponse, 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 the *CloudError error type.

func (*DeploymentsClient) CancelAtManagementGroupScope

func (client *DeploymentsClient) CancelAtManagementGroupScope(ctx context.Context, groupID string, deploymentName string, options *DeploymentsCancelAtManagementGroupScopeOptions) (DeploymentsCancelAtManagementGroupScopeResponse, 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 the *CloudError error type.

func (*DeploymentsClient) CancelAtScope

func (client *DeploymentsClient) CancelAtScope(ctx context.Context, scope string, deploymentName string, options *DeploymentsCancelAtScopeOptions) (DeploymentsCancelAtScopeResponse, 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 the *CloudError error type.

func (*DeploymentsClient) CancelAtSubscriptionScope

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 the *CloudError error type.

func (*DeploymentsClient) CancelAtTenantScope

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 the *CloudError error type.

func (*DeploymentsClient) CheckExistence

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

CheckExistence - Checks whether the deployment exists. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) CheckExistenceAtManagementGroupScope

CheckExistenceAtManagementGroupScope - Checks whether the deployment exists. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) CheckExistenceAtScope

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

CheckExistenceAtScope - Checks whether the deployment exists. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) CheckExistenceAtSubscriptionScope

CheckExistenceAtSubscriptionScope - Checks whether the deployment exists. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) CheckExistenceAtTenantScope

CheckExistenceAtTenantScope - Checks whether the deployment exists. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ExportTemplate

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

ExportTemplate - Exports the template used for specified deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ExportTemplateAtManagementGroupScope

ExportTemplateAtManagementGroupScope - Exports the template used for specified deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ExportTemplateAtScope

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

ExportTemplateAtScope - Exports the template used for specified deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ExportTemplateAtSubscriptionScope

ExportTemplateAtSubscriptionScope - Exports the template used for specified deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ExportTemplateAtTenantScope

ExportTemplateAtTenantScope - Exports the template used for specified deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) Get

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

Get - Gets a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) GetAtManagementGroupScope

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

GetAtManagementGroupScope - Gets a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) GetAtScope

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

GetAtScope - Gets a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) GetAtSubscriptionScope

GetAtSubscriptionScope - Gets a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) GetAtTenantScope

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

GetAtTenantScope - Gets a deployment. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ListAtManagementGroupScope

ListAtManagementGroupScope - Get all the deployments for a management group. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ListAtScope

ListAtScope - Get all the deployments at the given scope. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ListAtSubscriptionScope

ListAtSubscriptionScope - Get all the deployments for a subscription. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ListAtTenantScope

ListAtTenantScope - Get all the deployments at the tenant scope. If the operation fails it returns the *CloudError error type.

func (*DeploymentsClient) ListByResourceGroup

func (client *DeploymentsClient) ListByResourceGroup(resourceGroupName string, options *DeploymentsListByResourceGroupOptions) *DeploymentsListByResourceGroupPager

ListByResourceGroup - Get all the deployments for a resource group. If the operation fails it returns the *CloudError error type.

type DeploymentsCreateOrUpdateAtManagementGroupScopePoller

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

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

func (*DeploymentsCreateOrUpdateAtManagementGroupScopePoller) Done

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

func (*DeploymentsCreateOrUpdateAtManagementGroupScopePoller) FinalResponse

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 DeploymentsCreateOrUpdateAtManagementGroupScopeResponse will be returned.

func (*DeploymentsCreateOrUpdateAtManagementGroupScopePoller) Poll

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 (*DeploymentsCreateOrUpdateAtManagementGroupScopePoller) ResumeToken

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 DeploymentsCreateOrUpdateAtManagementGroupScopePollerResponse

type DeploymentsCreateOrUpdateAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsCreateOrUpdateAtManagementGroupScopePoller

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

DeploymentsCreateOrUpdateAtManagementGroupScopePollerResponse contains the response from method Deployments.CreateOrUpdateAtManagementGroupScope.

func (DeploymentsCreateOrUpdateAtManagementGroupScopePollerResponse) PollUntilDone

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 (*DeploymentsCreateOrUpdateAtManagementGroupScopePollerResponse) Resume

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

type DeploymentsCreateOrUpdateAtManagementGroupScopeResponse

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

DeploymentsCreateOrUpdateAtManagementGroupScopeResponse contains the response from method Deployments.CreateOrUpdateAtManagementGroupScope.

type DeploymentsCreateOrUpdateAtManagementGroupScopeResult

type DeploymentsCreateOrUpdateAtManagementGroupScopeResult struct {
	DeploymentExtended
}

DeploymentsCreateOrUpdateAtManagementGroupScopeResult contains the result from method Deployments.CreateOrUpdateAtManagementGroupScope.

type DeploymentsCreateOrUpdateAtScopePoller

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

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

func (*DeploymentsCreateOrUpdateAtScopePoller) Done

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

func (*DeploymentsCreateOrUpdateAtScopePoller) FinalResponse

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 DeploymentsCreateOrUpdateAtScopeResponse will be returned.

func (*DeploymentsCreateOrUpdateAtScopePoller) Poll

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 (*DeploymentsCreateOrUpdateAtScopePoller) ResumeToken

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 DeploymentsCreateOrUpdateAtScopePollerResponse

type DeploymentsCreateOrUpdateAtScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsCreateOrUpdateAtScopePoller

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

DeploymentsCreateOrUpdateAtScopePollerResponse contains the response from method Deployments.CreateOrUpdateAtScope.

func (DeploymentsCreateOrUpdateAtScopePollerResponse) PollUntilDone

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 (*DeploymentsCreateOrUpdateAtScopePollerResponse) Resume

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

type DeploymentsCreateOrUpdateAtScopeResponse

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

DeploymentsCreateOrUpdateAtScopeResponse contains the response from method Deployments.CreateOrUpdateAtScope.

type DeploymentsCreateOrUpdateAtScopeResult

type DeploymentsCreateOrUpdateAtScopeResult struct {
	DeploymentExtended
}

DeploymentsCreateOrUpdateAtScopeResult contains the result from method Deployments.CreateOrUpdateAtScope.

type DeploymentsCreateOrUpdateAtSubscriptionScopePoller

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

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

func (*DeploymentsCreateOrUpdateAtSubscriptionScopePoller) Done

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

func (*DeploymentsCreateOrUpdateAtSubscriptionScopePoller) FinalResponse

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 DeploymentsCreateOrUpdateAtSubscriptionScopeResponse will be returned.

func (*DeploymentsCreateOrUpdateAtSubscriptionScopePoller) Poll

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 (*DeploymentsCreateOrUpdateAtSubscriptionScopePoller) ResumeToken

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 DeploymentsCreateOrUpdateAtSubscriptionScopePollerResponse

type DeploymentsCreateOrUpdateAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsCreateOrUpdateAtSubscriptionScopePoller

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

DeploymentsCreateOrUpdateAtSubscriptionScopePollerResponse contains the response from method Deployments.CreateOrUpdateAtSubscriptionScope.

func (DeploymentsCreateOrUpdateAtSubscriptionScopePollerResponse) PollUntilDone

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 (*DeploymentsCreateOrUpdateAtSubscriptionScopePollerResponse) Resume

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

type DeploymentsCreateOrUpdateAtSubscriptionScopeResponse

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

DeploymentsCreateOrUpdateAtSubscriptionScopeResponse contains the response from method Deployments.CreateOrUpdateAtSubscriptionScope.

type DeploymentsCreateOrUpdateAtSubscriptionScopeResult

type DeploymentsCreateOrUpdateAtSubscriptionScopeResult struct {
	DeploymentExtended
}

DeploymentsCreateOrUpdateAtSubscriptionScopeResult contains the result from method Deployments.CreateOrUpdateAtSubscriptionScope.

type DeploymentsCreateOrUpdateAtTenantScopePoller

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

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

func (*DeploymentsCreateOrUpdateAtTenantScopePoller) Done

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

func (*DeploymentsCreateOrUpdateAtTenantScopePoller) FinalResponse

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 DeploymentsCreateOrUpdateAtTenantScopeResponse will be returned.

func (*DeploymentsCreateOrUpdateAtTenantScopePoller) Poll

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 (*DeploymentsCreateOrUpdateAtTenantScopePoller) ResumeToken

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 DeploymentsCreateOrUpdateAtTenantScopePollerResponse

type DeploymentsCreateOrUpdateAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsCreateOrUpdateAtTenantScopePoller

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

DeploymentsCreateOrUpdateAtTenantScopePollerResponse contains the response from method Deployments.CreateOrUpdateAtTenantScope.

func (DeploymentsCreateOrUpdateAtTenantScopePollerResponse) PollUntilDone

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 (*DeploymentsCreateOrUpdateAtTenantScopePollerResponse) Resume

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

type DeploymentsCreateOrUpdateAtTenantScopeResponse

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

DeploymentsCreateOrUpdateAtTenantScopeResponse contains the response from method Deployments.CreateOrUpdateAtTenantScope.

type DeploymentsCreateOrUpdateAtTenantScopeResult

type DeploymentsCreateOrUpdateAtTenantScopeResult struct {
	DeploymentExtended
}

DeploymentsCreateOrUpdateAtTenantScopeResult contains the result from method Deployments.CreateOrUpdateAtTenantScope.

type DeploymentsCreateOrUpdatePoller

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

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

func (*DeploymentsCreateOrUpdatePoller) Done

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

func (*DeploymentsCreateOrUpdatePoller) FinalResponse

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 DeploymentsCreateOrUpdateResponse will be returned.

func (*DeploymentsCreateOrUpdatePoller) Poll

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 (*DeploymentsCreateOrUpdatePoller) ResumeToken

func (p *DeploymentsCreateOrUpdatePoller) 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 DeploymentsCreateOrUpdatePollerResponse

type DeploymentsCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsCreateOrUpdatePoller

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

DeploymentsCreateOrUpdatePollerResponse contains the response from method Deployments.CreateOrUpdate.

func (DeploymentsCreateOrUpdatePollerResponse) PollUntilDone

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 (*DeploymentsCreateOrUpdatePollerResponse) Resume

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

type DeploymentsCreateOrUpdateResponse

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

DeploymentsCreateOrUpdateResponse contains the response from method Deployments.CreateOrUpdate.

type DeploymentsCreateOrUpdateResult

type DeploymentsCreateOrUpdateResult struct {
	DeploymentExtended
}

DeploymentsCreateOrUpdateResult contains the result from method Deployments.CreateOrUpdate.

type DeploymentsDeleteAtManagementGroupScopePoller

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

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

func (*DeploymentsDeleteAtManagementGroupScopePoller) Done

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

func (*DeploymentsDeleteAtManagementGroupScopePoller) FinalResponse

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 DeploymentsDeleteAtManagementGroupScopeResponse will be returned.

func (*DeploymentsDeleteAtManagementGroupScopePoller) Poll

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 (*DeploymentsDeleteAtManagementGroupScopePoller) ResumeToken

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 DeploymentsDeleteAtManagementGroupScopePollerResponse

type DeploymentsDeleteAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsDeleteAtManagementGroupScopePoller

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

DeploymentsDeleteAtManagementGroupScopePollerResponse contains the response from method Deployments.DeleteAtManagementGroupScope.

func (DeploymentsDeleteAtManagementGroupScopePollerResponse) PollUntilDone

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 (*DeploymentsDeleteAtManagementGroupScopePollerResponse) Resume

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

type DeploymentsDeleteAtManagementGroupScopeResponse

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

DeploymentsDeleteAtManagementGroupScopeResponse contains the response from method Deployments.DeleteAtManagementGroupScope.

type DeploymentsDeleteAtScopePoller

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

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

func (*DeploymentsDeleteAtScopePoller) Done

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

func (*DeploymentsDeleteAtScopePoller) FinalResponse

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 DeploymentsDeleteAtScopeResponse will be returned.

func (*DeploymentsDeleteAtScopePoller) Poll

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 (*DeploymentsDeleteAtScopePoller) ResumeToken

func (p *DeploymentsDeleteAtScopePoller) 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 DeploymentsDeleteAtScopePollerResponse

type DeploymentsDeleteAtScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsDeleteAtScopePoller

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

DeploymentsDeleteAtScopePollerResponse contains the response from method Deployments.DeleteAtScope.

func (DeploymentsDeleteAtScopePollerResponse) PollUntilDone

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 (*DeploymentsDeleteAtScopePollerResponse) Resume

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

type DeploymentsDeleteAtScopeResponse

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

DeploymentsDeleteAtScopeResponse contains the response from method Deployments.DeleteAtScope.

type DeploymentsDeleteAtSubscriptionScopePoller

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

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

func (*DeploymentsDeleteAtSubscriptionScopePoller) Done

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

func (*DeploymentsDeleteAtSubscriptionScopePoller) FinalResponse

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 DeploymentsDeleteAtSubscriptionScopeResponse will be returned.

func (*DeploymentsDeleteAtSubscriptionScopePoller) Poll

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 (*DeploymentsDeleteAtSubscriptionScopePoller) ResumeToken

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 DeploymentsDeleteAtSubscriptionScopePollerResponse

type DeploymentsDeleteAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsDeleteAtSubscriptionScopePoller

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

DeploymentsDeleteAtSubscriptionScopePollerResponse contains the response from method Deployments.DeleteAtSubscriptionScope.

func (DeploymentsDeleteAtSubscriptionScopePollerResponse) PollUntilDone

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 (*DeploymentsDeleteAtSubscriptionScopePollerResponse) Resume

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

type DeploymentsDeleteAtSubscriptionScopeResponse

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

DeploymentsDeleteAtSubscriptionScopeResponse contains the response from method Deployments.DeleteAtSubscriptionScope.

type DeploymentsDeleteAtTenantScopePoller

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

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

func (*DeploymentsDeleteAtTenantScopePoller) Done

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

func (*DeploymentsDeleteAtTenantScopePoller) FinalResponse

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 DeploymentsDeleteAtTenantScopeResponse will be returned.

func (*DeploymentsDeleteAtTenantScopePoller) Poll

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 (*DeploymentsDeleteAtTenantScopePoller) ResumeToken

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 DeploymentsDeleteAtTenantScopePollerResponse

type DeploymentsDeleteAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsDeleteAtTenantScopePoller

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

DeploymentsDeleteAtTenantScopePollerResponse contains the response from method Deployments.DeleteAtTenantScope.

func (DeploymentsDeleteAtTenantScopePollerResponse) PollUntilDone

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 (*DeploymentsDeleteAtTenantScopePollerResponse) Resume

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

type DeploymentsDeleteAtTenantScopeResponse

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

DeploymentsDeleteAtTenantScopeResponse contains the response from method Deployments.DeleteAtTenantScope.

type DeploymentsDeletePoller

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

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

func (*DeploymentsDeletePoller) Done

func (p *DeploymentsDeletePoller) Done() bool

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

func (*DeploymentsDeletePoller) FinalResponse

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 DeploymentsDeleteResponse will be returned.

func (*DeploymentsDeletePoller) Poll

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 (*DeploymentsDeletePoller) ResumeToken

func (p *DeploymentsDeletePoller) 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 DeploymentsDeletePollerResponse

type DeploymentsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsDeletePoller

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

DeploymentsDeletePollerResponse contains the response from method Deployments.Delete.

func (DeploymentsDeletePollerResponse) PollUntilDone

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 (*DeploymentsDeletePollerResponse) Resume

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

type DeploymentsDeleteResponse

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

DeploymentsDeleteResponse contains the response from method Deployments.Delete.

type DeploymentsExportTemplateAtManagementGroupScopeOptions

type DeploymentsExportTemplateAtManagementGroupScopeOptions struct {
}

DeploymentsExportTemplateAtManagementGroupScopeOptions contains the optional parameters for the Deployments.ExportTemplateAtManagementGroupScope method.

type DeploymentsExportTemplateAtManagementGroupScopeResponse

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

DeploymentsExportTemplateAtManagementGroupScopeResponse contains the response from method Deployments.ExportTemplateAtManagementGroupScope.

type DeploymentsExportTemplateAtManagementGroupScopeResult

type DeploymentsExportTemplateAtManagementGroupScopeResult struct {
	DeploymentExportResult
}

DeploymentsExportTemplateAtManagementGroupScopeResult contains the result from method Deployments.ExportTemplateAtManagementGroupScope.

type DeploymentsExportTemplateAtScopeOptions

type DeploymentsExportTemplateAtScopeOptions struct {
}

DeploymentsExportTemplateAtScopeOptions contains the optional parameters for the Deployments.ExportTemplateAtScope method.

type DeploymentsExportTemplateAtScopeResponse

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

DeploymentsExportTemplateAtScopeResponse contains the response from method Deployments.ExportTemplateAtScope.

type DeploymentsExportTemplateAtScopeResult

type DeploymentsExportTemplateAtScopeResult struct {
	DeploymentExportResult
}

DeploymentsExportTemplateAtScopeResult contains the result from method Deployments.ExportTemplateAtScope.

type DeploymentsExportTemplateAtSubscriptionScopeOptions

type DeploymentsExportTemplateAtSubscriptionScopeOptions struct {
}

DeploymentsExportTemplateAtSubscriptionScopeOptions contains the optional parameters for the Deployments.ExportTemplateAtSubscriptionScope method.

type DeploymentsExportTemplateAtSubscriptionScopeResponse

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

DeploymentsExportTemplateAtSubscriptionScopeResponse contains the response from method Deployments.ExportTemplateAtSubscriptionScope.

type DeploymentsExportTemplateAtSubscriptionScopeResult

type DeploymentsExportTemplateAtSubscriptionScopeResult struct {
	DeploymentExportResult
}

DeploymentsExportTemplateAtSubscriptionScopeResult contains the result from method Deployments.ExportTemplateAtSubscriptionScope.

type DeploymentsExportTemplateAtTenantScopeOptions

type DeploymentsExportTemplateAtTenantScopeOptions struct {
}

DeploymentsExportTemplateAtTenantScopeOptions contains the optional parameters for the Deployments.ExportTemplateAtTenantScope method.

type DeploymentsExportTemplateAtTenantScopeResponse

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

DeploymentsExportTemplateAtTenantScopeResponse contains the response from method Deployments.ExportTemplateAtTenantScope.

type DeploymentsExportTemplateAtTenantScopeResult

type DeploymentsExportTemplateAtTenantScopeResult struct {
	DeploymentExportResult
}

DeploymentsExportTemplateAtTenantScopeResult contains the result from method Deployments.ExportTemplateAtTenantScope.

type DeploymentsExportTemplateOptions

type DeploymentsExportTemplateOptions struct {
}

DeploymentsExportTemplateOptions contains the optional parameters for the Deployments.ExportTemplate method.

type DeploymentsExportTemplateResponse

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

DeploymentsExportTemplateResponse contains the response from method Deployments.ExportTemplate.

type DeploymentsExportTemplateResult

type DeploymentsExportTemplateResult struct {
	DeploymentExportResult
}

DeploymentsExportTemplateResult contains the result from method Deployments.ExportTemplate.

type DeploymentsGetAtManagementGroupScopeOptions

type DeploymentsGetAtManagementGroupScopeOptions struct {
}

DeploymentsGetAtManagementGroupScopeOptions contains the optional parameters for the Deployments.GetAtManagementGroupScope method.

type DeploymentsGetAtManagementGroupScopeResponse

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

DeploymentsGetAtManagementGroupScopeResponse contains the response from method Deployments.GetAtManagementGroupScope.

type DeploymentsGetAtManagementGroupScopeResult

type DeploymentsGetAtManagementGroupScopeResult struct {
	DeploymentExtended
}

DeploymentsGetAtManagementGroupScopeResult contains the result from method Deployments.GetAtManagementGroupScope.

type DeploymentsGetAtScopeOptions

type DeploymentsGetAtScopeOptions struct {
}

DeploymentsGetAtScopeOptions contains the optional parameters for the Deployments.GetAtScope method.

type DeploymentsGetAtScopeResponse

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

DeploymentsGetAtScopeResponse contains the response from method Deployments.GetAtScope.

type DeploymentsGetAtScopeResult

type DeploymentsGetAtScopeResult struct {
	DeploymentExtended
}

DeploymentsGetAtScopeResult contains the result from method Deployments.GetAtScope.

type DeploymentsGetAtSubscriptionScopeOptions

type DeploymentsGetAtSubscriptionScopeOptions struct {
}

DeploymentsGetAtSubscriptionScopeOptions contains the optional parameters for the Deployments.GetAtSubscriptionScope method.

type DeploymentsGetAtSubscriptionScopeResponse

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

DeploymentsGetAtSubscriptionScopeResponse contains the response from method Deployments.GetAtSubscriptionScope.

type DeploymentsGetAtSubscriptionScopeResult

type DeploymentsGetAtSubscriptionScopeResult struct {
	DeploymentExtended
}

DeploymentsGetAtSubscriptionScopeResult contains the result from method Deployments.GetAtSubscriptionScope.

type DeploymentsGetAtTenantScopeOptions

type DeploymentsGetAtTenantScopeOptions struct {
}

DeploymentsGetAtTenantScopeOptions contains the optional parameters for the Deployments.GetAtTenantScope method.

type DeploymentsGetAtTenantScopeResponse

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

DeploymentsGetAtTenantScopeResponse contains the response from method Deployments.GetAtTenantScope.

type DeploymentsGetAtTenantScopeResult

type DeploymentsGetAtTenantScopeResult struct {
	DeploymentExtended
}

DeploymentsGetAtTenantScopeResult contains the result from method Deployments.GetAtTenantScope.

type DeploymentsGetOptions

type DeploymentsGetOptions struct {
}

DeploymentsGetOptions contains the optional parameters for the Deployments.Get method.

type DeploymentsGetResponse

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

DeploymentsGetResponse contains the response from method Deployments.Get.

type DeploymentsGetResult

type DeploymentsGetResult struct {
	DeploymentExtended
}

DeploymentsGetResult contains the result from method Deployments.Get.

type DeploymentsListAtManagementGroupScopeOptions

type DeploymentsListAtManagementGroupScopeOptions 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
}

DeploymentsListAtManagementGroupScopeOptions contains the optional parameters for the Deployments.ListAtManagementGroupScope method.

type DeploymentsListAtManagementGroupScopePager

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

DeploymentsListAtManagementGroupScopePager provides operations for iterating over paged responses.

func (*DeploymentsListAtManagementGroupScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentsListAtManagementGroupScopePager) NextPage

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

func (*DeploymentsListAtManagementGroupScopePager) PageResponse

PageResponse returns the current DeploymentsListAtManagementGroupScopeResponse page.

type DeploymentsListAtManagementGroupScopeResponse

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

DeploymentsListAtManagementGroupScopeResponse contains the response from method Deployments.ListAtManagementGroupScope.

type DeploymentsListAtManagementGroupScopeResult

type DeploymentsListAtManagementGroupScopeResult struct {
	DeploymentListResult
}

DeploymentsListAtManagementGroupScopeResult contains the result from method Deployments.ListAtManagementGroupScope.

type DeploymentsListAtScopeOptions

type DeploymentsListAtScopeOptions 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
}

DeploymentsListAtScopeOptions contains the optional parameters for the Deployments.ListAtScope method.

type DeploymentsListAtScopePager

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

DeploymentsListAtScopePager provides operations for iterating over paged responses.

func (*DeploymentsListAtScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentsListAtScopePager) NextPage

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

func (*DeploymentsListAtScopePager) PageResponse

PageResponse returns the current DeploymentsListAtScopeResponse page.

type DeploymentsListAtScopeResponse

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

DeploymentsListAtScopeResponse contains the response from method Deployments.ListAtScope.

type DeploymentsListAtScopeResult

type DeploymentsListAtScopeResult struct {
	DeploymentListResult
}

DeploymentsListAtScopeResult contains the result from method Deployments.ListAtScope.

type DeploymentsListAtSubscriptionScopeOptions

type DeploymentsListAtSubscriptionScopeOptions 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
}

DeploymentsListAtSubscriptionScopeOptions contains the optional parameters for the Deployments.ListAtSubscriptionScope method.

type DeploymentsListAtSubscriptionScopePager

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

DeploymentsListAtSubscriptionScopePager provides operations for iterating over paged responses.

func (*DeploymentsListAtSubscriptionScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentsListAtSubscriptionScopePager) NextPage

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

func (*DeploymentsListAtSubscriptionScopePager) PageResponse

PageResponse returns the current DeploymentsListAtSubscriptionScopeResponse page.

type DeploymentsListAtSubscriptionScopeResponse

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

DeploymentsListAtSubscriptionScopeResponse contains the response from method Deployments.ListAtSubscriptionScope.

type DeploymentsListAtSubscriptionScopeResult

type DeploymentsListAtSubscriptionScopeResult struct {
	DeploymentListResult
}

DeploymentsListAtSubscriptionScopeResult contains the result from method Deployments.ListAtSubscriptionScope.

type DeploymentsListAtTenantScopeOptions

type DeploymentsListAtTenantScopeOptions 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
}

DeploymentsListAtTenantScopeOptions contains the optional parameters for the Deployments.ListAtTenantScope method.

type DeploymentsListAtTenantScopePager

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

DeploymentsListAtTenantScopePager provides operations for iterating over paged responses.

func (*DeploymentsListAtTenantScopePager) Err

Err returns the last error encountered while paging.

func (*DeploymentsListAtTenantScopePager) NextPage

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

func (*DeploymentsListAtTenantScopePager) PageResponse

PageResponse returns the current DeploymentsListAtTenantScopeResponse page.

type DeploymentsListAtTenantScopeResponse

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

DeploymentsListAtTenantScopeResponse contains the response from method Deployments.ListAtTenantScope.

type DeploymentsListAtTenantScopeResult

type DeploymentsListAtTenantScopeResult struct {
	DeploymentListResult
}

DeploymentsListAtTenantScopeResult contains the result from method Deployments.ListAtTenantScope.

type DeploymentsListByResourceGroupOptions

type DeploymentsListByResourceGroupOptions 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
}

DeploymentsListByResourceGroupOptions contains the optional parameters for the Deployments.ListByResourceGroup method.

type DeploymentsListByResourceGroupPager

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

DeploymentsListByResourceGroupPager provides operations for iterating over paged responses.

func (*DeploymentsListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*DeploymentsListByResourceGroupPager) NextPage

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

func (*DeploymentsListByResourceGroupPager) PageResponse

PageResponse returns the current DeploymentsListByResourceGroupResponse page.

type DeploymentsListByResourceGroupResponse

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

DeploymentsListByResourceGroupResponse contains the response from method Deployments.ListByResourceGroup.

type DeploymentsListByResourceGroupResult

type DeploymentsListByResourceGroupResult struct {
	DeploymentListResult
}

DeploymentsListByResourceGroupResult contains the result from method Deployments.ListByResourceGroup.

type DeploymentsValidateAtManagementGroupScopePoller

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

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

func (*DeploymentsValidateAtManagementGroupScopePoller) Done

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

func (*DeploymentsValidateAtManagementGroupScopePoller) FinalResponse

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 DeploymentsValidateAtManagementGroupScopeResponse will be returned.

func (*DeploymentsValidateAtManagementGroupScopePoller) Poll

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 (*DeploymentsValidateAtManagementGroupScopePoller) ResumeToken

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 DeploymentsValidateAtManagementGroupScopePollerResponse

type DeploymentsValidateAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsValidateAtManagementGroupScopePoller

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

DeploymentsValidateAtManagementGroupScopePollerResponse contains the response from method Deployments.ValidateAtManagementGroupScope.

func (DeploymentsValidateAtManagementGroupScopePollerResponse) PollUntilDone

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 (*DeploymentsValidateAtManagementGroupScopePollerResponse) Resume

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

type DeploymentsValidateAtManagementGroupScopeResponse

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

DeploymentsValidateAtManagementGroupScopeResponse contains the response from method Deployments.ValidateAtManagementGroupScope.

type DeploymentsValidateAtManagementGroupScopeResult

type DeploymentsValidateAtManagementGroupScopeResult struct {
	DeploymentValidateResult
}

DeploymentsValidateAtManagementGroupScopeResult contains the result from method Deployments.ValidateAtManagementGroupScope.

type DeploymentsValidateAtScopePoller

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

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

func (*DeploymentsValidateAtScopePoller) Done

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

func (*DeploymentsValidateAtScopePoller) FinalResponse

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 DeploymentsValidateAtScopeResponse will be returned.

func (*DeploymentsValidateAtScopePoller) Poll

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 (*DeploymentsValidateAtScopePoller) ResumeToken

func (p *DeploymentsValidateAtScopePoller) 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 DeploymentsValidateAtScopePollerResponse

type DeploymentsValidateAtScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsValidateAtScopePoller

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

DeploymentsValidateAtScopePollerResponse contains the response from method Deployments.ValidateAtScope.

func (DeploymentsValidateAtScopePollerResponse) PollUntilDone

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 (*DeploymentsValidateAtScopePollerResponse) Resume

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

type DeploymentsValidateAtScopeResponse

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

DeploymentsValidateAtScopeResponse contains the response from method Deployments.ValidateAtScope.

type DeploymentsValidateAtScopeResult

type DeploymentsValidateAtScopeResult struct {
	DeploymentValidateResult
}

DeploymentsValidateAtScopeResult contains the result from method Deployments.ValidateAtScope.

type DeploymentsValidateAtSubscriptionScopePoller

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

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

func (*DeploymentsValidateAtSubscriptionScopePoller) Done

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

func (*DeploymentsValidateAtSubscriptionScopePoller) FinalResponse

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 DeploymentsValidateAtSubscriptionScopeResponse will be returned.

func (*DeploymentsValidateAtSubscriptionScopePoller) Poll

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 (*DeploymentsValidateAtSubscriptionScopePoller) ResumeToken

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 DeploymentsValidateAtSubscriptionScopePollerResponse

type DeploymentsValidateAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsValidateAtSubscriptionScopePoller

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

DeploymentsValidateAtSubscriptionScopePollerResponse contains the response from method Deployments.ValidateAtSubscriptionScope.

func (DeploymentsValidateAtSubscriptionScopePollerResponse) PollUntilDone

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 (*DeploymentsValidateAtSubscriptionScopePollerResponse) Resume

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

type DeploymentsValidateAtSubscriptionScopeResponse

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

DeploymentsValidateAtSubscriptionScopeResponse contains the response from method Deployments.ValidateAtSubscriptionScope.

type DeploymentsValidateAtSubscriptionScopeResult

type DeploymentsValidateAtSubscriptionScopeResult struct {
	DeploymentValidateResult
}

DeploymentsValidateAtSubscriptionScopeResult contains the result from method Deployments.ValidateAtSubscriptionScope.

type DeploymentsValidateAtTenantScopePoller

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

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

func (*DeploymentsValidateAtTenantScopePoller) Done

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

func (*DeploymentsValidateAtTenantScopePoller) FinalResponse

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 DeploymentsValidateAtTenantScopeResponse will be returned.

func (*DeploymentsValidateAtTenantScopePoller) Poll

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 (*DeploymentsValidateAtTenantScopePoller) ResumeToken

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 DeploymentsValidateAtTenantScopePollerResponse

type DeploymentsValidateAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsValidateAtTenantScopePoller

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

DeploymentsValidateAtTenantScopePollerResponse contains the response from method Deployments.ValidateAtTenantScope.

func (DeploymentsValidateAtTenantScopePollerResponse) PollUntilDone

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 (*DeploymentsValidateAtTenantScopePollerResponse) Resume

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

type DeploymentsValidateAtTenantScopeResponse

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

DeploymentsValidateAtTenantScopeResponse contains the response from method Deployments.ValidateAtTenantScope.

type DeploymentsValidateAtTenantScopeResult

type DeploymentsValidateAtTenantScopeResult struct {
	DeploymentValidateResult
}

DeploymentsValidateAtTenantScopeResult contains the result from method Deployments.ValidateAtTenantScope.

type DeploymentsValidatePoller

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

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

func (*DeploymentsValidatePoller) Done

func (p *DeploymentsValidatePoller) Done() bool

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

func (*DeploymentsValidatePoller) FinalResponse

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 DeploymentsValidateResponse will be returned.

func (*DeploymentsValidatePoller) Poll

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 (*DeploymentsValidatePoller) ResumeToken

func (p *DeploymentsValidatePoller) 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 DeploymentsValidatePollerResponse

type DeploymentsValidatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsValidatePoller

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

DeploymentsValidatePollerResponse contains the response from method Deployments.Validate.

func (DeploymentsValidatePollerResponse) PollUntilDone

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 (*DeploymentsValidatePollerResponse) Resume

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

type DeploymentsValidateResponse

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

DeploymentsValidateResponse contains the response from method Deployments.Validate.

type DeploymentsValidateResult

type DeploymentsValidateResult struct {
	DeploymentValidateResult
}

DeploymentsValidateResult contains the result from method Deployments.Validate.

type DeploymentsWhatIfAtManagementGroupScopePoller

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

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

func (*DeploymentsWhatIfAtManagementGroupScopePoller) Done

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

func (*DeploymentsWhatIfAtManagementGroupScopePoller) FinalResponse

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 DeploymentsWhatIfAtManagementGroupScopeResponse will be returned.

func (*DeploymentsWhatIfAtManagementGroupScopePoller) Poll

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 (*DeploymentsWhatIfAtManagementGroupScopePoller) ResumeToken

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 DeploymentsWhatIfAtManagementGroupScopePollerResponse

type DeploymentsWhatIfAtManagementGroupScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsWhatIfAtManagementGroupScopePoller

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

DeploymentsWhatIfAtManagementGroupScopePollerResponse contains the response from method Deployments.WhatIfAtManagementGroupScope.

func (DeploymentsWhatIfAtManagementGroupScopePollerResponse) PollUntilDone

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 (*DeploymentsWhatIfAtManagementGroupScopePollerResponse) Resume

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

type DeploymentsWhatIfAtManagementGroupScopeResponse

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

DeploymentsWhatIfAtManagementGroupScopeResponse contains the response from method Deployments.WhatIfAtManagementGroupScope.

type DeploymentsWhatIfAtManagementGroupScopeResult

type DeploymentsWhatIfAtManagementGroupScopeResult struct {
	WhatIfOperationResult
}

DeploymentsWhatIfAtManagementGroupScopeResult contains the result from method Deployments.WhatIfAtManagementGroupScope.

type DeploymentsWhatIfAtSubscriptionScopePoller

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

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

func (*DeploymentsWhatIfAtSubscriptionScopePoller) Done

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

func (*DeploymentsWhatIfAtSubscriptionScopePoller) FinalResponse

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 DeploymentsWhatIfAtSubscriptionScopeResponse will be returned.

func (*DeploymentsWhatIfAtSubscriptionScopePoller) Poll

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 (*DeploymentsWhatIfAtSubscriptionScopePoller) ResumeToken

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 DeploymentsWhatIfAtSubscriptionScopePollerResponse

type DeploymentsWhatIfAtSubscriptionScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsWhatIfAtSubscriptionScopePoller

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

DeploymentsWhatIfAtSubscriptionScopePollerResponse contains the response from method Deployments.WhatIfAtSubscriptionScope.

func (DeploymentsWhatIfAtSubscriptionScopePollerResponse) PollUntilDone

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 (*DeploymentsWhatIfAtSubscriptionScopePollerResponse) Resume

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

type DeploymentsWhatIfAtSubscriptionScopeResponse

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

DeploymentsWhatIfAtSubscriptionScopeResponse contains the response from method Deployments.WhatIfAtSubscriptionScope.

type DeploymentsWhatIfAtSubscriptionScopeResult

type DeploymentsWhatIfAtSubscriptionScopeResult struct {
	WhatIfOperationResult
}

DeploymentsWhatIfAtSubscriptionScopeResult contains the result from method Deployments.WhatIfAtSubscriptionScope.

type DeploymentsWhatIfAtTenantScopePoller

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

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

func (*DeploymentsWhatIfAtTenantScopePoller) Done

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

func (*DeploymentsWhatIfAtTenantScopePoller) FinalResponse

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 DeploymentsWhatIfAtTenantScopeResponse will be returned.

func (*DeploymentsWhatIfAtTenantScopePoller) Poll

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 (*DeploymentsWhatIfAtTenantScopePoller) ResumeToken

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 DeploymentsWhatIfAtTenantScopePollerResponse

type DeploymentsWhatIfAtTenantScopePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsWhatIfAtTenantScopePoller

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

DeploymentsWhatIfAtTenantScopePollerResponse contains the response from method Deployments.WhatIfAtTenantScope.

func (DeploymentsWhatIfAtTenantScopePollerResponse) PollUntilDone

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 (*DeploymentsWhatIfAtTenantScopePollerResponse) Resume

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

type DeploymentsWhatIfAtTenantScopeResponse

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

DeploymentsWhatIfAtTenantScopeResponse contains the response from method Deployments.WhatIfAtTenantScope.

type DeploymentsWhatIfAtTenantScopeResult

type DeploymentsWhatIfAtTenantScopeResult struct {
	WhatIfOperationResult
}

DeploymentsWhatIfAtTenantScopeResult contains the result from method Deployments.WhatIfAtTenantScope.

type DeploymentsWhatIfPoller

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

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

func (*DeploymentsWhatIfPoller) Done

func (p *DeploymentsWhatIfPoller) Done() bool

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

func (*DeploymentsWhatIfPoller) FinalResponse

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 DeploymentsWhatIfResponse will be returned.

func (*DeploymentsWhatIfPoller) Poll

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 (*DeploymentsWhatIfPoller) ResumeToken

func (p *DeploymentsWhatIfPoller) 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 DeploymentsWhatIfPollerResponse

type DeploymentsWhatIfPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeploymentsWhatIfPoller

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

DeploymentsWhatIfPollerResponse contains the response from method Deployments.WhatIf.

func (DeploymentsWhatIfPollerResponse) PollUntilDone

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 (*DeploymentsWhatIfPollerResponse) Resume

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

type DeploymentsWhatIfResponse

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

DeploymentsWhatIfResponse contains the response from method Deployments.WhatIf.

type DeploymentsWhatIfResult

type DeploymentsWhatIfResult struct {
	WhatIfOperationResult
}

DeploymentsWhatIfResult contains the result from method Deployments.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

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

ToPtr returns a *ExtendedLocationType pointing to the current value.

type GenericResource

type GenericResource struct {
	Resource
	// The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`

	// The kind of the resource.
	Kind *string `json:"kind,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"`
}

GenericResource - Resource information.

func (GenericResource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type GenericResource.

func (*GenericResource) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type GenericResource.

type GenericResourceExpanded

type GenericResourceExpanded struct {
	GenericResource
	// 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; The provisioning state of the resource. This is only present if requested via the $expand query parameter.
	ProvisioningState *string `json:"provisioningState,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 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

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.

func (*OperationsClient) List

List - Lists all of the available Microsoft.Resources REST API operations. If the operation fails it returns the *CloudError error type.

type OperationsListOptions

type OperationsListOptions struct {
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListPager

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage

func (p *OperationsListPager) 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 (*OperationsListPager) PageResponse

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse

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

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult

type OperationsListResult struct {
	OperationListResult
}

OperationsListResult contains the result from method Operations.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

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

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"`

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

func (*ProviderResourceTypesClient) List

List - List the resource types for a specified resource provider. If the operation fails it returns the *CloudError error type.

type ProviderResourceTypesListOptions

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

ProviderResourceTypesListOptions contains the optional parameters for the ProviderResourceTypes.List method.

type ProviderResourceTypesListResponse

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

ProviderResourceTypesListResponse contains the response from method ProviderResourceTypes.List.

type ProviderResourceTypesListResult

type ProviderResourceTypesListResult struct {
	ProviderResourceTypeListResult
}

ProviderResourceTypesListResult contains the result from method ProviderResourceTypes.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.

func (*ProvidersClient) Get

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

Get - Gets the specified resource provider. If the operation fails it returns the *CloudError error type.

func (*ProvidersClient) GetAtTenantScope

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

GetAtTenantScope - Gets the specified resource provider at the tenant level. If the operation fails it returns the *CloudError error type.

func (*ProvidersClient) List

List - Gets all resource providers for a subscription. If the operation fails it returns the *CloudError error type.

func (*ProvidersClient) ListAtTenantScope

ListAtTenantScope - Gets all resource providers for the tenant. If the operation fails it returns the *CloudError error type.

func (*ProvidersClient) ProviderPermissions

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

ProviderPermissions - Get the provider permissions. If the operation fails it returns the *CloudError error type.

func (*ProvidersClient) Register

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

Register - Registers a subscription with a resource provider. If the operation fails it returns the *CloudError error type.

Example
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)
	}
	client := armresources.NewProvidersClient("<subscription ID>", cred, nil)
	resp, err := client.Register(context.Background(), "<resource provider namespace>", nil)
	if err != nil {
		log.Fatalf("failed to obtain a response: %v", err)
	}
	log.Printf("resource group exists: %v\n", *resp.Provider.ID)
}
Output:

func (*ProvidersClient) RegisterAtManagementGroupScope

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

RegisterAtManagementGroupScope - Registers a management group with a resource provider. If the operation fails it returns the *CloudError error type.

func (*ProvidersClient) Unregister

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

Unregister - Unregisters a subscription from a resource provider. If the operation fails it returns the *CloudError error type.

type ProvidersGetAtTenantScopeOptions

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

ProvidersGetAtTenantScopeOptions contains the optional parameters for the Providers.GetAtTenantScope method.

type ProvidersGetAtTenantScopeResponse

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

ProvidersGetAtTenantScopeResponse contains the response from method Providers.GetAtTenantScope.

type ProvidersGetAtTenantScopeResult

type ProvidersGetAtTenantScopeResult struct {
	Provider
}

ProvidersGetAtTenantScopeResult contains the result from method Providers.GetAtTenantScope.

type ProvidersGetOptions

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

ProvidersGetOptions contains the optional parameters for the Providers.Get method.

type ProvidersGetResponse

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

ProvidersGetResponse contains the response from method Providers.Get.

type ProvidersGetResult

type ProvidersGetResult struct {
	Provider
}

ProvidersGetResult contains the result from method Providers.Get.

type ProvidersListAtTenantScopeOptions

type ProvidersListAtTenantScopeOptions 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
}

ProvidersListAtTenantScopeOptions contains the optional parameters for the Providers.ListAtTenantScope method.

type ProvidersListAtTenantScopePager

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

ProvidersListAtTenantScopePager provides operations for iterating over paged responses.

func (*ProvidersListAtTenantScopePager) Err

Err returns the last error encountered while paging.

func (*ProvidersListAtTenantScopePager) NextPage

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

func (*ProvidersListAtTenantScopePager) PageResponse

PageResponse returns the current ProvidersListAtTenantScopeResponse page.

type ProvidersListAtTenantScopeResponse

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

ProvidersListAtTenantScopeResponse contains the response from method Providers.ListAtTenantScope.

type ProvidersListAtTenantScopeResult

type ProvidersListAtTenantScopeResult struct {
	ProviderListResult
}

ProvidersListAtTenantScopeResult contains the result from method Providers.ListAtTenantScope.

type ProvidersListOptions

type ProvidersListOptions 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
}

ProvidersListOptions contains the optional parameters for the Providers.List method.

type ProvidersListPager

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

ProvidersListPager provides operations for iterating over paged responses.

func (*ProvidersListPager) Err

func (p *ProvidersListPager) Err() error

Err returns the last error encountered while paging.

func (*ProvidersListPager) NextPage

func (p *ProvidersListPager) 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 (*ProvidersListPager) PageResponse

func (p *ProvidersListPager) PageResponse() ProvidersListResponse

PageResponse returns the current ProvidersListResponse page.

type ProvidersListResponse

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

ProvidersListResponse contains the response from method Providers.List.

type ProvidersListResult

type ProvidersListResult struct {
	ProviderListResult
}

ProvidersListResult contains the result from method Providers.List.

type ProvidersProviderPermissionsOptions

type ProvidersProviderPermissionsOptions struct {
}

ProvidersProviderPermissionsOptions contains the optional parameters for the Providers.ProviderPermissions method.

type ProvidersProviderPermissionsResponse

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

ProvidersProviderPermissionsResponse contains the response from method Providers.ProviderPermissions.

type ProvidersProviderPermissionsResult

type ProvidersProviderPermissionsResult struct {
	ProviderPermissionListResult
}

ProvidersProviderPermissionsResult contains the result from method Providers.ProviderPermissions.

type ProvidersRegisterAtManagementGroupScopeOptions

type ProvidersRegisterAtManagementGroupScopeOptions struct {
}

ProvidersRegisterAtManagementGroupScopeOptions contains the optional parameters for the Providers.RegisterAtManagementGroupScope method.

type ProvidersRegisterAtManagementGroupScopeResponse

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

ProvidersRegisterAtManagementGroupScopeResponse contains the response from method Providers.RegisterAtManagementGroupScope.

type ProvidersRegisterOptions

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

ProvidersRegisterOptions contains the optional parameters for the Providers.Register method.

type ProvidersRegisterResponse

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

ProvidersRegisterResponse contains the response from method Providers.Register.

type ProvidersRegisterResult

type ProvidersRegisterResult struct {
	Provider
}

ProvidersRegisterResult contains the result from method Providers.Register.

type ProvidersUnregisterOptions

type ProvidersUnregisterOptions struct {
}

ProvidersUnregisterOptions contains the optional parameters for the Providers.Unregister method.

type ProvidersUnregisterResponse

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

ProvidersUnregisterResponse contains the response from method Providers.Unregister.

type ProvidersUnregisterResult

type ProvidersUnregisterResult struct {
	Provider
}

ProvidersUnregisterResult contains the result from method Providers.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

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

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.

func (*Resource) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceGroup

type ResourceGroup struct {
	// REQUIRED; The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations.
	Location *string `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 ResourceGroupsBeginDeleteOptions

type ResourceGroupsBeginDeleteOptions struct {
	// The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets
	ForceDeletionTypes *string
}

ResourceGroupsBeginDeleteOptions contains the optional parameters for the ResourceGroups.BeginDelete method.

type ResourceGroupsBeginExportTemplateOptions

type ResourceGroupsBeginExportTemplateOptions struct {
}

ResourceGroupsBeginExportTemplateOptions contains the optional parameters for the ResourceGroups.BeginExportTemplate method.

type ResourceGroupsCheckExistenceOptions

type ResourceGroupsCheckExistenceOptions struct {
}

ResourceGroupsCheckExistenceOptions contains the optional parameters for the ResourceGroups.CheckExistence method.

type ResourceGroupsCheckExistenceResponse

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

ResourceGroupsCheckExistenceResponse contains the response from method ResourceGroups.CheckExistence.

type ResourceGroupsCheckExistenceResult

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

ResourceGroupsCheckExistenceResult contains the result from method ResourceGroups.CheckExistence.

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.

func (*ResourceGroupsClient) BeginDelete

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 the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourceGroupsClient("<subscription ID>", cred, nil)
	poller, err := client.BeginDelete(context.Background(), "<resource group name>", nil)
	if err != nil {
		log.Fatalf("failed to obtain a response: %v", err)
	}
	_, err = poller.PollUntilDone(context.Background(), 30*time.Second)
	if err != nil {
		log.Fatalf("failed to delete resource group: %v", err)
	}
}
Output:

func (*ResourceGroupsClient) BeginExportTemplate

BeginExportTemplate - Captures the specified resource group as a template. If the operation fails it returns the *CloudError error type.

func (*ResourceGroupsClient) CheckExistence

CheckExistence - Checks whether a resource group exists. If the operation fails it returns the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourceGroupsClient("<subscription ID>", cred, nil)
	resp, err := client.CheckExistence(context.Background(), "<resource group name>", nil)
	if err != nil {
		log.Fatalf("failed to obtain a response: %v", err)
	}
	log.Printf("resource group exists: %v\n", resp.Success)
}
Output:

func (*ResourceGroupsClient) CreateOrUpdate

func (client *ResourceGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, parameters ResourceGroup, options *ResourceGroupsCreateOrUpdateOptions) (ResourceGroupsCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a resource group. If the operation fails it returns the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourceGroupsClient("<subscription ID>", cred, nil)
	resp, err := client.CreateOrUpdate(context.Background(), "<resource group name>", armresources.ResourceGroup{
		Location: to.StringPtr("<location>"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to obtain a response: %v", err)
	}
	log.Printf("resource group ID: %s\n", *resp.ResourceGroup.ID)
}
Output:

func (*ResourceGroupsClient) Get

func (client *ResourceGroupsClient) Get(ctx context.Context, resourceGroupName string, options *ResourceGroupsGetOptions) (ResourceGroupsGetResponse, error)

Get - Gets a resource group. If the operation fails it returns the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourceGroupsClient("<subscription ID>", cred, nil)
	rg, err := client.Get(context.Background(), "<resource group name>", nil)
	if err != nil {
		log.Fatalf("failed to get resource group: %v", err)
	}
	log.Printf("resource group name: %s\n", *rg.ResourceGroup.Name)
}
Output:

func (*ResourceGroupsClient) List

List - Gets all the resource groups for a subscription. If the operation fails it returns the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourceGroupsClient("<subscription ID>", cred, nil)
	pager := client.List(nil)
	for pager.NextPage(context.Background()) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, rg := range pager.PageResponse().ResourceGroupListResult.Value {
			log.Printf("resource group ID: %s\n", *rg.ID)
		}
	}
}
Output:

func (*ResourceGroupsClient) Update

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 the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourceGroupsClient("<subscription ID>", cred, nil)
	resp, err := client.Update(
		context.Background(),
		"<resource group name>",
		armresources.ResourceGroupPatchable{
			Tags: map[string]*string{
				"exampleTag": to.StringPtr("exampleTagValue"),
			}},
		nil)
	if err != nil {
		log.Fatalf("failed to update resource group: %v", err)
	}
	log.Printf("updated resource group: %v", *resp.ResourceGroup.ID)
}
Output:

type ResourceGroupsCreateOrUpdateOptions

type ResourceGroupsCreateOrUpdateOptions struct {
}

ResourceGroupsCreateOrUpdateOptions contains the optional parameters for the ResourceGroups.CreateOrUpdate method.

type ResourceGroupsCreateOrUpdateResponse

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

ResourceGroupsCreateOrUpdateResponse contains the response from method ResourceGroups.CreateOrUpdate.

type ResourceGroupsCreateOrUpdateResult

type ResourceGroupsCreateOrUpdateResult struct {
	ResourceGroup
}

ResourceGroupsCreateOrUpdateResult contains the result from method ResourceGroups.CreateOrUpdate.

type ResourceGroupsDeletePoller

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

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

func (*ResourceGroupsDeletePoller) Done

func (p *ResourceGroupsDeletePoller) Done() bool

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

func (*ResourceGroupsDeletePoller) FinalResponse

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 ResourceGroupsDeleteResponse will be returned.

func (*ResourceGroupsDeletePoller) Poll

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 (*ResourceGroupsDeletePoller) ResumeToken

func (p *ResourceGroupsDeletePoller) 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 ResourceGroupsDeletePollerResponse

type ResourceGroupsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourceGroupsDeletePoller

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

ResourceGroupsDeletePollerResponse contains the response from method ResourceGroups.Delete.

func (ResourceGroupsDeletePollerResponse) PollUntilDone

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 (*ResourceGroupsDeletePollerResponse) Resume

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

type ResourceGroupsDeleteResponse

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

ResourceGroupsDeleteResponse contains the response from method ResourceGroups.Delete.

type ResourceGroupsExportTemplatePoller

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

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

func (*ResourceGroupsExportTemplatePoller) Done

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

func (*ResourceGroupsExportTemplatePoller) FinalResponse

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 ResourceGroupsExportTemplateResponse will be returned.

func (*ResourceGroupsExportTemplatePoller) Poll

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 (*ResourceGroupsExportTemplatePoller) ResumeToken

func (p *ResourceGroupsExportTemplatePoller) 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 ResourceGroupsExportTemplatePollerResponse

type ResourceGroupsExportTemplatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourceGroupsExportTemplatePoller

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

ResourceGroupsExportTemplatePollerResponse contains the response from method ResourceGroups.ExportTemplate.

func (ResourceGroupsExportTemplatePollerResponse) PollUntilDone

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 (*ResourceGroupsExportTemplatePollerResponse) Resume

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

type ResourceGroupsExportTemplateResponse

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

ResourceGroupsExportTemplateResponse contains the response from method ResourceGroups.ExportTemplate.

type ResourceGroupsExportTemplateResult

type ResourceGroupsExportTemplateResult struct {
	ResourceGroupExportResult
}

ResourceGroupsExportTemplateResult contains the result from method ResourceGroups.ExportTemplate.

type ResourceGroupsGetOptions

type ResourceGroupsGetOptions struct {
}

ResourceGroupsGetOptions contains the optional parameters for the ResourceGroups.Get method.

type ResourceGroupsGetResponse

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

ResourceGroupsGetResponse contains the response from method ResourceGroups.Get.

type ResourceGroupsGetResult

type ResourceGroupsGetResult struct {
	ResourceGroup
}

ResourceGroupsGetResult contains the result from method ResourceGroups.Get.

type ResourceGroupsListOptions

type ResourceGroupsListOptions struct {
	// The filter to apply on the operation.<br><br>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
}

ResourceGroupsListOptions contains the optional parameters for the ResourceGroups.List method.

type ResourceGroupsListPager

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

ResourceGroupsListPager provides operations for iterating over paged responses.

func (*ResourceGroupsListPager) Err

func (p *ResourceGroupsListPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceGroupsListPager) NextPage

func (p *ResourceGroupsListPager) 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 (*ResourceGroupsListPager) PageResponse

PageResponse returns the current ResourceGroupsListResponse page.

type ResourceGroupsListResponse

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

ResourceGroupsListResponse contains the response from method ResourceGroups.List.

type ResourceGroupsListResult

type ResourceGroupsListResult struct {
	ResourceGroupListResult
}

ResourceGroupsListResult contains the result from method ResourceGroups.List.

type ResourceGroupsUpdateOptions

type ResourceGroupsUpdateOptions struct {
}

ResourceGroupsUpdateOptions contains the optional parameters for the ResourceGroups.Update method.

type ResourceGroupsUpdateResponse

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

ResourceGroupsUpdateResponse contains the response from method ResourceGroups.Update.

type ResourceGroupsUpdateResult

type ResourceGroupsUpdateResult struct {
	ResourceGroup
}

ResourceGroupsUpdateResult contains the result from method ResourceGroups.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

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 ResourcesBeginCreateOrUpdateByIDOptions

type ResourcesBeginCreateOrUpdateByIDOptions struct {
}

ResourcesBeginCreateOrUpdateByIDOptions contains the optional parameters for the Resources.BeginCreateOrUpdateByID method.

type ResourcesBeginCreateOrUpdateOptions

type ResourcesBeginCreateOrUpdateOptions struct {
}

ResourcesBeginCreateOrUpdateOptions contains the optional parameters for the Resources.BeginCreateOrUpdate method.

type ResourcesBeginDeleteByIDOptions

type ResourcesBeginDeleteByIDOptions struct {
}

ResourcesBeginDeleteByIDOptions contains the optional parameters for the Resources.BeginDeleteByID method.

type ResourcesBeginDeleteOptions

type ResourcesBeginDeleteOptions struct {
}

ResourcesBeginDeleteOptions contains the optional parameters for the Resources.BeginDelete method.

type ResourcesBeginMoveResourcesOptions

type ResourcesBeginMoveResourcesOptions struct {
}

ResourcesBeginMoveResourcesOptions contains the optional parameters for the Resources.BeginMoveResources method.

type ResourcesBeginUpdateByIDOptions

type ResourcesBeginUpdateByIDOptions struct {
}

ResourcesBeginUpdateByIDOptions contains the optional parameters for the Resources.BeginUpdateByID method.

type ResourcesBeginUpdateOptions

type ResourcesBeginUpdateOptions struct {
}

ResourcesBeginUpdateOptions contains the optional parameters for the Resources.BeginUpdate method.

type ResourcesBeginValidateMoveResourcesOptions

type ResourcesBeginValidateMoveResourcesOptions struct {
}

ResourcesBeginValidateMoveResourcesOptions contains the optional parameters for the Resources.BeginValidateMoveResources method.

type ResourcesCheckExistenceByIDOptions

type ResourcesCheckExistenceByIDOptions struct {
}

ResourcesCheckExistenceByIDOptions contains the optional parameters for the Resources.CheckExistenceByID method.

type ResourcesCheckExistenceByIDResponse

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

ResourcesCheckExistenceByIDResponse contains the response from method Resources.CheckExistenceByID.

type ResourcesCheckExistenceByIDResult

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

ResourcesCheckExistenceByIDResult contains the result from method Resources.CheckExistenceByID.

type ResourcesCheckExistenceOptions

type ResourcesCheckExistenceOptions struct {
}

ResourcesCheckExistenceOptions contains the optional parameters for the Resources.CheckExistence method.

type ResourcesCheckExistenceResponse

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

ResourcesCheckExistenceResponse contains the response from method Resources.CheckExistence.

type ResourcesCheckExistenceResult

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

ResourcesCheckExistenceResult contains the result from method Resources.CheckExistence.

type ResourcesClient

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

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

func NewResourcesClient

func NewResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ResourcesClient

NewResourcesClient creates a new instance of ResourcesClient with the specified values.

func (*ResourcesClient) BeginCreateOrUpdate

func (client *ResourcesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, parameters GenericResource, options *ResourcesBeginCreateOrUpdateOptions) (ResourcesCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a resource. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) BeginCreateOrUpdateByID

func (client *ResourcesClient) BeginCreateOrUpdateByID(ctx context.Context, resourceID string, apiVersion string, parameters GenericResource, options *ResourcesBeginCreateOrUpdateByIDOptions) (ResourcesCreateOrUpdateByIDPollerResponse, error)

BeginCreateOrUpdateByID - Create a resource by ID. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) BeginDelete

func (client *ResourcesClient) BeginDelete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, options *ResourcesBeginDeleteOptions) (ResourcesDeletePollerResponse, error)

BeginDelete - Deletes a resource. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) BeginDeleteByID

func (client *ResourcesClient) BeginDeleteByID(ctx context.Context, resourceID string, apiVersion string, options *ResourcesBeginDeleteByIDOptions) (ResourcesDeleteByIDPollerResponse, error)

BeginDeleteByID - Deletes a resource by ID. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) BeginMoveResources

func (client *ResourcesClient) BeginMoveResources(ctx context.Context, sourceResourceGroupName string, parameters ResourcesMoveInfo, options *ResourcesBeginMoveResourcesOptions) (ResourcesMoveResourcesPollerResponse, 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 the *CloudError error type.

func (*ResourcesClient) BeginUpdate

func (client *ResourcesClient) BeginUpdate(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, parameters GenericResource, options *ResourcesBeginUpdateOptions) (ResourcesUpdatePollerResponse, error)

BeginUpdate - Updates a resource. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) BeginUpdateByID

func (client *ResourcesClient) BeginUpdateByID(ctx context.Context, resourceID string, apiVersion string, parameters GenericResource, options *ResourcesBeginUpdateByIDOptions) (ResourcesUpdateByIDPollerResponse, error)

BeginUpdateByID - Updates a resource by ID. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) BeginValidateMoveResources

func (client *ResourcesClient) BeginValidateMoveResources(ctx context.Context, sourceResourceGroupName string, parameters ResourcesMoveInfo, options *ResourcesBeginValidateMoveResourcesOptions) (ResourcesValidateMoveResourcesPollerResponse, 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 the *CloudError error type.

func (*ResourcesClient) CheckExistence

func (client *ResourcesClient) CheckExistence(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, options *ResourcesCheckExistenceOptions) (ResourcesCheckExistenceResponse, error)

CheckExistence - Checks whether a resource exists. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) CheckExistenceByID

func (client *ResourcesClient) CheckExistenceByID(ctx context.Context, resourceID string, apiVersion string, options *ResourcesCheckExistenceByIDOptions) (ResourcesCheckExistenceByIDResponse, error)

CheckExistenceByID - Checks by ID whether a resource exists. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) Get

func (client *ResourcesClient) Get(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, apiVersion string, options *ResourcesGetOptions) (ResourcesGetResponse, error)

Get - Gets a resource. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) GetByID

func (client *ResourcesClient) GetByID(ctx context.Context, resourceID string, apiVersion string, options *ResourcesGetByIDOptions) (ResourcesGetByIDResponse, error)

GetByID - Gets a resource by ID. If the operation fails it returns the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourcesClient("<subscription ID>", cred, nil)
	resp, err := client.GetByID(context.Background(), "<resource ID>", "<api version>", nil)
	if err != nil {
		log.Fatalf("failed to obtain a response: %v", err)
	}
	log.Printf("resource ID: %v\n", resp.GenericResource.ID)
}
Output:

func (*ResourcesClient) List

List - Get all the resources in a subscription. If the operation fails it returns the *CloudError error type.

func (*ResourcesClient) ListByResourceGroup

func (client *ResourcesClient) ListByResourceGroup(resourceGroupName string, options *ResourcesListByResourceGroupOptions) *ResourcesListByResourceGroupPager

ListByResourceGroup - Get all the resources for a resource group. If the operation fails it returns the *CloudError error type.

Example
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)
	}
	client := armresources.NewResourcesClient("<subscription ID>", cred, nil)
	page := client.ListByResourceGroup("<resource group name>", nil)
	for page.NextPage(context.Background()) {
		resp := page.PageResponse()
		if len(resp.ResourceListResult.Value) == 0 {
			log.Fatal("missing payload")
		}
		for _, val := range resp.ResourceListResult.Value {
			log.Printf("resource: %v", *val.ID)
		}
	}
	if err := page.Err(); err != nil {
		log.Fatal(err)
	}

}
Output:

type ResourcesCreateOrUpdateByIDPoller

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

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

func (*ResourcesCreateOrUpdateByIDPoller) Done

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

func (*ResourcesCreateOrUpdateByIDPoller) FinalResponse

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 ResourcesCreateOrUpdateByIDResponse will be returned.

func (*ResourcesCreateOrUpdateByIDPoller) Poll

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 (*ResourcesCreateOrUpdateByIDPoller) ResumeToken

func (p *ResourcesCreateOrUpdateByIDPoller) 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 ResourcesCreateOrUpdateByIDPollerResponse

type ResourcesCreateOrUpdateByIDPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesCreateOrUpdateByIDPoller

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

ResourcesCreateOrUpdateByIDPollerResponse contains the response from method Resources.CreateOrUpdateByID.

func (ResourcesCreateOrUpdateByIDPollerResponse) PollUntilDone

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 (*ResourcesCreateOrUpdateByIDPollerResponse) Resume

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

type ResourcesCreateOrUpdateByIDResponse

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

ResourcesCreateOrUpdateByIDResponse contains the response from method Resources.CreateOrUpdateByID.

type ResourcesCreateOrUpdateByIDResult

type ResourcesCreateOrUpdateByIDResult struct {
	GenericResource
}

ResourcesCreateOrUpdateByIDResult contains the result from method Resources.CreateOrUpdateByID.

type ResourcesCreateOrUpdatePoller

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

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

func (*ResourcesCreateOrUpdatePoller) Done

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

func (*ResourcesCreateOrUpdatePoller) FinalResponse

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 ResourcesCreateOrUpdateResponse will be returned.

func (*ResourcesCreateOrUpdatePoller) Poll

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 (*ResourcesCreateOrUpdatePoller) ResumeToken

func (p *ResourcesCreateOrUpdatePoller) 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 ResourcesCreateOrUpdatePollerResponse

type ResourcesCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesCreateOrUpdatePoller

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

ResourcesCreateOrUpdatePollerResponse contains the response from method Resources.CreateOrUpdate.

func (ResourcesCreateOrUpdatePollerResponse) PollUntilDone

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 (*ResourcesCreateOrUpdatePollerResponse) Resume

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

type ResourcesCreateOrUpdateResponse

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

ResourcesCreateOrUpdateResponse contains the response from method Resources.CreateOrUpdate.

type ResourcesCreateOrUpdateResult

type ResourcesCreateOrUpdateResult struct {
	GenericResource
}

ResourcesCreateOrUpdateResult contains the result from method Resources.CreateOrUpdate.

type ResourcesDeleteByIDPoller

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

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

func (*ResourcesDeleteByIDPoller) Done

func (p *ResourcesDeleteByIDPoller) Done() bool

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

func (*ResourcesDeleteByIDPoller) FinalResponse

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 ResourcesDeleteByIDResponse will be returned.

func (*ResourcesDeleteByIDPoller) Poll

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 (*ResourcesDeleteByIDPoller) ResumeToken

func (p *ResourcesDeleteByIDPoller) 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 ResourcesDeleteByIDPollerResponse

type ResourcesDeleteByIDPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesDeleteByIDPoller

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

ResourcesDeleteByIDPollerResponse contains the response from method Resources.DeleteByID.

func (ResourcesDeleteByIDPollerResponse) PollUntilDone

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 (*ResourcesDeleteByIDPollerResponse) Resume

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

type ResourcesDeleteByIDResponse

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

ResourcesDeleteByIDResponse contains the response from method Resources.DeleteByID.

type ResourcesDeletePoller

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

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

func (*ResourcesDeletePoller) Done

func (p *ResourcesDeletePoller) Done() bool

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

func (*ResourcesDeletePoller) FinalResponse

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 ResourcesDeleteResponse will be returned.

func (*ResourcesDeletePoller) Poll

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 (*ResourcesDeletePoller) ResumeToken

func (p *ResourcesDeletePoller) 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 ResourcesDeletePollerResponse

type ResourcesDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesDeletePoller

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

ResourcesDeletePollerResponse contains the response from method Resources.Delete.

func (ResourcesDeletePollerResponse) PollUntilDone

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 (*ResourcesDeletePollerResponse) Resume

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

type ResourcesDeleteResponse

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

ResourcesDeleteResponse contains the response from method Resources.Delete.

type ResourcesGetByIDOptions

type ResourcesGetByIDOptions struct {
}

ResourcesGetByIDOptions contains the optional parameters for the Resources.GetByID method.

type ResourcesGetByIDResponse

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

ResourcesGetByIDResponse contains the response from method Resources.GetByID.

type ResourcesGetByIDResult

type ResourcesGetByIDResult struct {
	GenericResource
}

ResourcesGetByIDResult contains the result from method Resources.GetByID.

type ResourcesGetOptions

type ResourcesGetOptions struct {
}

ResourcesGetOptions contains the optional parameters for the Resources.Get method.

type ResourcesGetResponse

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

ResourcesGetResponse contains the response from method Resources.Get.

type ResourcesGetResult

type ResourcesGetResult struct {
	GenericResource
}

ResourcesGetResult contains the result from method Resources.Get.

type ResourcesListByResourceGroupOptions

type ResourcesListByResourceGroupOptions 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.<br><br>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.<br><br>For example, to filter by
	// a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'<br><br>You can use substringof(value, property) in the filter. The
	// properties you can use for substring are: name and resourceGroup.<br><br>For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo',
	// name)<br><br>You can link more than one substringof together by adding and/or operators.<br><br>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.<br><br>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
}

ResourcesListByResourceGroupOptions contains the optional parameters for the Resources.ListByResourceGroup method.

type ResourcesListByResourceGroupPager

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

ResourcesListByResourceGroupPager provides operations for iterating over paged responses.

func (*ResourcesListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*ResourcesListByResourceGroupPager) NextPage

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

func (*ResourcesListByResourceGroupPager) PageResponse

PageResponse returns the current ResourcesListByResourceGroupResponse page.

type ResourcesListByResourceGroupResponse

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

ResourcesListByResourceGroupResponse contains the response from method Resources.ListByResourceGroup.

type ResourcesListByResourceGroupResult

type ResourcesListByResourceGroupResult struct {
	ResourceListResult
}

ResourcesListByResourceGroupResult contains the result from method Resources.ListByResourceGroup.

type ResourcesListOptions

type ResourcesListOptions 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.<br><br>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`.<br><br>For example, to filter by a resource type, use `$filter=resourceType eq 'Microsoft.Network/virtualNetworks'`<br><br><br>`substringof(value,
	// property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup`<br><br>For example, to get
	// all resources with 'demo' anywhere in the resource name, use `$filter=substringof('demo', name)`<br><br>Multiple substring operations can also be combined
	// using `and`/`or` operators.<br><br>Note that any truncated number of results queried via `$top` may also not be compatible when using a filter.<br><br><br>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, <b>the original tags for each resource will not be returned in the results.</b> Any list of additional
	// properties queried via `$expand` may also not be compatible when filtering by tag names/values. <br><br>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.)<br><br><br>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
}

ResourcesListOptions contains the optional parameters for the Resources.List method.

type ResourcesListPager

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

ResourcesListPager provides operations for iterating over paged responses.

func (*ResourcesListPager) Err

func (p *ResourcesListPager) Err() error

Err returns the last error encountered while paging.

func (*ResourcesListPager) NextPage

func (p *ResourcesListPager) 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 (*ResourcesListPager) PageResponse

func (p *ResourcesListPager) PageResponse() ResourcesListResponse

PageResponse returns the current ResourcesListResponse page.

type ResourcesListResponse

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

ResourcesListResponse contains the response from method Resources.List.

type ResourcesListResult

type ResourcesListResult struct {
	ResourceListResult
}

ResourcesListResult contains the result from method Resources.List.

type ResourcesMoveInfo

type ResourcesMoveInfo struct {
	// The IDs of the resources.
	Resources []*string `json:"resources,omitempty"`

	// The target resource group.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
}

ResourcesMoveInfo - Parameters of move resources.

func (ResourcesMoveInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ResourcesMoveInfo.

type ResourcesMoveResourcesPoller

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

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

func (*ResourcesMoveResourcesPoller) Done

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

func (*ResourcesMoveResourcesPoller) FinalResponse

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 ResourcesMoveResourcesResponse will be returned.

func (*ResourcesMoveResourcesPoller) Poll

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 (*ResourcesMoveResourcesPoller) ResumeToken

func (p *ResourcesMoveResourcesPoller) 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 ResourcesMoveResourcesPollerResponse

type ResourcesMoveResourcesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesMoveResourcesPoller

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

ResourcesMoveResourcesPollerResponse contains the response from method Resources.MoveResources.

func (ResourcesMoveResourcesPollerResponse) PollUntilDone

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 (*ResourcesMoveResourcesPollerResponse) Resume

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

type ResourcesMoveResourcesResponse

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

ResourcesMoveResourcesResponse contains the response from method Resources.MoveResources.

type ResourcesUpdateByIDPoller

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

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

func (*ResourcesUpdateByIDPoller) Done

func (p *ResourcesUpdateByIDPoller) Done() bool

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

func (*ResourcesUpdateByIDPoller) FinalResponse

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 ResourcesUpdateByIDResponse will be returned.

func (*ResourcesUpdateByIDPoller) Poll

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 (*ResourcesUpdateByIDPoller) ResumeToken

func (p *ResourcesUpdateByIDPoller) 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 ResourcesUpdateByIDPollerResponse

type ResourcesUpdateByIDPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesUpdateByIDPoller

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

ResourcesUpdateByIDPollerResponse contains the response from method Resources.UpdateByID.

func (ResourcesUpdateByIDPollerResponse) PollUntilDone

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 (*ResourcesUpdateByIDPollerResponse) Resume

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

type ResourcesUpdateByIDResponse

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

ResourcesUpdateByIDResponse contains the response from method Resources.UpdateByID.

type ResourcesUpdateByIDResult

type ResourcesUpdateByIDResult struct {
	GenericResource
}

ResourcesUpdateByIDResult contains the result from method Resources.UpdateByID.

type ResourcesUpdatePoller

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

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

func (*ResourcesUpdatePoller) Done

func (p *ResourcesUpdatePoller) Done() bool

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

func (*ResourcesUpdatePoller) FinalResponse

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 ResourcesUpdateResponse will be returned.

func (*ResourcesUpdatePoller) Poll

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 (*ResourcesUpdatePoller) ResumeToken

func (p *ResourcesUpdatePoller) 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 ResourcesUpdatePollerResponse

type ResourcesUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesUpdatePoller

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

ResourcesUpdatePollerResponse contains the response from method Resources.Update.

func (ResourcesUpdatePollerResponse) PollUntilDone

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 (*ResourcesUpdatePollerResponse) Resume

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

type ResourcesUpdateResponse

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

ResourcesUpdateResponse contains the response from method Resources.Update.

type ResourcesUpdateResult

type ResourcesUpdateResult struct {
	GenericResource
}

ResourcesUpdateResult contains the result from method Resources.Update.

type ResourcesValidateMoveResourcesPoller

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

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

func (*ResourcesValidateMoveResourcesPoller) Done

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

func (*ResourcesValidateMoveResourcesPoller) FinalResponse

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 ResourcesValidateMoveResourcesResponse will be returned.

func (*ResourcesValidateMoveResourcesPoller) Poll

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 (*ResourcesValidateMoveResourcesPoller) ResumeToken

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 ResourcesValidateMoveResourcesPollerResponse

type ResourcesValidateMoveResourcesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourcesValidateMoveResourcesPoller

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

ResourcesValidateMoveResourcesPollerResponse contains the response from method Resources.ValidateMoveResources.

func (ResourcesValidateMoveResourcesPollerResponse) PollUntilDone

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 (*ResourcesValidateMoveResourcesPollerResponse) Resume

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

type ResourcesValidateMoveResourcesResponse

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

ResourcesValidateMoveResourcesResponse contains the response from method Resources.ValidateMoveResources.

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.

func (*TagsClient) CreateOrUpdate

func (client *TagsClient) CreateOrUpdate(ctx context.Context, tagName string, options *TagsCreateOrUpdateOptions) (TagsCreateOrUpdateResponse, 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 the *CloudError error type.

func (*TagsClient) CreateOrUpdateAtScope

func (client *TagsClient) CreateOrUpdateAtScope(ctx context.Context, scope string, parameters TagsResource, options *TagsCreateOrUpdateAtScopeOptions) (TagsCreateOrUpdateAtScopeResponse, 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 the *CloudError error type.

func (*TagsClient) CreateOrUpdateValue

func (client *TagsClient) CreateOrUpdateValue(ctx context.Context, tagName string, tagValue string, options *TagsCreateOrUpdateValueOptions) (TagsCreateOrUpdateValueResponse, 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 the *CloudError error type.

func (*TagsClient) Delete

func (client *TagsClient) Delete(ctx context.Context, tagName string, options *TagsDeleteOptions) (TagsDeleteResponse, 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 the *CloudError error type.

func (*TagsClient) DeleteAtScope

func (client *TagsClient) DeleteAtScope(ctx context.Context, scope string, options *TagsDeleteAtScopeOptions) (TagsDeleteAtScopeResponse, error)

DeleteAtScope - Deletes the entire set of tags on a resource or subscription. If the operation fails it returns the *CloudError error type.

func (*TagsClient) DeleteValue

func (client *TagsClient) DeleteValue(ctx context.Context, tagName string, tagValue string, options *TagsDeleteValueOptions) (TagsDeleteValueResponse, 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 the *CloudError error type.

func (*TagsClient) GetAtScope

func (client *TagsClient) GetAtScope(ctx context.Context, scope string, options *TagsGetAtScopeOptions) (TagsGetAtScopeResponse, error)

GetAtScope - Gets the entire set of tags on a resource or subscription. If the operation fails it returns the *CloudError error type.

func (*TagsClient) List

func (client *TagsClient) List(options *TagsListOptions) *TagsListPager

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 the *CloudError error type.

func (*TagsClient) UpdateAtScope

func (client *TagsClient) UpdateAtScope(ctx context.Context, scope string, parameters TagsPatchResource, options *TagsUpdateAtScopeOptions) (TagsUpdateAtScopeResponse, 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 the *CloudError error type.

type TagsCreateOrUpdateAtScopeOptions

type TagsCreateOrUpdateAtScopeOptions struct {
}

TagsCreateOrUpdateAtScopeOptions contains the optional parameters for the Tags.CreateOrUpdateAtScope method.

type TagsCreateOrUpdateAtScopeResponse

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

TagsCreateOrUpdateAtScopeResponse contains the response from method Tags.CreateOrUpdateAtScope.

type TagsCreateOrUpdateAtScopeResult

type TagsCreateOrUpdateAtScopeResult struct {
	TagsResource
}

TagsCreateOrUpdateAtScopeResult contains the result from method Tags.CreateOrUpdateAtScope.

type TagsCreateOrUpdateOptions

type TagsCreateOrUpdateOptions struct {
}

TagsCreateOrUpdateOptions contains the optional parameters for the Tags.CreateOrUpdate method.

type TagsCreateOrUpdateResponse

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

TagsCreateOrUpdateResponse contains the response from method Tags.CreateOrUpdate.

type TagsCreateOrUpdateResult

type TagsCreateOrUpdateResult struct {
	TagDetails
}

TagsCreateOrUpdateResult contains the result from method Tags.CreateOrUpdate.

type TagsCreateOrUpdateValueOptions

type TagsCreateOrUpdateValueOptions struct {
}

TagsCreateOrUpdateValueOptions contains the optional parameters for the Tags.CreateOrUpdateValue method.

type TagsCreateOrUpdateValueResponse

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

TagsCreateOrUpdateValueResponse contains the response from method Tags.CreateOrUpdateValue.

type TagsCreateOrUpdateValueResult

type TagsCreateOrUpdateValueResult struct {
	TagValue
}

TagsCreateOrUpdateValueResult contains the result from method Tags.CreateOrUpdateValue.

type TagsDeleteAtScopeOptions

type TagsDeleteAtScopeOptions struct {
}

TagsDeleteAtScopeOptions contains the optional parameters for the Tags.DeleteAtScope method.

type TagsDeleteAtScopeResponse

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

TagsDeleteAtScopeResponse contains the response from method Tags.DeleteAtScope.

type TagsDeleteOptions

type TagsDeleteOptions struct {
}

TagsDeleteOptions contains the optional parameters for the Tags.Delete method.

type TagsDeleteResponse

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

TagsDeleteResponse contains the response from method Tags.Delete.

type TagsDeleteValueOptions

type TagsDeleteValueOptions struct {
}

TagsDeleteValueOptions contains the optional parameters for the Tags.DeleteValue method.

type TagsDeleteValueResponse

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

TagsDeleteValueResponse contains the response from method Tags.DeleteValue.

type TagsGetAtScopeOptions

type TagsGetAtScopeOptions struct {
}

TagsGetAtScopeOptions contains the optional parameters for the Tags.GetAtScope method.

type TagsGetAtScopeResponse

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

TagsGetAtScopeResponse contains the response from method Tags.GetAtScope.

type TagsGetAtScopeResult

type TagsGetAtScopeResult struct {
	TagsResource
}

TagsGetAtScopeResult contains the result from method Tags.GetAtScope.

type TagsListOptions

type TagsListOptions struct {
}

TagsListOptions contains the optional parameters for the Tags.List method.

type TagsListPager

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

TagsListPager provides operations for iterating over paged responses.

func (*TagsListPager) Err

func (p *TagsListPager) Err() error

Err returns the last error encountered while paging.

func (*TagsListPager) NextPage

func (p *TagsListPager) 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 (*TagsListPager) PageResponse

func (p *TagsListPager) PageResponse() TagsListResponse

PageResponse returns the current TagsListResponse page.

type TagsListResponse

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

TagsListResponse contains the response from method Tags.List.

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 TagsListResultEnvelope

type TagsListResultEnvelope struct {
	TagsListResult
}

TagsListResultEnvelope contains the result from method Tags.List.

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

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 TagsUpdateAtScopeOptions

type TagsUpdateAtScopeOptions struct {
}

TagsUpdateAtScopeOptions contains the optional parameters for the Tags.UpdateAtScope method.

type TagsUpdateAtScopeResponse

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

TagsUpdateAtScopeResponse contains the response from method Tags.UpdateAtScope.

type TagsUpdateAtScopeResult

type TagsUpdateAtScopeResult struct {
	TagsResource
}

TagsUpdateAtScopeResult contains the result from method Tags.UpdateAtScope.

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

ToPtr returns a *WhatIfResultFormat pointing to the current value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL