const (
// DefaultBaseURI is the default URI used for the service Resources
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
AliasPathType the type of the paths for alias.
type AliasPathType struct {
// Path - The path of an alias.
Path *string `json:"path,omitempty"`
// APIVersions - The API versions.
APIVersions *[]string `json:"apiVersions,omitempty"`
}
AliasType the alias type.
type AliasType struct {
// Name - The alias name.
Name *string `json:"name,omitempty"`
// Paths - The paths for an alias.
Paths *[]AliasPathType `json:"paths,omitempty"`
}
BaseClient is the base client for Resources.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
BasicDependency deployment dependency information.
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"`
}
Client is the provides operations for working with resources and resource groups.
type Client struct {
BaseClient
}
func NewClient(subscriptionID string) Client
NewClient creates an instance of the Client client.
func NewClientWithBaseURI(baseURI string, subscriptionID string) Client
NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client Client) CheckExistence(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (result autorest.Response, err error)
CheckExistence checks whether 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. APIVersion - the API version to use for the operation.
func (client Client) CheckExistenceByID(ctx context.Context, resourceID string, APIVersion 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} APIVersion - the API version to use for the operation.
func (client Client) CheckExistenceByIDPreparer(ctx context.Context, resourceID string, APIVersion string) (*http.Request, error)
CheckExistenceByIDPreparer prepares the CheckExistenceByID request.
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 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 Client) CheckExistencePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (*http.Request, error)
CheckExistencePreparer prepares the CheckExistence request.
func (client 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 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 Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion 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. APIVersion - the API version to use for the operation. parameters - parameters for creating or updating the resource.
func (client Client) CreateOrUpdateByID(ctx context.Context, resourceID string, APIVersion 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} APIVersion - the API version to use for the operation. parameters - create or update resource parameters.
func (client Client) CreateOrUpdateByIDPreparer(ctx context.Context, resourceID string, APIVersion string, parameters GenericResource) (*http.Request, error)
CreateOrUpdateByIDPreparer prepares the CreateOrUpdateByID request.
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 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 Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string, parameters GenericResource) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client 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 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 Client) Delete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion 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. APIVersion - the API version to use for the operation.
func (client Client) DeleteByID(ctx context.Context, resourceID string, APIVersion 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} APIVersion - the API version to use for the operation.
func (client Client) DeleteByIDPreparer(ctx context.Context, resourceID string, APIVersion string) (*http.Request, error)
DeleteByIDPreparer prepares the DeleteByID request.
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 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 Client) DeletePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client 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 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 Client) Get(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion 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. APIVersion - the API version to use for the operation.
func (client Client) GetByID(ctx context.Context, resourceID string, APIVersion 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} APIVersion - the API version to use for the operation.
func (client Client) GetByIDPreparer(ctx context.Context, resourceID string, APIVersion string) (*http.Request, error)
GetByIDPreparer prepares the GetByID request.
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 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 Client) GetPreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client 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 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 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 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 - comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. top - the number of results to return. If null is passed, returns all resources.
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 Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string, expand string, top *int32) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 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 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 Client) ListPreparer(ctx context.Context, filter string, expand string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
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 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 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 Client) MoveResourcesPreparer(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo) (*http.Request, error)
MoveResourcesPreparer prepares the MoveResources request.
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 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 Client) Update(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string, parameters GenericResource) (result UpdateFuture, err error)
Update updates a resource. Parameters: resourceGroupName - the name of the resource group for the resource. The name is case insensitive. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - the parent resource identity. resourceType - the resource type of the resource to update. resourceName - the name of the resource to update. APIVersion - the API version to use for the operation. parameters - parameters for updating the resource.
func (client Client) UpdateByID(ctx context.Context, resourceID string, APIVersion 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} APIVersion - the API version to use for the operation. parameters - update resource parameters.
func (client Client) UpdateByIDPreparer(ctx context.Context, resourceID string, APIVersion string, parameters GenericResource) (*http.Request, error)
UpdateByIDPreparer prepares the UpdateByID request.
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 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 Client) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, APIVersion string, parameters GenericResource) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client 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 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 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 Client) ValidateMoveResourcesPreparer(ctx context.Context, sourceResourceGroupName string, parameters MoveInfo) (*http.Request, error)
ValidateMoveResourcesPreparer prepares the ValidateMoveResources request.
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 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.
CloudError an error response for a resource management request.
type CloudError struct {
Error *ErrorResponse `json:"error,omitempty"`
}
CreateOrUpdateByIDFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreateOrUpdateByIDFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (GenericResource, error)
}
func (future *CreateOrUpdateByIDFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (GenericResource, error)
}
func (future *CreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
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"`
}
DeleteByIDFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DeleteByIDFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *DeleteByIDFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *DeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Dependency deployment dependency information.
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"`
}
Deployment deployment operation parameters.
type Deployment struct {
// Properties - The deployment properties.
Properties *DeploymentProperties `json:"properties,omitempty"`
}
DeploymentExportResult the deployment export result.
type DeploymentExportResult struct {
autorest.Response `json:"-"`
// Template - The template content.
Template interface{} `json:"template,omitempty"`
}
DeploymentExtended deployment information.
type DeploymentExtended struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The ID of the deployment.
ID *string `json:"id,omitempty"`
// Name - The name of the deployment.
Name *string `json:"name,omitempty"`
// Properties - Deployment properties.
Properties *DeploymentPropertiesExtended `json:"properties,omitempty"`
}
func (de DeploymentExtended) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeploymentExtended.
DeploymentExtendedFilter deployment filter.
type DeploymentExtendedFilter struct {
// ProvisioningState - The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
}
DeploymentListResult list of deployments.
type DeploymentListResult struct {
autorest.Response `json:"-"`
// Value - An array of deployments.
Value *[]DeploymentExtended `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (dlr DeploymentListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (dlr DeploymentListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeploymentListResult.
DeploymentListResultIterator provides access to a complete listing of DeploymentExtended values.
type DeploymentListResultIterator struct {
// contains filtered or unexported fields
}
func NewDeploymentListResultIterator(page DeploymentListResultPage) DeploymentListResultIterator
Creates a new instance of the DeploymentListResultIterator type.
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 (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 (iter DeploymentListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DeploymentListResultIterator) Response() DeploymentListResult
Response returns the raw server response from the last page request.
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.
DeploymentListResultPage contains a page of DeploymentExtended values.
type DeploymentListResultPage struct {
// contains filtered or unexported fields
}
func NewDeploymentListResultPage(cur DeploymentListResult, getNextPage func(context.Context, DeploymentListResult) (DeploymentListResult, error)) DeploymentListResultPage
Creates a new instance of the DeploymentListResultPage type.
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 (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 (page DeploymentListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DeploymentListResultPage) Response() DeploymentListResult
Response returns the raw server response from the last page request.
func (page DeploymentListResultPage) Values() []DeploymentExtended
Values returns the slice of values for the current page or nil if there are no values.
DeploymentMode enumerates the values for deployment mode.
type DeploymentMode string
const (
// Complete ...
Complete DeploymentMode = "Complete"
// Incremental ...
Incremental DeploymentMode = "Incremental"
)
func PossibleDeploymentModeValues() []DeploymentMode
PossibleDeploymentModeValues returns an array of possible values for the DeploymentMode const type.
DeploymentOperation deployment operation information.
type DeploymentOperation struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; Full deployment operation ID.
ID *string `json:"id,omitempty"`
// OperationID - READ-ONLY; Deployment operation ID.
OperationID *string `json:"operationId,omitempty"`
// Properties - Deployment properties.
Properties *DeploymentOperationProperties `json:"properties,omitempty"`
}
func (do DeploymentOperation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeploymentOperation.
DeploymentOperationProperties deployment operation properties.
type DeploymentOperationProperties struct {
// ProvisioningState - READ-ONLY; The state of the provisioning.
ProvisioningState *string `json:"provisioningState,omitempty"`
// Timestamp - READ-ONLY; The date and time of the operation.
Timestamp *date.Time `json:"timestamp,omitempty"`
// ServiceRequestID - READ-ONLY; Deployment operation service request id.
ServiceRequestID *string `json:"serviceRequestId,omitempty"`
// StatusCode - READ-ONLY; Operation status code.
StatusCode *string `json:"statusCode,omitempty"`
// StatusMessage - READ-ONLY; Operation status message.
StatusMessage interface{} `json:"statusMessage,omitempty"`
// TargetResource - READ-ONLY; The target resource.
TargetResource *TargetResource `json:"targetResource,omitempty"`
// Request - READ-ONLY; The HTTP request message.
Request *HTTPMessage `json:"request,omitempty"`
// Response - READ-ONLY; The HTTP response message.
Response *HTTPMessage `json:"response,omitempty"`
}
func (dop DeploymentOperationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeploymentOperationProperties.
DeploymentOperationsClient is the provides operations for working with resources and resource groups.
type DeploymentOperationsClient struct {
BaseClient
}
func NewDeploymentOperationsClient(subscriptionID string) DeploymentOperationsClient
NewDeploymentOperationsClient creates an instance of the DeploymentOperationsClient client.
func NewDeploymentOperationsClientWithBaseURI(baseURI string, subscriptionID string) DeploymentOperationsClient
NewDeploymentOperationsClientWithBaseURI creates an instance of the DeploymentOperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (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 (client DeploymentOperationsClient) GetPreparer(ctx context.Context, resourceGroupName string, deploymentName string, operationID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (client DeploymentOperationsClient) ListPreparer(ctx context.Context, resourceGroupName string, deploymentName string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
DeploymentOperationsListResult list of deployment operations.
type DeploymentOperationsListResult struct {
autorest.Response `json:"-"`
// Value - An array of deployment operations.
Value *[]DeploymentOperation `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (dolr DeploymentOperationsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (dolr DeploymentOperationsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeploymentOperationsListResult.
DeploymentOperationsListResultIterator provides access to a complete listing of DeploymentOperation values.
type DeploymentOperationsListResultIterator struct {
// contains filtered or unexported fields
}
func NewDeploymentOperationsListResultIterator(page DeploymentOperationsListResultPage) DeploymentOperationsListResultIterator
Creates a new instance of the DeploymentOperationsListResultIterator type.
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 (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 (iter DeploymentOperationsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DeploymentOperationsListResultIterator) Response() DeploymentOperationsListResult
Response returns the raw server response from the last page request.
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.
DeploymentOperationsListResultPage contains a page of DeploymentOperation values.
type DeploymentOperationsListResultPage struct {
// contains filtered or unexported fields
}
func NewDeploymentOperationsListResultPage(cur DeploymentOperationsListResult, getNextPage func(context.Context, DeploymentOperationsListResult) (DeploymentOperationsListResult, error)) DeploymentOperationsListResultPage
Creates a new instance of the DeploymentOperationsListResultPage type.
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 (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 (page DeploymentOperationsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DeploymentOperationsListResultPage) Response() DeploymentOperationsListResult
Response returns the raw server response from the last page request.
func (page DeploymentOperationsListResultPage) Values() []DeploymentOperation
Values returns the slice of values for the current page or nil if there are no values.
DeploymentProperties deployment properties.
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"`
// OnErrorDeployment - The deployment on error behavior.
OnErrorDeployment *OnErrorDeployment `json:"onErrorDeployment,omitempty"`
}
DeploymentPropertiesExtended deployment properties with additional details.
type DeploymentPropertiesExtended struct {
// ProvisioningState - READ-ONLY; The state of the provisioning.
ProvisioningState *string `json:"provisioningState,omitempty"`
// CorrelationID - READ-ONLY; The correlation ID of the deployment.
CorrelationID *string `json:"correlationId,omitempty"`
// Timestamp - READ-ONLY; 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"`
// OnErrorDeployment - The deployment on error behavior.
OnErrorDeployment *OnErrorDeploymentExtended `json:"onErrorDeployment,omitempty"`
}
func (dpe DeploymentPropertiesExtended) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeploymentPropertiesExtended.
DeploymentValidateResult information from validate template deployment response.
type DeploymentValidateResult struct {
autorest.Response `json:"-"`
// Error - Validation error.
Error *ManagementErrorWithDetails `json:"error,omitempty"`
// Properties - The template deployment properties.
Properties *DeploymentPropertiesExtended `json:"properties,omitempty"`
}
DeploymentsClient is the provides operations for working with resources and resource groups.
type DeploymentsClient struct {
BaseClient
}
func NewDeploymentsClient(subscriptionID string) DeploymentsClient
NewDeploymentsClient creates an instance of the DeploymentsClient client.
func NewDeploymentsClientWithBaseURI(baseURI string, subscriptionID string) DeploymentsClient
NewDeploymentsClientWithBaseURI creates an instance of the DeploymentsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DeploymentsClient) CalculateTemplateHash(ctx context.Context, templateParameter interface{}) (result TemplateHashResult, err error)
CalculateTemplateHash calculate the hash of the given template. Parameters: templateParameter - the template provided to calculate hash.
func (client DeploymentsClient) CalculateTemplateHashPreparer(ctx context.Context, templateParameter interface{}) (*http.Request, error)
CalculateTemplateHashPreparer prepares the CalculateTemplateHash request.
func (client DeploymentsClient) CalculateTemplateHashResponder(resp *http.Response) (result TemplateHashResult, err error)
CalculateTemplateHashResponder handles the response to the CalculateTemplateHash request. The method always closes the http.Response Body.
func (client DeploymentsClient) CalculateTemplateHashSender(req *http.Request) (*http.Response, error)
CalculateTemplateHashSender sends the CalculateTemplateHash request. The method will close the http.Response Body if it receives an error.
func (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 (client DeploymentsClient) CancelPreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)
CancelPreparer prepares the Cancel request.
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 (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 (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 (client DeploymentsClient) CheckExistencePreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)
CheckExistencePreparer prepares the CheckExistence request.
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 (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 (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 (client DeploymentsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client DeploymentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client DeploymentsClient) ExportTemplatePreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)
ExportTemplatePreparer prepares the ExportTemplate request.
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 (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 (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 (client DeploymentsClient) GetPreparer(ctx context.Context, resourceGroupName string, deploymentName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (client DeploymentsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string, top *int32) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (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 (client DeploymentsClient) ValidatePreparer(ctx context.Context, resourceGroupName string, deploymentName string, parameters Deployment) (*http.Request, error)
ValidatePreparer prepares the Validate request.
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 (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.
DeploymentsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DeploymentsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DeploymentsClient) (DeploymentExtended, error)
}
func (future *DeploymentsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DeploymentsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DeploymentsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DeploymentsClient) (autorest.Response, error)
}
func (future *DeploymentsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ErrorAdditionalInfo the resource management error additional info.
type ErrorAdditionalInfo struct {
// Type - READ-ONLY; The additional info type.
Type *string `json:"type,omitempty"`
// Info - READ-ONLY; The additional info.
Info interface{} `json:"info,omitempty"`
}
func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorAdditionalInfo.
ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
type ErrorResponse struct {
// Code - READ-ONLY; The error code.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"message,omitempty"`
// Target - READ-ONLY; The error target.
Target *string `json:"target,omitempty"`
// Details - READ-ONLY; The error details.
Details *[]ErrorResponse `json:"details,omitempty"`
// AdditionalInfo - READ-ONLY; The error additional info.
AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}
func (er ErrorResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorResponse.
ExportTemplateRequest export resource group template request parameters.
type ExportTemplateRequest struct {
// ResourcesProperty - The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'.
ResourcesProperty *[]string `json:"resources,omitempty"`
// Options - The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'
Options *string `json:"options,omitempty"`
}
GenericResource resource information.
type GenericResource struct {
autorest.Response `json:"-"`
// Plan - The plan of the resource.
Plan *Plan `json:"plan,omitempty"`
// Properties - The resource properties.
Properties interface{} `json:"properties,omitempty"`
// Kind - The kind of the resource.
Kind *string `json:"kind,omitempty"`
// ManagedBy - ID of the resource that manages this resource.
ManagedBy *string `json:"managedBy,omitempty"`
// Sku - The SKU of the resource.
Sku *Sku `json:"sku,omitempty"`
// Identity - The identity of the resource.
Identity *Identity `json:"identity,omitempty"`
// ID - READ-ONLY; Resource ID
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (gr GenericResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GenericResource.
GenericResourceExpanded resource information.
type GenericResourceExpanded struct {
// CreatedTime - READ-ONLY; The created time of the resource. This is only present if requested via the $expand query parameter.
CreatedTime *date.Time `json:"createdTime,omitempty"`
// ChangedTime - READ-ONLY; The changed time of the resource. This is only present if requested via the $expand query parameter.
ChangedTime *date.Time `json:"changedTime,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state of the resource. This is only present if requested via the $expand query parameter.
ProvisioningState *string `json:"provisioningState,omitempty"`
// Plan - The plan of the resource.
Plan *Plan `json:"plan,omitempty"`
// Properties - The resource properties.
Properties interface{} `json:"properties,omitempty"`
// Kind - The kind of the resource.
Kind *string `json:"kind,omitempty"`
// ManagedBy - ID of the resource that manages this resource.
ManagedBy *string `json:"managedBy,omitempty"`
// Sku - The SKU of the resource.
Sku *Sku `json:"sku,omitempty"`
// Identity - The identity of the resource.
Identity *Identity `json:"identity,omitempty"`
// ID - READ-ONLY; Resource ID
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (gre GenericResourceExpanded) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GenericResourceExpanded.
GenericResourceFilter resource filter.
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"`
}
Group resource group information.
type Group struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The ID of the resource group.
ID *string `json:"id,omitempty"`
// Name - The name of the resource group.
Name *string `json:"name,omitempty"`
Properties *GroupProperties `json:"properties,omitempty"`
// Location - The location of the resource group. It cannot be changed after the resource group has been created. 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"`
}
func (g Group) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Group.
GroupExportResult resource group export result.
type GroupExportResult struct {
autorest.Response `json:"-"`
// Template - The template content.
Template interface{} `json:"template,omitempty"`
// Error - The error.
Error *ManagementErrorWithDetails `json:"error,omitempty"`
}
GroupFilter resource group filter.
type GroupFilter struct {
// TagName - The tag name.
TagName *string `json:"tagName,omitempty"`
// TagValue - The tag value.
TagValue *string `json:"tagValue,omitempty"`
}
GroupListResult list of resource groups.
type GroupListResult struct {
autorest.Response `json:"-"`
// Value - An array of resource groups.
Value *[]Group `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (glr GroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (glr GroupListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupListResult.
GroupListResultIterator provides access to a complete listing of Group values.
type GroupListResultIterator struct {
// contains filtered or unexported fields
}
func NewGroupListResultIterator(page GroupListResultPage) GroupListResultIterator
Creates a new instance of the GroupListResultIterator type.
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 (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 (iter GroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GroupListResultIterator) Response() GroupListResult
Response returns the raw server response from the last page request.
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.
GroupListResultPage contains a page of Group values.
type GroupListResultPage struct {
// contains filtered or unexported fields
}
func NewGroupListResultPage(cur GroupListResult, getNextPage func(context.Context, GroupListResult) (GroupListResult, error)) GroupListResultPage
Creates a new instance of the GroupListResultPage type.
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 (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 (page GroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GroupListResultPage) Response() GroupListResult
Response returns the raw server response from the last page request.
func (page GroupListResultPage) Values() []Group
Values returns the slice of values for the current page or nil if there are no values.
GroupPatchable resource group information.
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"`
}
func (gp GroupPatchable) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupPatchable.
GroupProperties the resource group properties.
type GroupProperties struct {
// ProvisioningState - READ-ONLY; The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
}
func (gp GroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupProperties.
GroupsClient is the provides operations for working with resources and resource groups.
type GroupsClient struct {
BaseClient
}
func NewGroupsClient(subscriptionID string) GroupsClient
NewGroupsClient creates an instance of the GroupsClient client.
func NewGroupsClientWithBaseURI(baseURI string, subscriptionID string) GroupsClient
NewGroupsClientWithBaseURI creates an instance of the GroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (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 (client GroupsClient) CheckExistencePreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
CheckExistencePreparer prepares the CheckExistence request.
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 (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 (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 (client GroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, parameters Group) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client GroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client GroupsClient) ExportTemplatePreparer(ctx context.Context, resourceGroupName string, parameters ExportTemplateRequest) (*http.Request, error)
ExportTemplatePreparer prepares the ExportTemplate request.
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 (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 (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 (client GroupsClient) GetPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (client GroupsClient) ListPreparer(ctx context.Context, filter string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (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 (client GroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, parameters GroupPatchable) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (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.
GroupsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GroupsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GroupsClient) (autorest.Response, error)
}
func (future *GroupsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
HTTPMessage HTTP message.
type HTTPMessage struct {
// Content - HTTP message content.
Content interface{} `json:"content,omitempty"`
}
Identity identity for the resource.
type Identity struct {
// PrincipalID - READ-ONLY; The principal ID of resource identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant ID of resource.
TenantID *string `json:"tenantId,omitempty"`
// Type - The identity type. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssignedUserAssigned', 'None'
Type ResourceIdentityType `json:"type,omitempty"`
}
func (i Identity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Identity.
ListResult list of resource groups.
type ListResult struct {
autorest.Response `json:"-"`
// Value - An array of resources.
Value *[]GenericResourceExpanded `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (lr ListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListResult.
ListResultIterator provides access to a complete listing of GenericResourceExpanded values.
type ListResultIterator struct {
// contains filtered or unexported fields
}
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
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 (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 (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
func (iter ListResultIterator) Value() GenericResourceExpanded
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListResultPage contains a page of GenericResourceExpanded values.
type ListResultPage struct {
// contains filtered or unexported fields
}
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
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 (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 (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (page ListResultPage) Values() []GenericResourceExpanded
Values returns the slice of values for the current page or nil if there are no values.
ManagementErrorWithDetails the detailed error message of resource management.
type ManagementErrorWithDetails struct {
// Code - READ-ONLY; The error code returned when exporting the template.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; The error message describing the export error.
Message *string `json:"message,omitempty"`
// Target - READ-ONLY; The target of the error.
Target *string `json:"target,omitempty"`
// Details - READ-ONLY; Validation error.
Details *[]ManagementErrorWithDetails `json:"details,omitempty"`
}
func (mewd ManagementErrorWithDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagementErrorWithDetails.
MoveInfo parameters of move resources.
type MoveInfo struct {
// ResourcesProperty - The IDs of the resources.
ResourcesProperty *[]string `json:"resources,omitempty"`
// TargetResourceGroup - The target resource group.
TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
}
MoveResourcesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MoveResourcesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *MoveResourcesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
OnErrorDeployment deployment on error behavior.
type OnErrorDeployment struct {
// Type - The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. Possible values include: 'LastSuccessful', 'SpecificDeployment'
Type OnErrorDeploymentType `json:"type,omitempty"`
// DeploymentName - The deployment to be used on error case.
DeploymentName *string `json:"deploymentName,omitempty"`
}
OnErrorDeploymentExtended deployment on error behavior with additional details.
type OnErrorDeploymentExtended struct {
// ProvisioningState - READ-ONLY; The state of the provisioning for the on error deployment.
ProvisioningState *string `json:"provisioningState,omitempty"`
// Type - The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. Possible values include: 'LastSuccessful', 'SpecificDeployment'
Type OnErrorDeploymentType `json:"type,omitempty"`
// DeploymentName - The deployment to be used on error case.
DeploymentName *string `json:"deploymentName,omitempty"`
}
func (oede OnErrorDeploymentExtended) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OnErrorDeploymentExtended.
OnErrorDeploymentType enumerates the values for on error deployment type.
type OnErrorDeploymentType string
const (
// LastSuccessful ...
LastSuccessful OnErrorDeploymentType = "LastSuccessful"
// SpecificDeployment ...
SpecificDeployment OnErrorDeploymentType = "SpecificDeployment"
)
func PossibleOnErrorDeploymentTypeValues() []OnErrorDeploymentType
PossibleOnErrorDeploymentTypeValues returns an array of possible values for the OnErrorDeploymentType const type.
ParametersLink entity representing the reference to the deployment parameters.
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"`
}
Plan plan for the resource.
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"`
}
Provider resource provider information.
type Provider struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The provider ID.
ID *string `json:"id,omitempty"`
// Namespace - The namespace of the resource provider.
Namespace *string `json:"namespace,omitempty"`
// RegistrationState - READ-ONLY; The registration state of the provider.
RegistrationState *string `json:"registrationState,omitempty"`
// ResourceTypes - READ-ONLY; The collection of provider resource types.
ResourceTypes *[]ProviderResourceType `json:"resourceTypes,omitempty"`
}
func (p Provider) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Provider.
ProviderListResult list of resource providers.
type ProviderListResult struct {
autorest.Response `json:"-"`
// Value - An array of resource providers.
Value *[]Provider `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (plr ProviderListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (plr ProviderListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProviderListResult.
ProviderListResultIterator provides access to a complete listing of Provider values.
type ProviderListResultIterator struct {
// contains filtered or unexported fields
}
func NewProviderListResultIterator(page ProviderListResultPage) ProviderListResultIterator
Creates a new instance of the ProviderListResultIterator type.
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 (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 (iter ProviderListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProviderListResultIterator) Response() ProviderListResult
Response returns the raw server response from the last page request.
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.
ProviderListResultPage contains a page of Provider values.
type ProviderListResultPage struct {
// contains filtered or unexported fields
}
func NewProviderListResultPage(cur ProviderListResult, getNextPage func(context.Context, ProviderListResult) (ProviderListResult, error)) ProviderListResultPage
Creates a new instance of the ProviderListResultPage type.
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 (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 (page ProviderListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProviderListResultPage) Response() ProviderListResult
Response returns the raw server response from the last page request.
func (page ProviderListResultPage) Values() []Provider
Values returns the slice of values for the current page or nil if there are no values.
ProviderOperationDisplayProperties resource provider operation's display properties.
type ProviderOperationDisplayProperties struct {
// Publisher - Operation description.
Publisher *string `json:"publisher,omitempty"`
// Provider - Operation provider.
Provider *string `json:"provider,omitempty"`
// Resource - Operation resource.
Resource *string `json:"resource,omitempty"`
// Operation - Operation.
Operation *string `json:"operation,omitempty"`
// Description - Operation description.
Description *string `json:"description,omitempty"`
}
ProviderResourceType resource type managed by the resource provider.
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"`
}
func (prt ProviderResourceType) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProviderResourceType.
ProvidersClient is the provides operations for working with resources and resource groups.
type ProvidersClient struct {
BaseClient
}
func NewProvidersClient(subscriptionID string) ProvidersClient
NewProvidersClient creates an instance of the ProvidersClient client.
func NewProvidersClientWithBaseURI(baseURI string, subscriptionID string) ProvidersClient
NewProvidersClientWithBaseURI creates an instance of the ProvidersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (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 (client ProvidersClient) GetPreparer(ctx context.Context, resourceProviderNamespace string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (client ProvidersClient) ListPreparer(ctx context.Context, top *int32, expand string) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (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 (client ProvidersClient) RegisterPreparer(ctx context.Context, resourceProviderNamespace string) (*http.Request, error)
RegisterPreparer prepares the Register request.
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 (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 (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 (client ProvidersClient) UnregisterPreparer(ctx context.Context, resourceProviderNamespace string) (*http.Request, error)
UnregisterPreparer prepares the Unregister request.
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 (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.
Resource resource.
type Resource struct {
// ID - READ-ONLY; Resource ID
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceIdentityType enumerates the values for resource identity type.
type ResourceIdentityType string
const (
// None ...
None ResourceIdentityType = "None"
// SystemAssigned ...
SystemAssigned ResourceIdentityType = "SystemAssigned"
// SystemAssignedUserAssigned ...
SystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
// UserAssigned ...
UserAssigned ResourceIdentityType = "UserAssigned"
)
func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
Sku SKU for the resource.
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"`
}
SubResource sub-resource.
type SubResource struct {
// ID - Resource ID
ID *string `json:"id,omitempty"`
}
TagCount tag count.
type TagCount struct {
// Type - Type of count.
Type *string `json:"type,omitempty"`
// Value - Value of count.
Value *int32 `json:"value,omitempty"`
}
TagDetails tag details.
type TagDetails struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The tag ID.
ID *string `json:"id,omitempty"`
// TagName - The tag name.
TagName *string `json:"tagName,omitempty"`
// Count - The 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"`
}
func (td TagDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagDetails.
TagValue tag information.
type TagValue struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The tag ID.
ID *string `json:"id,omitempty"`
// TagValue - The tag value.
TagValue *string `json:"tagValue,omitempty"`
// Count - The tag value count.
Count *TagCount `json:"count,omitempty"`
}
func (tv TagValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagValue.
TagsClient is the provides operations for working with resources and resource groups.
type TagsClient struct {
BaseClient
}
func NewTagsClient(subscriptionID string) TagsClient
NewTagsClient creates an instance of the TagsClient client.
func NewTagsClientWithBaseURI(baseURI string, subscriptionID string) TagsClient
NewTagsClientWithBaseURI creates an instance of the TagsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (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 (client TagsClient) CreateOrUpdatePreparer(ctx context.Context, tagName string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client TagsClient) CreateOrUpdateValuePreparer(ctx context.Context, tagName string, tagValue string) (*http.Request, error)
CreateOrUpdateValuePreparer prepares the CreateOrUpdateValue request.
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 (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 (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 (client TagsClient) DeletePreparer(ctx context.Context, tagName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client TagsClient) DeleteValuePreparer(ctx context.Context, tagName string, tagValue string) (*http.Request, error)
DeleteValuePreparer prepares the DeleteValue request.
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 (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 (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 (client TagsClient) ListComplete(ctx context.Context) (result TagsListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client TagsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
TagsListResult list of subscription tags.
type TagsListResult struct {
autorest.Response `json:"-"`
// Value - An array of tags.
Value *[]TagDetails `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (tlr TagsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (tlr TagsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagsListResult.
TagsListResultIterator provides access to a complete listing of TagDetails values.
type TagsListResultIterator struct {
// contains filtered or unexported fields
}
func NewTagsListResultIterator(page TagsListResultPage) TagsListResultIterator
Creates a new instance of the TagsListResultIterator type.
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 (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 (iter TagsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter TagsListResultIterator) Response() TagsListResult
Response returns the raw server response from the last page request.
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.
TagsListResultPage contains a page of TagDetails values.
type TagsListResultPage struct {
// contains filtered or unexported fields
}
func NewTagsListResultPage(cur TagsListResult, getNextPage func(context.Context, TagsListResult) (TagsListResult, error)) TagsListResultPage
Creates a new instance of the TagsListResultPage type.
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 (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 (page TagsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page TagsListResultPage) Response() TagsListResult
Response returns the raw server response from the last page request.
func (page TagsListResultPage) Values() []TagDetails
Values returns the slice of values for the current page or nil if there are no values.
TargetResource target resource.
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"`
}
TemplateHashResult result of the request to calculate template hash. It contains a string of minified template and its hash.
type TemplateHashResult struct {
autorest.Response `json:"-"`
// MinifiedTemplate - The minified template string.
MinifiedTemplate *string `json:"minifiedTemplate,omitempty"`
// TemplateHash - The template hash.
TemplateHash *string `json:"templateHash,omitempty"`
}
TemplateLink entity representing the reference to the template.
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"`
}
UpdateByIDFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type UpdateByIDFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (GenericResource, error)
}
func (future *UpdateByIDFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
UpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type UpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (GenericResource, error)
}
func (future *UpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ValidateMoveResourcesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ValidateMoveResourcesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *ValidateMoveResourcesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
| Name | Synopsis |
|---|---|
| .. | |
| resourcesapi | Deprecated: Please note, this package has been deprecated. |