resources

package
v52.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 4, 2021 License: Apache-2.0 Imports: 10 Imported by: 251

Documentation

Overview

Package resources implements the Azure ARM Resources service API version 2016-02-01.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Resources
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AliasPathType 

type AliasPathType struct {
	// Path - The path of an alias.
	Path *string `json:"path,omitempty"`
	// APIVersions - The api versions.
	APIVersions *[]string `json:"apiVersions,omitempty"`
}

AliasPathType ...

type AliasType 

type AliasType struct {
	// Name - The alias name.
	Name *string `json:"name,omitempty"`
	// Paths - The paths for an alias.
	Paths *[]AliasPathType `json:"paths,omitempty"`
}

AliasType ...

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Resources.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicDependency 

type BasicDependency struct {
	// ID - The ID of the dependency.
	ID *string `json:"id,omitempty"`
	// ResourceType - The dependency resource type.
	ResourceType *string `json:"resourceType,omitempty"`
	// ResourceName - The dependency resource name.
	ResourceName *string `json:"resourceName,omitempty"`
}

BasicDependency deployment dependency information.

type Client 

type Client struct {
	BaseClient
}

Client is the client for the Resources methods of the Resources service.

func NewClient 

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (Client) CheckExistence 

func (client Client) CheckExistence(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (result autorest.Response, err error)

CheckExistence checks whether resource exists. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceProviderNamespace - resource identity. parentResourcePath - resource identity. resourceType - resource identity. resourceName - resource identity.

func (Client) CheckExistencePreparer 

func (client Client) CheckExistencePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (*http.Request, error)

CheckExistencePreparer prepares the CheckExistence request.

func (Client) CheckExistenceResponder 

func (client Client) CheckExistenceResponder(resp *http.Response) (result autorest.Response, err error)

CheckExistenceResponder handles the response to the CheckExistence request. The method always closes the http.Response Body.

func (Client) CheckExistenceSender 

func (client Client) CheckExistenceSender(req *http.Request) (*http.Response, error)

CheckExistenceSender sends the CheckExistence request. The method will close the http.Response Body if it receives an error.

func (Client) CreateOrUpdate 

func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string, parameters GenericResource) (result GenericResource, err error)

CreateOrUpdate create a resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceProviderNamespace - resource identity. parentResourcePath - resource identity. resourceType - resource identity. resourceName - resource identity. parameters - create or update resource parameters.

func (Client) CreateOrUpdatePreparer 

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string, parameters GenericResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder 

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result GenericResource, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (Client) CreateOrUpdateSender 

func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (Client) Delete 

func (client Client) Delete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (result autorest.Response, err error)

Delete delete resource and all of its resources. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceProviderNamespace - resource identity. parentResourcePath - resource identity. resourceType - resource identity. resourceName - resource identity.

func (Client) DeletePreparer 

func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder 

func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (Client) DeleteSender 

func (client Client) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (Client) Get 

func (client Client) Get(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (result GenericResource, err error)

Get returns a resource belonging to a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceProviderNamespace - resource identity. parentResourcePath - resource identity. resourceType - resource identity. resourceName - resource identity.

func (Client) GetPreparer 

func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder 

func (client Client) GetResponder(resp *http.Response) (result GenericResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (Client) GetSender 

func (client Client) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (Client) List 

func (client Client) List(ctx context.Context, filter string, expand string, top *int32) (result ListResultPage, err error)

List get all of the resources under a subscription. Parameters: filter - the filter to apply on the operation. expand - comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. top - query parameters. If null is passed returns all resource groups.

func (Client) ListComplete 

func (client Client) ListComplete(ctx context.Context, filter string, expand string, top *int32) (result ListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListPreparer 

func (client Client) ListPreparer(ctx context.Context, filter string, expand string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder 

func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (Client) ListSender 

func (client Client) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (Client) MoveResources 

func (client Client) MoveResources(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo) (result MoveResourcesFuture, err error)

MoveResources move resources from one resource group to another. The resources being moved should all be in the same resource group. Parameters: sourceResourceGroupName - source resource group name. parameters - move resources' parameters.

func (Client) MoveResourcesPreparer 

func (client Client) MoveResourcesPreparer(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo) (*http.Request, error)

MoveResourcesPreparer prepares the MoveResources request.

func (Client) MoveResourcesResponder 

func (client Client) MoveResourcesResponder(resp *http.Response) (result autorest.Response, err error)

MoveResourcesResponder handles the response to the MoveResources request. The method always closes the http.Response Body.

func (Client) MoveResourcesSender 

func (client Client) MoveResourcesSender(req *http.Request) (future MoveResourcesFuture, err error)

MoveResourcesSender sends the MoveResources request. The method will close the http.Response Body if it receives an error.

func (Client) Update 

func (client Client) Update(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string, parameters GenericResource) (result UpdateFuture, err error)

Update updates a resource. Parameters: resourceGroupName - the name of the resource group for the resource. The name is case insensitive. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - the parent resource identity. resourceType - the resource type of the resource to update. resourceName - the name of the resource to update. APIVersion - the API version to use for the operation. parameters - parameters for updating the resource.

func (Client) UpdatePreparer 

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string, parameters GenericResource) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder 

func (client Client) UpdateResponder(resp *http.Response) (result GenericResource, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (Client) UpdateSender 

func (client Client) UpdateSender(req *http.Request) (future UpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type CloudError 

type CloudError struct {
	Error *ErrorResponse `json:"error,omitempty"`
}

CloudError an error response for a resource management request.

type DebugSetting 

type DebugSetting struct {
	// DetailLevel - The debug detail level.
	DetailLevel *string `json:"detailLevel,omitempty"`
}

DebugSetting ...

type Dependency 

type Dependency struct {
	// DependsOn - The list of dependencies.
	DependsOn *[]BasicDependency `json:"dependsOn,omitempty"`
	// ID - The ID of the dependency.
	ID *string `json:"id,omitempty"`
	// ResourceType - The dependency resource type.
	ResourceType *string `json:"resourceType,omitempty"`
	// ResourceName - The dependency resource name.
	ResourceName *string `json:"resourceName,omitempty"`
}

Dependency deployment dependency information.

type Deployment 

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

Deployment deployment operation parameters.

type DeploymentExportResult 

type DeploymentExportResult struct {
	autorest.Response `json:"-"`
	// Template - The template content.
	Template interface{} `json:"template,omitempty"`
}

DeploymentExportResult ...

type DeploymentExtended 

type DeploymentExtended struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The ID of the deployment.
	ID *string `json:"id,omitempty"`
	// Name - The name of the deployment.
	Name *string `json:"name,omitempty"`
	// Properties - Deployment properties.
	Properties *DeploymentPropertiesExtended `json:"properties,omitempty"`
}

DeploymentExtended deployment information.

func (DeploymentExtended) MarshalJSON 

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

MarshalJSON is the custom marshaler for DeploymentExtended.

type DeploymentExtendedFilter 

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

DeploymentExtendedFilter deployment filter.

type DeploymentListResult 

type DeploymentListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of deployments.
	Value *[]DeploymentExtended `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

DeploymentListResult list of deployments.

func (DeploymentListResult) IsEmpty 

func (dlr DeploymentListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeploymentListResultIterator 

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

DeploymentListResultIterator provides access to a complete listing of DeploymentExtended values.

func NewDeploymentListResultIterator 

func NewDeploymentListResultIterator(page DeploymentListResultPage) DeploymentListResultIterator

Creates a new instance of the DeploymentListResultIterator type.

func (*DeploymentListResultIterator) Next 

func (iter *DeploymentListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DeploymentListResultIterator) NextWithContext 

func (iter *DeploymentListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (DeploymentListResultIterator) NotDone 

func (iter DeploymentListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (DeploymentListResultIterator) Response 

func (iter DeploymentListResultIterator) Response() DeploymentListResult

Response returns the raw server response from the last page request.

func (DeploymentListResultIterator) Value 

func (iter DeploymentListResultIterator) Value() DeploymentExtended

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type DeploymentListResultPage 

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

DeploymentListResultPage contains a page of DeploymentExtended values.

func NewDeploymentListResultPage 

func NewDeploymentListResultPage(cur DeploymentListResult, getNextPage func(context.Context, DeploymentListResult) (DeploymentListResult, error)) DeploymentListResultPage

Creates a new instance of the DeploymentListResultPage type.

func (*DeploymentListResultPage) Next 

func (page *DeploymentListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DeploymentListResultPage) NextWithContext 

func (page *DeploymentListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (DeploymentListResultPage) NotDone 

func (page DeploymentListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DeploymentListResultPage) Response 

func (page DeploymentListResultPage) Response() DeploymentListResult

Response returns the raw server response from the last page request.

func (DeploymentListResultPage) Values 

func (page DeploymentListResultPage) Values() []DeploymentExtended

Values returns the slice of values for the current page or nil if there are no values.

type DeploymentMode 

type DeploymentMode string

DeploymentMode enumerates the values for deployment mode. 

const (
	// Complete ...
	Complete DeploymentMode = "Complete"
	// Incremental ...
	Incremental DeploymentMode = "Incremental"
)

func PossibleDeploymentModeValues 

func PossibleDeploymentModeValues() []DeploymentMode

PossibleDeploymentModeValues returns an array of possible values for the DeploymentMode const type.

type DeploymentOperation 

type DeploymentOperation struct {
	autorest.Response `json:"-"`
	// ID - Full deployment operation id.
	ID *string `json:"id,omitempty"`
	// OperationID - Deployment operation id.
	OperationID *string `json:"operationId,omitempty"`
	// Properties - Deployment properties.
	Properties *DeploymentOperationProperties `json:"properties,omitempty"`
}

DeploymentOperation deployment operation information.

type DeploymentOperationProperties 

type DeploymentOperationProperties struct {
	// ProvisioningState - The state of the provisioning.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// Timestamp - The date and time of the operation.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// ServiceRequestID - Deployment operation service request id.
	ServiceRequestID *string `json:"serviceRequestId,omitempty"`
	// StatusCode - Operation status code.
	StatusCode *string `json:"statusCode,omitempty"`
	// StatusMessage - Operation status message.
	StatusMessage interface{} `json:"statusMessage,omitempty"`
	// TargetResource - The target resource.
	TargetResource *TargetResource `json:"targetResource,omitempty"`
	// Request - The HTTP request message.
	Request *HTTPMessage `json:"request,omitempty"`
	// Response - The HTTP response message.
	Response *HTTPMessage `json:"response,omitempty"`
}

DeploymentOperationProperties deployment operation properties.

type DeploymentOperationsClient 

type DeploymentOperationsClient struct {
	BaseClient
}

DeploymentOperationsClient is the client for the DeploymentOperations methods of the Resources service.

func NewDeploymentOperationsClient 

func NewDeploymentOperationsClient(subscriptionID string) DeploymentOperationsClient

NewDeploymentOperationsClient creates an instance of the DeploymentOperationsClient client.

func NewDeploymentOperationsClientWithBaseURI 

func NewDeploymentOperationsClientWithBaseURI(baseURI string, subscriptionID string) DeploymentOperationsClient

NewDeploymentOperationsClientWithBaseURI creates an instance of the DeploymentOperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DeploymentOperationsClient) Get 

func (client DeploymentOperationsClient) Get(ctx context.Context, resourceGroupName string, deploymentName string, operationID string) (result DeploymentOperation, err error)

Get get a list of deployments operations. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment. operationID - operation Id.

func (DeploymentOperationsClient) GetPreparer 

func (client DeploymentOperationsClient) GetPreparer(ctx context.Context, resourceGroupName string, deploymentName string, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DeploymentOperationsClient) GetResponder 

func (client DeploymentOperationsClient) GetResponder(resp *http.Response) (result DeploymentOperation, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (DeploymentOperationsClient) GetSender 

func (client DeploymentOperationsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DeploymentOperationsClient) List 

func (client DeploymentOperationsClient) List(ctx context.Context, resourceGroupName string, deploymentName string, top *int32) (result DeploymentOperationsListResultPage, err error)

List gets a list of deployments operations. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment. top - query parameters.

func (DeploymentOperationsClient) ListComplete 

func (client DeploymentOperationsClient) ListComplete(ctx context.Context, resourceGroupName string, deploymentName string, top *int32) (result DeploymentOperationsListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (DeploymentOperationsClient) ListPreparer 

func (client DeploymentOperationsClient) ListPreparer(ctx context.Context, resourceGroupName string, deploymentName string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (DeploymentOperationsClient) ListResponder 

func (client DeploymentOperationsClient) ListResponder(resp *http.Response) (result DeploymentOperationsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (DeploymentOperationsClient) ListSender 

func (client DeploymentOperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type DeploymentOperationsListResult 

type DeploymentOperationsListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of deployments.
	Value *[]DeploymentOperation `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

DeploymentOperationsListResult list of deployment operations.

func (DeploymentOperationsListResult) IsEmpty 

func (dolr DeploymentOperationsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeploymentOperationsListResultIterator 

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

DeploymentOperationsListResultIterator provides access to a complete listing of DeploymentOperation values.

func NewDeploymentOperationsListResultIterator 

func NewDeploymentOperationsListResultIterator(page DeploymentOperationsListResultPage) DeploymentOperationsListResultIterator

Creates a new instance of the DeploymentOperationsListResultIterator type.

func (*DeploymentOperationsListResultIterator) Next 

func (iter *DeploymentOperationsListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DeploymentOperationsListResultIterator) NextWithContext 

func (iter *DeploymentOperationsListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (DeploymentOperationsListResultIterator) NotDone 

func (iter DeploymentOperationsListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (DeploymentOperationsListResultIterator) Response 

func (iter DeploymentOperationsListResultIterator) Response() DeploymentOperationsListResult

Response returns the raw server response from the last page request.

func (DeploymentOperationsListResultIterator) Value 

func (iter DeploymentOperationsListResultIterator) Value() DeploymentOperation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type DeploymentOperationsListResultPage 

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

DeploymentOperationsListResultPage contains a page of DeploymentOperation values.

func NewDeploymentOperationsListResultPage 

func NewDeploymentOperationsListResultPage(cur DeploymentOperationsListResult, getNextPage func(context.Context, DeploymentOperationsListResult) (DeploymentOperationsListResult, error)) DeploymentOperationsListResultPage

Creates a new instance of the DeploymentOperationsListResultPage type.

func (*DeploymentOperationsListResultPage) Next 

func (page *DeploymentOperationsListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DeploymentOperationsListResultPage) NextWithContext 

func (page *DeploymentOperationsListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (DeploymentOperationsListResultPage) NotDone 

func (page DeploymentOperationsListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DeploymentOperationsListResultPage) Response 

func (page DeploymentOperationsListResultPage) Response() DeploymentOperationsListResult

Response returns the raw server response from the last page request.

func (DeploymentOperationsListResultPage) Values 

func (page DeploymentOperationsListResultPage) Values() []DeploymentOperation

Values returns the slice of values for the current page or nil if there are no values.

type DeploymentProperties 

type DeploymentProperties struct {
	// Template - The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink.
	Template interface{} `json:"template,omitempty"`
	// TemplateLink - The template URI. Use only one of Template or TemplateLink.
	TemplateLink *TemplateLink `json:"templateLink,omitempty"`
	// Parameters - Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink.
	Parameters interface{} `json:"parameters,omitempty"`
	// ParametersLink - The parameters URI. Use only one of Parameters or ParametersLink.
	ParametersLink *ParametersLink `json:"parametersLink,omitempty"`
	// Mode - The deployment mode. Possible values include: 'Incremental', 'Complete'
	Mode DeploymentMode `json:"mode,omitempty"`
	// DebugSetting - The debug setting of the deployment.
	DebugSetting *DebugSetting `json:"debugSetting,omitempty"`
}

DeploymentProperties deployment properties.

type DeploymentPropertiesExtended 

type DeploymentPropertiesExtended struct {
	// ProvisioningState - The state of the provisioning.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// CorrelationID - The correlation ID of the deployment.
	CorrelationID *string `json:"correlationId,omitempty"`
	// Timestamp - The timestamp of the template deployment.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Outputs - Key/value pairs that represent deployment output.
	Outputs interface{} `json:"outputs,omitempty"`
	// Providers - The list of resource providers needed for the deployment.
	Providers *[]Provider `json:"providers,omitempty"`
	// Dependencies - The list of deployment dependencies.
	Dependencies *[]Dependency `json:"dependencies,omitempty"`
	// Template - The template content. Use only one of Template or TemplateLink.
	Template interface{} `json:"template,omitempty"`
	// TemplateLink - The URI referencing the template. Use only one of Template or TemplateLink.
	TemplateLink *TemplateLink `json:"templateLink,omitempty"`
	// Parameters - Deployment parameters. Use only one of Parameters or ParametersLink.
	Parameters interface{} `json:"parameters,omitempty"`
	// ParametersLink - The URI referencing the parameters. Use only one of Parameters or ParametersLink.
	ParametersLink *ParametersLink `json:"parametersLink,omitempty"`
	// Mode - The deployment mode. Possible values include: 'Incremental', 'Complete'
	Mode DeploymentMode `json:"mode,omitempty"`
	// DebugSetting - The debug setting of the deployment.
	DebugSetting *DebugSetting `json:"debugSetting,omitempty"`
}

DeploymentPropertiesExtended deployment properties with additional details.

type DeploymentValidateResult 

type DeploymentValidateResult struct {
	autorest.Response `json:"-"`
	// Error - Validation error.
	Error *ManagementErrorWithDetails `json:"error,omitempty"`
	// Properties - The template deployment properties.
	Properties *DeploymentPropertiesExtended `json:"properties,omitempty"`
}

DeploymentValidateResult information from validate template deployment response.

type DeploymentsClient 

type DeploymentsClient struct {
	BaseClient
}

DeploymentsClient is the client for the Deployments methods of the Resources service.

func NewDeploymentsClient 

func NewDeploymentsClient(subscriptionID string) DeploymentsClient

NewDeploymentsClient creates an instance of the DeploymentsClient client.

func NewDeploymentsClientWithBaseURI 

func NewDeploymentsClientWithBaseURI(baseURI string, subscriptionID string) DeploymentsClient

NewDeploymentsClientWithBaseURI creates an instance of the DeploymentsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DeploymentsClient) CalculateTemplateHash 

func (client DeploymentsClient) CalculateTemplateHash(ctx context.Context, templateParameter interface{}) (result TemplateHashResult, err error)

CalculateTemplateHash calculate the hash of the given template. Parameters: templateParameter - the template provided to calculate hash.

func (DeploymentsClient) CalculateTemplateHashPreparer 

func (client DeploymentsClient) CalculateTemplateHashPreparer(ctx context.Context, templateParameter interface{}) (*http.Request, error)

CalculateTemplateHashPreparer prepares the CalculateTemplateHash request.

func (DeploymentsClient) CalculateTemplateHashResponder 

func (client DeploymentsClient) CalculateTemplateHashResponder(resp *http.Response) (result TemplateHashResult, err error)

CalculateTemplateHashResponder handles the response to the CalculateTemplateHash request. The method always closes the http.Response Body.

func (DeploymentsClient) CalculateTemplateHashSender 

func (client DeploymentsClient) CalculateTemplateHashSender(req *http.Request) (*http.Response, error)

CalculateTemplateHashSender sends the CalculateTemplateHash request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) Cancel 

func (client DeploymentsClient) Cancel(ctx context.Context, resourceGroupName string, deploymentName string) (result autorest.Response, err error)

Cancel cancel a currently running template deployment. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment.

func (DeploymentsClient) CancelPreparer 

func (client DeploymentsClient) CancelPreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)

CancelPreparer prepares the Cancel request.

func (DeploymentsClient) CancelResponder 

func (client DeploymentsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)

CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.

func (DeploymentsClient) CancelSender 

func (client DeploymentsClient) CancelSender(req *http.Request) (*http.Response, error)

CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) CheckExistence 

func (client DeploymentsClient) CheckExistence(ctx context.Context, resourceGroupName string, deploymentName string) (result autorest.Response, err error)

CheckExistence checks whether deployment exists. Parameters: resourceGroupName - the name of the resource group to check. The name is case insensitive. deploymentName - the name of the deployment.

func (DeploymentsClient) CheckExistencePreparer 

func (client DeploymentsClient) CheckExistencePreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)

CheckExistencePreparer prepares the CheckExistence request.

func (DeploymentsClient) CheckExistenceResponder 

func (client DeploymentsClient) CheckExistenceResponder(resp *http.Response) (result autorest.Response, err error)

CheckExistenceResponder handles the response to the CheckExistence request. The method always closes the http.Response Body.

func (DeploymentsClient) CheckExistenceSender 

func (client DeploymentsClient) CheckExistenceSender(req *http.Request) (*http.Response, error)

CheckExistenceSender sends the CheckExistence request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) CreateOrUpdate 

func (client DeploymentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment) (result DeploymentsCreateOrUpdateFuture, err error)

CreateOrUpdate create a named template deployment using a template. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment. parameters - additional parameters supplied to the operation.

func (DeploymentsClient) CreateOrUpdatePreparer 

func (client DeploymentsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DeploymentsClient) CreateOrUpdateResponder 

func (client DeploymentsClient) CreateOrUpdateResponder(resp *http.Response) (result DeploymentExtended, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (DeploymentsClient) CreateOrUpdateSender 

func (client DeploymentsClient) CreateOrUpdateSender(req *http.Request) (future DeploymentsCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) Delete 

func (client DeploymentsClient) Delete(ctx context.Context, resourceGroupName string, deploymentName string) (result DeploymentsDeleteFuture, err error)

Delete delete deployment. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment to be deleted.

func (DeploymentsClient) DeletePreparer 

func (client DeploymentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DeploymentsClient) DeleteResponder 

func (client DeploymentsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (DeploymentsClient) DeleteSender 

func (client DeploymentsClient) DeleteSender(req *http.Request) (future DeploymentsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) ExportTemplate 

func (client DeploymentsClient) ExportTemplate(ctx context.Context, resourceGroupName string, deploymentName string) (result DeploymentExportResult, err error)

ExportTemplate exports a deployment template. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment.

func (DeploymentsClient) ExportTemplatePreparer 

func (client DeploymentsClient) ExportTemplatePreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)

ExportTemplatePreparer prepares the ExportTemplate request.

func (DeploymentsClient) ExportTemplateResponder 

func (client DeploymentsClient) ExportTemplateResponder(resp *http.Response) (result DeploymentExportResult, err error)

ExportTemplateResponder handles the response to the ExportTemplate request. The method always closes the http.Response Body.

func (DeploymentsClient) ExportTemplateSender 

func (client DeploymentsClient) ExportTemplateSender(req *http.Request) (*http.Response, error)

ExportTemplateSender sends the ExportTemplate request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) Get 

func (client DeploymentsClient) Get(ctx context.Context, resourceGroupName string, deploymentName string) (result DeploymentExtended, err error)

Get get a deployment. Parameters: resourceGroupName - the name of the resource group to get. The name is case insensitive. deploymentName - the name of the deployment.

func (DeploymentsClient) GetPreparer 

func (client DeploymentsClient) GetPreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DeploymentsClient) GetResponder 

func (client DeploymentsClient) GetResponder(resp *http.Response) (result DeploymentExtended, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (DeploymentsClient) GetSender 

func (client DeploymentsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) List 

func (client DeploymentsClient) List(ctx context.Context, resourceGroupName string, filter string, top *int32) (result DeploymentListResultPage, err error)

List get a list of deployments. Parameters: resourceGroupName - the name of the resource group to filter by. The name is case insensitive. filter - the filter to apply on the operation. top - query parameters. If null is passed returns all deployments.

func (DeploymentsClient) ListComplete 

func (client DeploymentsClient) ListComplete(ctx context.Context, resourceGroupName string, filter string, top *int32) (result DeploymentListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (DeploymentsClient) ListPreparer 

func (client DeploymentsClient) ListPreparer(ctx context.Context, resourceGroupName string, filter string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (DeploymentsClient) ListResponder 

func (client DeploymentsClient) ListResponder(resp *http.Response) (result DeploymentListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (DeploymentsClient) ListSender 

func (client DeploymentsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (DeploymentsClient) Validate 

func (client DeploymentsClient) Validate(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment) (result DeploymentValidateResult, err error)

Validate validate a deployment template. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment. parameters - deployment to validate.

func (DeploymentsClient) ValidatePreparer 

func (client DeploymentsClient) ValidatePreparer(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment) (*http.Request, error)

ValidatePreparer prepares the Validate request.

func (DeploymentsClient) ValidateResponder 

func (client DeploymentsClient) ValidateResponder(resp *http.Response) (result DeploymentValidateResult, err error)

ValidateResponder handles the response to the Validate request. The method always closes the http.Response Body.

func (DeploymentsClient) ValidateSender 

func (client DeploymentsClient) ValidateSender(req *http.Request) (*http.Response, error)

ValidateSender sends the Validate request. The method will close the http.Response Body if it receives an error.

type DeploymentsCreateOrUpdateFuture 

type DeploymentsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DeploymentsClient) (DeploymentExtended, error)
}

DeploymentsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type DeploymentsDeleteFuture 

type DeploymentsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DeploymentsClient) (autorest.Response, error)
}

DeploymentsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// Type - READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty"`
	// Info - READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

type ErrorResponse 

type ErrorResponse struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]ErrorResponse `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

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

type ExportTemplateRequest 

type ExportTemplateRequest struct {
	// ResourcesProperty - The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'.
	ResourcesProperty *[]string `json:"resources,omitempty"`
	// Options - The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'
	Options *string `json:"options,omitempty"`
}

ExportTemplateRequest export resource group template request parameters.

type GenericResource 

type GenericResource struct {
	autorest.Response `json:"-"`
	// Plan - The plan of the resource.
	Plan *Plan `json:"plan,omitempty"`
	// Properties - The resource properties.
	Properties interface{} `json:"properties,omitempty"`
	// Kind - The kind of the resource.
	Kind *string `json:"kind,omitempty"`
	// ManagedBy - Id of the resource that manages this resource.
	ManagedBy *string `json:"managedBy,omitempty"`
	// Sku - The sku of the resource.
	Sku *Sku `json:"sku,omitempty"`
	// Identity - The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

GenericResource resource information.

func (GenericResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for GenericResource.

type GenericResourceExpanded 

type GenericResourceExpanded struct {
	// CreatedTime - READ-ONLY; The created time of the resource. This is only present if requested via the $expand query parameter.
	CreatedTime *date.Time `json:"createdTime,omitempty"`
	// ChangedTime - READ-ONLY; The changed time of the resource. This is only present if requested via the $expand query parameter.
	ChangedTime *date.Time `json:"changedTime,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state of the resource. This is only present if requested via the $expand query parameter.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// Plan - The plan of the resource.
	Plan *Plan `json:"plan,omitempty"`
	// Properties - The resource properties.
	Properties interface{} `json:"properties,omitempty"`
	// Kind - The kind of the resource.
	Kind *string `json:"kind,omitempty"`
	// ManagedBy - Id of the resource that manages this resource.
	ManagedBy *string `json:"managedBy,omitempty"`
	// Sku - The sku of the resource.
	Sku *Sku `json:"sku,omitempty"`
	// Identity - The identity of the resource.
	Identity *Identity `json:"identity,omitempty"`
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

GenericResourceExpanded resource information.

func (GenericResourceExpanded) MarshalJSON 

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

MarshalJSON is the custom marshaler for GenericResourceExpanded.

type GenericResourceFilter 

type GenericResourceFilter struct {
	// ResourceType - The resource type.
	ResourceType *string `json:"resourceType,omitempty"`
	// Tagname - The tag name.
	Tagname *string `json:"tagname,omitempty"`
	// Tagvalue - The tag value.
	Tagvalue *string `json:"tagvalue,omitempty"`
}

GenericResourceFilter resource filter.

type Group 

type Group struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The ID of the resource group.
	ID *string `json:"id,omitempty"`
	// Name - The Name of the resource group.
	Name       *string          `json:"name,omitempty"`
	Properties *GroupProperties `json:"properties,omitempty"`
	// Location - The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc.
	Location *string `json:"location,omitempty"`
	// Tags - The tags attached to the resource group.
	Tags map[string]*string `json:"tags"`
}

Group resource group information.

func (Group) MarshalJSON 

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

MarshalJSON is the custom marshaler for Group.

type GroupExportResult 

type GroupExportResult struct {
	autorest.Response `json:"-"`
	// Template - The template content.
	Template interface{} `json:"template,omitempty"`
	// Error - The error.
	Error *ManagementErrorWithDetails `json:"error,omitempty"`
}

GroupExportResult ...

type GroupFilter 

type GroupFilter struct {
	// TagName - The tag name.
	TagName *string `json:"tagName,omitempty"`
	// TagValue - The tag value.
	TagValue *string `json:"tagValue,omitempty"`
}

GroupFilter resource group filter.

type GroupListResult 

type GroupListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of resource groups.
	Value *[]Group `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

GroupListResult list of resource groups.

func (GroupListResult) IsEmpty 

func (glr GroupListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type GroupListResultIterator 

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

GroupListResultIterator provides access to a complete listing of Group values.

func NewGroupListResultIterator 

func NewGroupListResultIterator(page GroupListResultPage) GroupListResultIterator

Creates a new instance of the GroupListResultIterator type.

func (*GroupListResultIterator) Next 

func (iter *GroupListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*GroupListResultIterator) NextWithContext 

func (iter *GroupListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (GroupListResultIterator) NotDone 

func (iter GroupListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (GroupListResultIterator) Response 

func (iter GroupListResultIterator) Response() GroupListResult

Response returns the raw server response from the last page request.

func (GroupListResultIterator) Value 

func (iter GroupListResultIterator) Value() Group

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type GroupListResultPage 

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

GroupListResultPage contains a page of Group values.

func NewGroupListResultPage 

func NewGroupListResultPage(cur GroupListResult, getNextPage func(context.Context, GroupListResult) (GroupListResult, error)) GroupListResultPage

Creates a new instance of the GroupListResultPage type.

func (*GroupListResultPage) Next 

func (page *GroupListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*GroupListResultPage) NextWithContext 

func (page *GroupListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (GroupListResultPage) NotDone 

func (page GroupListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (GroupListResultPage) Response 

func (page GroupListResultPage) Response() GroupListResult

Response returns the raw server response from the last page request.

func (GroupListResultPage) Values 

func (page GroupListResultPage) Values() []Group

Values returns the slice of values for the current page or nil if there are no values.

type GroupProperties 

type GroupProperties struct {
	// ProvisioningState - READ-ONLY; The provisioning state.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

GroupProperties the resource group properties.

type GroupsClient 

type GroupsClient struct {
	BaseClient
}

GroupsClient is the client for the Groups methods of the Resources service.

func NewGroupsClient 

func NewGroupsClient(subscriptionID string) GroupsClient

NewGroupsClient creates an instance of the GroupsClient client.

func NewGroupsClientWithBaseURI 

func NewGroupsClientWithBaseURI(baseURI string, subscriptionID string) GroupsClient

NewGroupsClientWithBaseURI creates an instance of the GroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (GroupsClient) CheckExistence 

func (client GroupsClient) CheckExistence(ctx context.Context, resourceGroupName string) (result autorest.Response, err error)

CheckExistence checks whether resource group exists. Parameters: resourceGroupName - the name of the resource group to check. The name is case insensitive.

func (GroupsClient) CheckExistencePreparer 

func (client GroupsClient) CheckExistencePreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

CheckExistencePreparer prepares the CheckExistence request.

func (GroupsClient) CheckExistenceResponder 

func (client GroupsClient) CheckExistenceResponder(resp *http.Response) (result autorest.Response, err error)

CheckExistenceResponder handles the response to the CheckExistence request. The method always closes the http.Response Body.

func (GroupsClient) CheckExistenceSender 

func (client GroupsClient) CheckExistenceSender(req *http.Request) (*http.Response, error)

CheckExistenceSender sends the CheckExistence request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) CreateOrUpdate 

func (client GroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, parameters Group) (result Group, err error)

CreateOrUpdate create a resource group. Parameters: resourceGroupName - the name of the resource group to be created or updated. parameters - parameters supplied to the create or update resource group service operation.

func (GroupsClient) CreateOrUpdatePreparer 

func (client GroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, parameters Group) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupsClient) CreateOrUpdateResponder 

func (client GroupsClient) CreateOrUpdateResponder(resp *http.Response) (result Group, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (GroupsClient) CreateOrUpdateSender 

func (client GroupsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) Delete 

func (client GroupsClient) Delete(ctx context.Context, resourceGroupName string) (result GroupsDeleteFuture, err error)

Delete delete resource group. Parameters: resourceGroupName - the name of the resource group to be deleted. The name is case insensitive.

func (GroupsClient) DeletePreparer 

func (client GroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupsClient) DeleteResponder 

func (client GroupsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (GroupsClient) DeleteSender 

func (client GroupsClient) DeleteSender(req *http.Request) (future GroupsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) ExportTemplate 

func (client GroupsClient) ExportTemplate(ctx context.Context, resourceGroupName string, parameters ExportTemplateRequest) (result GroupExportResult, err error)

ExportTemplate captures the specified resource group as a template. Parameters: resourceGroupName - the name of the resource group to be created or updated. parameters - parameters supplied to the export template resource group operation.

func (GroupsClient) ExportTemplatePreparer 

func (client GroupsClient) ExportTemplatePreparer(ctx context.Context, resourceGroupName string, parameters ExportTemplateRequest) (*http.Request, error)

ExportTemplatePreparer prepares the ExportTemplate request.

func (GroupsClient) ExportTemplateResponder 

func (client GroupsClient) ExportTemplateResponder(resp *http.Response) (result GroupExportResult, err error)

ExportTemplateResponder handles the response to the ExportTemplate request. The method always closes the http.Response Body.

func (GroupsClient) ExportTemplateSender 

func (client GroupsClient) ExportTemplateSender(req *http.Request) (*http.Response, error)

ExportTemplateSender sends the ExportTemplate request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) Get 

func (client GroupsClient) Get(ctx context.Context, resourceGroupName string) (result Group, err error)

Get get a resource group. Parameters: resourceGroupName - the name of the resource group to get. The name is case insensitive.

func (GroupsClient) GetPreparer 

func (client GroupsClient) GetPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupsClient) GetResponder 

func (client GroupsClient) GetResponder(resp *http.Response) (result Group, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (GroupsClient) GetSender 

func (client GroupsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) List 

func (client GroupsClient) List(ctx context.Context, filter string, top *int32) (result GroupListResultPage, err error)

List gets a collection of resource groups. Parameters: filter - the filter to apply on the operation. top - query parameters. If null is passed returns all resource groups.

func (GroupsClient) ListComplete 

func (client GroupsClient) ListComplete(ctx context.Context, filter string, top *int32) (result GroupListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (GroupsClient) ListPreparer 

func (client GroupsClient) ListPreparer(ctx context.Context, filter string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupsClient) ListResources 

func (client GroupsClient) ListResources(ctx context.Context, resourceGroupName string, filter string, expand string, top *int32) (result ListResultPage, err error)

ListResources get all of the resources under a subscription. Parameters: resourceGroupName - query parameters. If null is passed returns all resource groups. filter - the filter to apply on the operation. expand - comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. top - query parameters. If null is passed returns all resource groups.

func (GroupsClient) ListResourcesComplete 

func (client GroupsClient) ListResourcesComplete(ctx context.Context, resourceGroupName string, filter string, expand string, top *int32) (result ListResultIterator, err error)

ListResourcesComplete enumerates all values, automatically crossing page boundaries as required.

func (GroupsClient) ListResourcesPreparer 

func (client GroupsClient) ListResourcesPreparer(ctx context.Context, resourceGroupName string, filter string, expand string, top *int32) (*http.Request, error)

ListResourcesPreparer prepares the ListResources request.

func (GroupsClient) ListResourcesResponder 

func (client GroupsClient) ListResourcesResponder(resp *http.Response) (result ListResult, err error)

ListResourcesResponder handles the response to the ListResources request. The method always closes the http.Response Body.

func (GroupsClient) ListResourcesSender 

func (client GroupsClient) ListResourcesSender(req *http.Request) (*http.Response, error)

ListResourcesSender sends the ListResources request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) ListResponder 

func (client GroupsClient) ListResponder(resp *http.Response) (result GroupListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (GroupsClient) ListSender 

func (client GroupsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) Patch 

func (client GroupsClient) Patch(ctx context.Context, resourceGroupName string, parameters Group) (result Group, err error)

Patch 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 groups, though if a field is unspecified current value will be carried over. Parameters: resourceGroupName - the name of the resource group to be created or updated. The name is case insensitive. parameters - parameters supplied to the update state resource group service operation.

func (GroupsClient) PatchPreparer 

func (client GroupsClient) PatchPreparer(ctx context.Context, resourceGroupName string, parameters Group) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (GroupsClient) PatchResponder 

func (client GroupsClient) PatchResponder(resp *http.Response) (result Group, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (GroupsClient) PatchSender 

func (client GroupsClient) PatchSender(req *http.Request) (*http.Response, error)

PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.

type GroupsDeleteFuture 

type GroupsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(GroupsClient) (autorest.Response, error)
}

GroupsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type HTTPMessage 

type HTTPMessage struct {
	// Content - HTTP message content.
	Content interface{} `json:"content,omitempty"`
}

HTTPMessage ...

type Identity 

type Identity struct {
	// PrincipalID - READ-ONLY; The principal id of resource identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant id of resource.
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The identity type. Possible values include: 'SystemAssigned'
	Type ResourceIdentityType `json:"type,omitempty"`
}

Identity identity for the resource.

func (Identity) MarshalJSON 

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

MarshalJSON is the custom marshaler for Identity.

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of resources.
	Value *[]GenericResourceExpanded `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ListResult list of resource groups.

func (ListResult) IsEmpty 

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListResultIterator 

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

ListResultIterator provides access to a complete listing of GenericResourceExpanded values.

func NewListResultIterator 

func NewListResultIterator(page ListResultPage) ListResultIterator

Creates a new instance of the ListResultIterator type.

func (*ListResultIterator) Next 

func (iter *ListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListResultIterator) NextWithContext 

func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ListResultIterator) NotDone 

func (iter ListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListResultIterator) Response 

func (iter ListResultIterator) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultIterator) Value 

func (iter ListResultIterator) Value() GenericResourceExpanded

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ListResultPage 

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

ListResultPage contains a page of GenericResourceExpanded values.

func NewListResultPage 

func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage

Creates a new instance of the ListResultPage type.

func (*ListResultPage) Next 

func (page *ListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListResultPage) NextWithContext 

func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ListResultPage) NotDone 

func (page ListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListResultPage) Response 

func (page ListResultPage) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultPage) Values 

func (page ListResultPage) Values() []GenericResourceExpanded

Values returns the slice of values for the current page or nil if there are no values.

type ManagementErrorWithDetails 

type ManagementErrorWithDetails struct {
	// Code - The error code returned from the server.
	Code *string `json:"code,omitempty"`
	// Message - The error message returned from the server.
	Message *string `json:"message,omitempty"`
	// Target - The target of the error.
	Target *string `json:"target,omitempty"`
	// Details - Validation error.
	Details *[]ManagementErrorWithDetails `json:"details,omitempty"`
}

ManagementErrorWithDetails ...

type MoveInfo 

type MoveInfo struct {
	// ResourcesProperty - The ids of the resources.
	ResourcesProperty *[]string `json:"resources,omitempty"`
	// TargetResourceGroup - The target resource group.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
}

MoveInfo parameters of move resources.

type MoveResourcesFuture 

type MoveResourcesFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (autorest.Response, error)
}

MoveResourcesFuture an abstraction for monitoring and retrieving the results of a long-running operation. 

type ParametersLink struct {
	// URI - URI referencing the template.
	URI *string `json:"uri,omitempty"`
	// ContentVersion - If included it must match the ContentVersion in the template.
	ContentVersion *string `json:"contentVersion,omitempty"`
}

ParametersLink entity representing the reference to the deployment parameters.

type Plan 

type Plan struct {
	// Name - The plan ID.
	Name *string `json:"name,omitempty"`
	// Publisher - The publisher ID.
	Publisher *string `json:"publisher,omitempty"`
	// Product - The offer ID.
	Product *string `json:"product,omitempty"`
	// PromotionCode - The promotion code.
	PromotionCode *string `json:"promotionCode,omitempty"`
}

Plan plan for the resource.

type Provider 

type Provider struct {
	autorest.Response `json:"-"`
	// ID - The provider id.
	ID *string `json:"id,omitempty"`
	// Namespace - The namespace of the provider.
	Namespace *string `json:"namespace,omitempty"`
	// RegistrationState - The registration state of the provider.
	RegistrationState *string `json:"registrationState,omitempty"`
	// ResourceTypes - The collection of provider resource types.
	ResourceTypes *[]ProviderResourceType `json:"resourceTypes,omitempty"`
}

Provider resource provider information.

type ProviderListResult 

type ProviderListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of resource providers.
	Value *[]Provider `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ProviderListResult list of resource providers.

func (ProviderListResult) IsEmpty 

func (plr ProviderListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ProviderListResultIterator 

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

ProviderListResultIterator provides access to a complete listing of Provider values.

func NewProviderListResultIterator 

func NewProviderListResultIterator(page ProviderListResultPage) ProviderListResultIterator

Creates a new instance of the ProviderListResultIterator type.

func (*ProviderListResultIterator) Next 

func (iter *ProviderListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ProviderListResultIterator) NextWithContext 

func (iter *ProviderListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ProviderListResultIterator) NotDone 

func (iter ProviderListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ProviderListResultIterator) Response 

func (iter ProviderListResultIterator) Response() ProviderListResult

Response returns the raw server response from the last page request.

func (ProviderListResultIterator) Value 

func (iter ProviderListResultIterator) Value() Provider

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ProviderListResultPage 

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

ProviderListResultPage contains a page of Provider values.

func NewProviderListResultPage 

func NewProviderListResultPage(cur ProviderListResult, getNextPage func(context.Context, ProviderListResult) (ProviderListResult, error)) ProviderListResultPage

Creates a new instance of the ProviderListResultPage type.

func (*ProviderListResultPage) Next 

func (page *ProviderListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ProviderListResultPage) NextWithContext 

func (page *ProviderListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ProviderListResultPage) NotDone 

func (page ProviderListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ProviderListResultPage) Response 

func (page ProviderListResultPage) Response() ProviderListResult

Response returns the raw server response from the last page request.

func (ProviderListResultPage) Values 

func (page ProviderListResultPage) Values() []Provider

Values returns the slice of values for the current page or nil if there are no values.

type ProviderOperationDisplayProperties 

type ProviderOperationDisplayProperties struct {
	// Publisher - Operation description.
	Publisher *string `json:"publisher,omitempty"`
	// Provider - Operation provider.
	Provider *string `json:"provider,omitempty"`
	// Resource - Operation resource.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation.
	Operation *string `json:"operation,omitempty"`
	// Description - Operation description.
	Description *string `json:"description,omitempty"`
}

ProviderOperationDisplayProperties resource provider operation's display properties.

type ProviderResourceType 

type ProviderResourceType struct {
	// ResourceType - The resource type.
	ResourceType *string `json:"resourceType,omitempty"`
	// Locations - The collection of locations where this resource type can be created in.
	Locations *[]string `json:"locations,omitempty"`
	// Aliases - The aliases that are supported by this resource type.
	Aliases *[]AliasType `json:"aliases,omitempty"`
	// APIVersions - The api version.
	APIVersions *[]string `json:"apiVersions,omitempty"`
	// Properties - The properties.
	Properties map[string]*string `json:"properties"`
}

ProviderResourceType resource type managed by the resource provider.

func (ProviderResourceType) MarshalJSON 

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

MarshalJSON is the custom marshaler for ProviderResourceType.

type ProvidersClient 

type ProvidersClient struct {
	BaseClient
}

ProvidersClient is the client for the Providers methods of the Resources service.

func NewProvidersClient 

func NewProvidersClient(subscriptionID string) ProvidersClient

NewProvidersClient creates an instance of the ProvidersClient client.

func NewProvidersClientWithBaseURI 

func NewProvidersClientWithBaseURI(baseURI string, subscriptionID string) ProvidersClient

NewProvidersClientWithBaseURI creates an instance of the ProvidersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ProvidersClient) Get 

func (client ProvidersClient) Get(ctx context.Context, resourceProviderNamespace string, expand string) (result Provider, err error)

Get gets a resource provider. Parameters: resourceProviderNamespace - namespace of the resource provider. expand - the $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases.

func (ProvidersClient) GetPreparer 

func (client ProvidersClient) GetPreparer(ctx context.Context, resourceProviderNamespace string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProvidersClient) GetResponder 

func (client ProvidersClient) GetResponder(resp *http.Response) (result Provider, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ProvidersClient) GetSender 

func (client ProvidersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ProvidersClient) List 

func (client ProvidersClient) List(ctx context.Context, top *int32, expand string) (result ProviderListResultPage, err error)

List gets a list of resource providers. Parameters: top - query parameters. If null is passed returns all deployments. expand - the $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases.

func (ProvidersClient) ListComplete 

func (client ProvidersClient) ListComplete(ctx context.Context, top *int32, expand string) (result ProviderListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ProvidersClient) ListPreparer 

func (client ProvidersClient) ListPreparer(ctx context.Context, top *int32, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (ProvidersClient) ListResponder 

func (client ProvidersClient) ListResponder(resp *http.Response) (result ProviderListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ProvidersClient) ListSender 

func (client ProvidersClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (ProvidersClient) Register 

func (client ProvidersClient) Register(ctx context.Context, resourceProviderNamespace string) (result Provider, err error)

Register registers provider to be used with a subscription. Parameters: resourceProviderNamespace - namespace of the resource provider.

func (ProvidersClient) RegisterPreparer 

func (client ProvidersClient) RegisterPreparer(ctx context.Context, resourceProviderNamespace string) (*http.Request, error)

RegisterPreparer prepares the Register request.

func (ProvidersClient) RegisterResponder 

func (client ProvidersClient) RegisterResponder(resp *http.Response) (result Provider, err error)

RegisterResponder handles the response to the Register request. The method always closes the http.Response Body.

func (ProvidersClient) RegisterSender 

func (client ProvidersClient) RegisterSender(req *http.Request) (*http.Response, error)

RegisterSender sends the Register request. The method will close the http.Response Body if it receives an error.

func (ProvidersClient) Unregister 

func (client ProvidersClient) Unregister(ctx context.Context, resourceProviderNamespace string) (result Provider, err error)

Unregister unregisters provider from a subscription. Parameters: resourceProviderNamespace - namespace of the resource provider.

func (ProvidersClient) UnregisterPreparer 

func (client ProvidersClient) UnregisterPreparer(ctx context.Context, resourceProviderNamespace string) (*http.Request, error)

UnregisterPreparer prepares the Unregister request.

func (ProvidersClient) UnregisterResponder 

func (client ProvidersClient) UnregisterResponder(resp *http.Response) (result Provider, err error)

UnregisterResponder handles the response to the Unregister request. The method always closes the http.Response Body.

func (ProvidersClient) UnregisterSender 

func (client ProvidersClient) UnregisterSender(req *http.Request) (*http.Response, error)

UnregisterSender sends the Unregister request. The method will close the http.Response Body if it receives an error.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

Resource ...

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType enumerates the values for resource identity type. 

const (
	// SystemAssigned ...
	SystemAssigned ResourceIdentityType = "SystemAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.

type Sku 

type Sku struct {
	// Name - The sku name.
	Name *string `json:"name,omitempty"`
	// Tier - The sku tier.
	Tier *string `json:"tier,omitempty"`
	// Size - The sku size.
	Size *string `json:"size,omitempty"`
	// Family - The sku family.
	Family *string `json:"family,omitempty"`
	// Model - The sku model.
	Model *string `json:"model,omitempty"`
	// Capacity - The sku capacity.
	Capacity *int32 `json:"capacity,omitempty"`
}

Sku sku for the resource.

type SubResource 

type SubResource struct {
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
}

SubResource ...

type TagCount 

type TagCount struct {
	// Type - Type of count.
	Type *string `json:"type,omitempty"`
	// Value - Value of count.
	Value *string `json:"value,omitempty"`
}

TagCount tag count.

type TagDetails 

type TagDetails struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The tag ID.
	ID *string `json:"id,omitempty"`
	// TagName - The tag name.
	TagName *string `json:"tagName,omitempty"`
	// Count - The tag count.
	Count *TagCount `json:"count,omitempty"`
	// Values - The list of tag values.
	Values *[]TagValue `json:"values,omitempty"`
}

TagDetails tag details.

func (TagDetails) MarshalJSON 

func (td TagDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagDetails.

type TagValue 

type TagValue struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The tag ID.
	ID *string `json:"id,omitempty"`
	// TagValue - The tag value.
	TagValue *string `json:"tagValue,omitempty"`
	// Count - The tag value count.
	Count *TagCount `json:"count,omitempty"`
}

TagValue tag information.

func (TagValue) MarshalJSON 

func (tv TagValue) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagValue.

type TagsClient 

type TagsClient struct {
	BaseClient
}

TagsClient is the client for the Tags methods of the Resources service.

func NewTagsClient 

func NewTagsClient(subscriptionID string) TagsClient

NewTagsClient creates an instance of the TagsClient client.

func NewTagsClientWithBaseURI 

func NewTagsClientWithBaseURI(baseURI string, subscriptionID string) TagsClient

NewTagsClientWithBaseURI creates an instance of the TagsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (TagsClient) CreateOrUpdate 

func (client TagsClient) CreateOrUpdate(ctx context.Context, tagName string) (result TagDetails, err error)

CreateOrUpdate create a subscription resource tag. Parameters: tagName - the name of the tag.

func (TagsClient) CreateOrUpdatePreparer 

func (client TagsClient) CreateOrUpdatePreparer(ctx context.Context, tagName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TagsClient) CreateOrUpdateResponder 

func (client TagsClient) CreateOrUpdateResponder(resp *http.Response) (result TagDetails, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (TagsClient) CreateOrUpdateSender 

func (client TagsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (TagsClient) CreateOrUpdateValue 

func (client TagsClient) CreateOrUpdateValue(ctx context.Context, tagName string, tagValue string) (result TagValue, err error)

CreateOrUpdateValue create a subscription resource tag value. Parameters: tagName - the name of the tag. tagValue - the value of the tag.

func (TagsClient) CreateOrUpdateValuePreparer 

func (client TagsClient) CreateOrUpdateValuePreparer(ctx context.Context, tagName string, tagValue string) (*http.Request, error)

CreateOrUpdateValuePreparer prepares the CreateOrUpdateValue request.

func (TagsClient) CreateOrUpdateValueResponder 

func (client TagsClient) CreateOrUpdateValueResponder(resp *http.Response) (result TagValue, err error)

CreateOrUpdateValueResponder handles the response to the CreateOrUpdateValue request. The method always closes the http.Response Body.

func (TagsClient) CreateOrUpdateValueSender 

func (client TagsClient) CreateOrUpdateValueSender(req *http.Request) (*http.Response, error)

CreateOrUpdateValueSender sends the CreateOrUpdateValue request. The method will close the http.Response Body if it receives an error.

func (TagsClient) Delete 

func (client TagsClient) Delete(ctx context.Context, tagName string) (result autorest.Response, err error)

Delete delete a subscription resource tag. Parameters: tagName - the name of the tag.

func (TagsClient) DeletePreparer 

func (client TagsClient) DeletePreparer(ctx context.Context, tagName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (TagsClient) DeleteResponder 

func (client TagsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (TagsClient) DeleteSender 

func (client TagsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (TagsClient) DeleteValue 

func (client TagsClient) DeleteValue(ctx context.Context, tagName string, tagValue string) (result autorest.Response, err error)

DeleteValue delete a subscription resource tag value. Parameters: tagName - the name of the tag. tagValue - the value of the tag.

func (TagsClient) DeleteValuePreparer 

func (client TagsClient) DeleteValuePreparer(ctx context.Context, tagName string, tagValue string) (*http.Request, error)

DeleteValuePreparer prepares the DeleteValue request.

func (TagsClient) DeleteValueResponder 

func (client TagsClient) DeleteValueResponder(resp *http.Response) (result autorest.Response, err error)

DeleteValueResponder handles the response to the DeleteValue request. The method always closes the http.Response Body.

func (TagsClient) DeleteValueSender 

func (client TagsClient) DeleteValueSender(req *http.Request) (*http.Response, error)

DeleteValueSender sends the DeleteValue request. The method will close the http.Response Body if it receives an error.

func (TagsClient) List 

func (client TagsClient) List(ctx context.Context) (result TagsListResultPage, err error)

List get a list of subscription resource tags.

func (TagsClient) ListComplete 

func (client TagsClient) ListComplete(ctx context.Context) (result TagsListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (TagsClient) ListPreparer 

func (client TagsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (TagsClient) ListResponder 

func (client TagsClient) ListResponder(resp *http.Response) (result TagsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (TagsClient) ListSender 

func (client TagsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type TagsListResult 

type TagsListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of tags.
	Value *[]TagDetails `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

TagsListResult list of subscription tags.

func (TagsListResult) IsEmpty 

func (tlr TagsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type TagsListResultIterator 

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

TagsListResultIterator provides access to a complete listing of TagDetails values.

func NewTagsListResultIterator 

func NewTagsListResultIterator(page TagsListResultPage) TagsListResultIterator

Creates a new instance of the TagsListResultIterator type.

func (*TagsListResultIterator) Next 

func (iter *TagsListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*TagsListResultIterator) NextWithContext 

func (iter *TagsListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (TagsListResultIterator) NotDone 

func (iter TagsListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (TagsListResultIterator) Response 

func (iter TagsListResultIterator) Response() TagsListResult

Response returns the raw server response from the last page request.

func (TagsListResultIterator) Value 

func (iter TagsListResultIterator) Value() TagDetails

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type TagsListResultPage 

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

TagsListResultPage contains a page of TagDetails values.

func NewTagsListResultPage 

func NewTagsListResultPage(cur TagsListResult, getNextPage func(context.Context, TagsListResult) (TagsListResult, error)) TagsListResultPage

Creates a new instance of the TagsListResultPage type.

func (*TagsListResultPage) Next 

func (page *TagsListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*TagsListResultPage) NextWithContext 

func (page *TagsListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (TagsListResultPage) NotDone 

func (page TagsListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (TagsListResultPage) Response 

func (page TagsListResultPage) Response() TagsListResult

Response returns the raw server response from the last page request.

func (TagsListResultPage) Values 

func (page TagsListResultPage) Values() []TagDetails

Values returns the slice of values for the current page or nil if there are no values.

type TargetResource 

type TargetResource struct {
	// ID - The ID of the resource.
	ID *string `json:"id,omitempty"`
	// ResourceName - The name of the resource.
	ResourceName *string `json:"resourceName,omitempty"`
	// ResourceType - The type of the resource.
	ResourceType *string `json:"resourceType,omitempty"`
}

TargetResource target resource.

type TemplateHashResult 

type TemplateHashResult struct {
	autorest.Response `json:"-"`
	// MinifiedTemplate - The minified template string.
	MinifiedTemplate *string `json:"minifiedTemplate,omitempty"`
	// TemplateHash - 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 {
	// URI - URI referencing the template.
	URI *string `json:"uri,omitempty"`
	// ContentVersion - If included it must match the ContentVersion in the template.
	ContentVersion *string `json:"contentVersion,omitempty"`
}

TemplateLink entity representing the reference to the template.

type UpdateFuture 

type UpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (GenericResource, error)
}

UpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.