resources

package
v26.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2019 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package resources implements the Azure ARM Resources service API version 2017-05-10.

Provides operations for working with resources and resource groups.

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 the type of the paths for alias.

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 the alias type.

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.

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 provides operations for working with resources and resource groups.

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.

func (Client) CheckExistence 

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

CheckExistence checks whether a resource exists. Parameters: resourceGroupName - the name of the resource group containing the resource to check. The name is case insensitive. resourceProviderNamespace - the resource provider of the resource to check. parentResourcePath - the parent resource identity. resourceType - the resource type. resourceName - the name of the resource to check whether it exists.

func (Client) CheckExistenceByID 

func (client Client) CheckExistenceByID(ctx context.Context, resourceID string) (result autorest.Response, err error)

CheckExistenceByID checks by ID whether a resource exists. Parameters: resourceID - the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

func (Client) CheckExistenceByIDPreparer 

func (client Client) CheckExistenceByIDPreparer(ctx context.Context, resourceID string) (*http.Request, error)

CheckExistenceByIDPreparer prepares the CheckExistenceByID request.

func (Client) CheckExistenceByIDResponder 

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

CheckExistenceByIDResponder handles the response to the CheckExistenceByID request. The method always closes the http.Response Body.

func (Client) CheckExistenceByIDSender 

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

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

func (Client) CheckExistencePreparer 

func (client Client) CheckExistencePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName 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, parameters GenericResource) (result CreateOrUpdateFuture, err error)

CreateOrUpdate creates 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 create. resourceName - the name of the resource to create. parameters - parameters for creating or updating the resource.

func (Client) CreateOrUpdateByID 

func (client Client) CreateOrUpdateByID(ctx context.Context, resourceID string, parameters GenericResource) (result CreateOrUpdateByIDFuture, err error)

CreateOrUpdateByID create a resource by ID. Parameters: resourceID - the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} parameters - create or update resource parameters.

func (Client) CreateOrUpdateByIDPreparer 

func (client Client) CreateOrUpdateByIDPreparer(ctx context.Context, resourceID string, parameters GenericResource) (*http.Request, error)

CreateOrUpdateByIDPreparer prepares the CreateOrUpdateByID request.

func (Client) CreateOrUpdateByIDResponder 

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

CreateOrUpdateByIDResponder handles the response to the CreateOrUpdateByID request. The method always closes the http.Response Body.

func (Client) CreateOrUpdateByIDSender 

func (client Client) CreateOrUpdateByIDSender(req *http.Request) (future CreateOrUpdateByIDFuture, err error)

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

func (Client) CreateOrUpdatePreparer 

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName 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) (future CreateOrUpdateFuture, err 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) (result DeleteFuture, err error)

Delete deletes a resource. Parameters: resourceGroupName - the name of the resource group that contains the resource to delete. The name is case insensitive. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - the parent resource identity. resourceType - the resource type. resourceName - the name of the resource to delete.

func (Client) DeleteByID 

func (client Client) DeleteByID(ctx context.Context, resourceID string) (result DeleteByIDFuture, err error)

DeleteByID deletes a resource by ID. Parameters: resourceID - the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

func (Client) DeleteByIDPreparer 

func (client Client) DeleteByIDPreparer(ctx context.Context, resourceID string) (*http.Request, error)

DeleteByIDPreparer prepares the DeleteByID request.

func (Client) DeleteByIDResponder 

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

DeleteByIDResponder handles the response to the DeleteByID request. The method always closes the http.Response Body.

func (Client) DeleteByIDSender 

func (client Client) DeleteByIDSender(req *http.Request) (future DeleteByIDFuture, err error)

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

func (Client) DeletePreparer 

func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName 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) (future DeleteFuture, err 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) (result GenericResource, err error)

Get gets a resource. Parameters: resourceGroupName - the name of the resource group containing the resource to get. The name is case insensitive. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - the parent resource identity. resourceType - the resource type of the resource. resourceName - the name of the resource to get.

func (Client) GetByID 

func (client Client) GetByID(ctx context.Context, resourceID string) (result GenericResource, err error)

GetByID gets a resource by ID. Parameters: resourceID - the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

func (Client) GetByIDPreparer 

func (client Client) GetByIDPreparer(ctx context.Context, resourceID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (Client) GetByIDResponder 

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

GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.

func (Client) GetByIDSender 

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

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

func (Client) GetPreparer 

func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName 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 the resources in a subscription. Parameters: filter - the filter to apply on the operation. expand - the $expand query parameter. top - the number of results to return. If null is passed, returns all resource groups.

func (Client) ListByResourceGroup 

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

ListByResourceGroup get all the resources for a resource group. Parameters: resourceGroupName - the resource group with the resources to get. filter - the filter to apply on the operation. expand - the $expand query parameter top - the number of results to return. If null is passed, returns all resources.

func (Client) ListByResourceGroupComplete 

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

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

func (Client) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder 

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

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (Client) ListByResourceGroupSender 

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

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

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 the resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. Parameters: sourceResourceGroupName - the name of the resource group containing the resources to move. parameters - parameters for moving resources.

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, 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. parameters - parameters for updating the resource.

func (Client) UpdateByID 

func (client Client) UpdateByID(ctx context.Context, resourceID string, parameters GenericResource) (result UpdateByIDFuture, err error)

UpdateByID updates a resource by ID. Parameters: resourceID - the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} parameters - update resource parameters.

func (Client) UpdateByIDPreparer 

func (client Client) UpdateByIDPreparer(ctx context.Context, resourceID string, parameters GenericResource) (*http.Request, error)

UpdateByIDPreparer prepares the UpdateByID request.

func (Client) UpdateByIDResponder 

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

UpdateByIDResponder handles the response to the UpdateByID request. The method always closes the http.Response Body.

func (Client) UpdateByIDSender 

func (client Client) UpdateByIDSender(req *http.Request) (future UpdateByIDFuture, err error)

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

func (Client) UpdatePreparer 

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName 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.

func (Client) ValidateMoveResources 

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

ValidateMoveResources this operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation. Parameters: sourceResourceGroupName - the name of the resource group containing the resources to validate for move. parameters - parameters for moving resources.

func (Client) ValidateMoveResourcesPreparer 

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

ValidateMoveResourcesPreparer prepares the ValidateMoveResources request.

func (Client) ValidateMoveResourcesResponder 

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

ValidateMoveResourcesResponder handles the response to the ValidateMoveResources request. The method always closes the http.Response Body.

func (Client) ValidateMoveResourcesSender 

func (client Client) ValidateMoveResourcesSender(req *http.Request) (future ValidateMoveResourcesFuture, err error)

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

type CreateOrUpdateByIDFuture 

type CreateOrUpdateByIDFuture struct {
	azure.Future
}

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

func (*CreateOrUpdateByIDFuture) Result 

func (future *CreateOrUpdateByIDFuture) Result(client Client) (gr GenericResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CreateOrUpdateFuture 

type CreateOrUpdateFuture struct {
	azure.Future
}

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

func (*CreateOrUpdateFuture) Result 

func (future *CreateOrUpdateFuture) Result(client Client) (gr GenericResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DebugSetting 

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

DebugSetting ...

type DeleteByIDFuture 

type DeleteByIDFuture struct {
	azure.Future
}

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

func (*DeleteByIDFuture) Result 

func (future *DeleteByIDFuture) Result(client Client) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DeleteFuture 

type DeleteFuture struct {
	azure.Future
}

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

func (*DeleteFuture) Result 

func (future *DeleteFuture) Result(client Client) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

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 the deployment export result.

type DeploymentExtended 

type DeploymentExtended struct {
	autorest.Response `json:"-"`
	// ID - 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.

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 - An array of deployments.
	Value *[]DeploymentExtended `json:"value,omitempty"`
	// NextLink - The URL to use for getting 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(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 provides operations for working with resources and resource groups.

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.

func (DeploymentOperationsClient) Get 

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

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

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 all deployments operations for a deployment. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment with the operation to get. top - the number of results to return.

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 - An array of deployment operations.
	Value *[]DeploymentOperation `json:"value,omitempty"`
	// NextLink - The URL to use for getting 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(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. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.
	Template interface{} `json:"template,omitempty"`
	// TemplateLink - The URI of the template. Use either the templateLink property or the template property, but not both.
	TemplateLink *TemplateLink `json:"templateLink,omitempty"`
	// Parameters - Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
	Parameters interface{} `json:"parameters,omitempty"`
	// ParametersLink - The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
	ParametersLink *ParametersLink `json:"parametersLink,omitempty"`
	// Mode - The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. 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 are Incremental and Complete. 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 provides operations for working with resources and resource groups.

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.

func (DeploymentsClient) Cancel 

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

Cancel you can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment to cancel.

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 the deployment exists. Parameters: resourceGroupName - the name of the resource group with the deployment to check. The name is case insensitive. deploymentName - the name of the deployment to check.

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 you can provide the template and parameters directly in the request or link to JSON files. Parameters: resourceGroupName - the name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. deploymentName - the name of the deployment. parameters - additional parameters supplied to the operation.

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 a template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. Parameters: resourceGroupName - the name of the resource group with the deployment to delete. The name is case insensitive. deploymentName - the name of the deployment to delete.

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 the template used for specified deployment. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment from which to get the template.

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 gets a deployment. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. deploymentName - the name of the deployment to get.

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

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

ListByResourceGroup get all the deployments for a resource group. Parameters: resourceGroupName - the name of the resource group with the deployments to get. The name is case insensitive. filter - the filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. top - the number of results to get. If null is passed, returns all deployments.

func (DeploymentsClient) ListByResourceGroupComplete 

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

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

func (DeploymentsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DeploymentsClient) ListByResourceGroupResponder 

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

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (DeploymentsClient) ListByResourceGroupSender 

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

ListByResourceGroupSender sends the ListByResourceGroup 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 validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. Parameters: resourceGroupName - the name of the resource group the template will be deployed to. The name is case insensitive. deploymentName - the name of the deployment. parameters - parameters to validate.

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.Future
}

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

func (*DeploymentsCreateOrUpdateFuture) Result 

func (future *DeploymentsCreateOrUpdateFuture) Result(client DeploymentsClient) (de DeploymentExtended, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DeploymentsDeleteFuture 

type DeploymentsDeleteFuture struct {
	azure.Future
}

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

func (*DeploymentsDeleteFuture) Result 

func (future *DeploymentsDeleteFuture) Result(client DeploymentsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ExportTemplateRequest 

type ExportTemplateRequest struct {
	// ResourcesProperty - The IDs of the resources. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources.
	ResourcesProperty *[]string `json:"resources,omitempty"`
	// Options - The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments
	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 - Resource ID
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - 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 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 - 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. It must be one of the supported Azure locations.
	Location *string `json:"location,omitempty"`
	// ManagedBy - The ID of the resource that manages this resource group.
	ManagedBy *string `json:"managedBy,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 resource group export result.

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 - An array of resource groups.
	Value *[]Group `json:"value,omitempty"`
	// NextLink - The URL to use for getting 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(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 GroupPatchable 

type GroupPatchable struct {
	// Name - The name of the resource group.
	Name       *string          `json:"name,omitempty"`
	Properties *GroupProperties `json:"properties,omitempty"`
	// ManagedBy - The ID of the resource that manages this resource group.
	ManagedBy *string `json:"managedBy,omitempty"`
	// Tags - The tags attached to the resource group.
	Tags map[string]*string `json:"tags"`
}

GroupPatchable resource group information.

func (GroupPatchable) MarshalJSON 

func (gp GroupPatchable) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupPatchable.

type GroupProperties 

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

GroupProperties the resource group properties.

type GroupsClient 

type GroupsClient struct {
	BaseClient
}

GroupsClient is the provides operations for working with resources and resource groups.

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.

func (GroupsClient) CheckExistence 

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

CheckExistence checks whether a 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 creates or updates a resource group. Parameters: resourceGroupName - the name of the resource group to create or update. parameters - parameters supplied to the create or update a resource group.

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 when you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations. Parameters: resourceGroupName - the name of the resource group to delete. 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 export as a template. parameters - parameters for exporting the template.

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 gets 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 all the resource groups for a subscription. Parameters: filter - the filter to apply on the operation. top - the number of results to return. 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) 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) Update 

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

Update resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained. Parameters: resourceGroupName - the name of the resource group to update. The name is case insensitive. parameters - parameters supplied to update a resource group.

func (GroupsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (GroupsClient) UpdateResponder 

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

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

func (GroupsClient) UpdateSender 

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

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

type GroupsDeleteFuture 

type GroupsDeleteFuture struct {
	azure.Future
}

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

func (*GroupsDeleteFuture) Result 

func (future *GroupsDeleteFuture) Result(client GroupsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type HTTPMessage 

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

HTTPMessage HTTP message.

type Identity 

type Identity struct {
	// PrincipalID - The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - 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.

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	// Value - An array of resources.
	Value *[]GenericResource `json:"value,omitempty"`
	// NextLink - The URL to use for getting 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 GenericResource 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() GenericResource

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 GenericResource values.

func NewListResultPage 

func NewListResultPage(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() []GenericResource

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 when exporting the template.
	Code *string `json:"code,omitempty"`
	// Message - The error message describing the export error.
	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 the detailed error message of resource management.

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.Future
}

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

func (*MoveResourcesFuture) Result 

func (future *MoveResourcesFuture) Result(client Client) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error. 

type ParametersLink struct {
	// URI - The URI of the parameters file.
	URI *string `json:"uri,omitempty"`
	// ContentVersion - If included, 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"`
	// Version - The plan's version.
	Version *string `json:"version,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 resource 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 - An array of resource providers.
	Value *[]Provider `json:"value,omitempty"`
	// NextLink - The URL to use for getting 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(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 - The operation name.
	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.
	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 provides operations for working with resources and resource groups.

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.

func (ProvidersClient) Get 

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

Get gets the specified resource provider. Parameters: resourceProviderNamespace - the namespace of the resource provider. expand - the $expand query parameter. For example, 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 all resource providers for a subscription. Parameters: top - the number of results to return. If null is passed returns all deployments. expand - the properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

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 a subscription with a resource provider. Parameters: resourceProviderNamespace - the namespace of the resource provider to register.

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 a subscription from a resource provider. Parameters: resourceProviderNamespace - the namespace of the resource provider to unregister.

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 - Resource ID
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - 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 basic set of the resource properties.

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 sub-resource.

type TagCount 

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

TagCount tag count.

type TagDetails 

type TagDetails struct {
	autorest.Response `json:"-"`
	// ID - The tag ID.
	ID *string `json:"id,omitempty"`
	// TagName - The tag name.
	TagName *string `json:"tagName,omitempty"`
	// Count - The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0.
	Count *TagCount `json:"count,omitempty"`
	// Values - The list of tag values.
	Values *[]TagValue `json:"values,omitempty"`
}

TagDetails tag details.

type TagValue 

type TagValue struct {
	autorest.Response `json:"-"`
	// ID - 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.

type TagsClient 

type TagsClient struct {
	BaseClient
}

TagsClient is the provides operations for working with resources and resource groups.

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.

func (TagsClient) CreateOrUpdate 

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

CreateOrUpdate the tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes. Parameters: tagName - the name of the tag to create.

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 creates a tag value. The name of the tag must already exist. Parameters: tagName - the name of the tag. tagValue - the value of the tag to create.

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 you must remove all values from a resource tag before you can delete it. 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 deletes a tag value. Parameters: tagName - the name of the tag. tagValue - the value of the tag to delete.

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 gets the names and values of all resource tags that are defined in a subscription.

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 - An array of tags.
	Value *[]TagDetails `json:"value,omitempty"`
	// NextLink - The URL to use for getting 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(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 TemplateLink struct {
	// URI - The URI of the template to deploy.
	URI *string `json:"uri,omitempty"`
	// ContentVersion - If included, must match the ContentVersion in the template.
	ContentVersion *string `json:"contentVersion,omitempty"`
}

TemplateLink entity representing the reference to the template.

type UpdateByIDFuture 

type UpdateByIDFuture struct {
	azure.Future
}

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

func (*UpdateByIDFuture) Result 

func (future *UpdateByIDFuture) Result(client Client) (gr GenericResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type UpdateFuture 

type UpdateFuture struct {
	azure.Future
}

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

func (*UpdateFuture) Result 

func (future *UpdateFuture) Result(client Client) (gr GenericResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ValidateMoveResourcesFuture 

type ValidateMoveResourcesFuture struct {
	azure.Future
}

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

func (*ValidateMoveResourcesFuture) Result 

func (future *ValidateMoveResourcesFuture) Result(client Client) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

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.