resources

package
v8.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 8, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

Provides operations for working with resources and resource groups.

Index

Constants

View Source 
const (
	// APIVersion is the version of the Resources
	APIVersion = "2016-09-01"

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type AliasPathType 

type AliasPathType struct {
	Path        *string   `json:"path,omitempty"`
	APIVersions *[]string `json:"apiVersions,omitempty"`
}

AliasPathType is the type of the paths for alias.

type AliasType 

type AliasType struct {
	Name  *string          `json:"name,omitempty"`
	Paths *[]AliasPathType `json:"paths,omitempty"`
}

AliasType is the alias type.

type BasicDependency 

type BasicDependency struct {
	ID           *string `json:"id,omitempty"`
	ResourceType *string `json:"resourceType,omitempty"`
	ResourceName *string `json:"resourceName,omitempty"`
}

BasicDependency is deployment dependency information.

type DebugSetting 

type DebugSetting struct {
	DetailLevel *string `json:"detailLevel,omitempty"`
}

DebugSetting is

type Dependency 

type Dependency struct {
	DependsOn    *[]BasicDependency `json:"dependsOn,omitempty"`
	ID           *string            `json:"id,omitempty"`
	ResourceType *string            `json:"resourceType,omitempty"`
	ResourceName *string            `json:"resourceName,omitempty"`
}

Dependency is deployment dependency information.

type Deployment 

type Deployment struct {
	Properties *DeploymentProperties `json:"properties,omitempty"`
}

Deployment is deployment operation parameters.

type DeploymentExportResult 

type DeploymentExportResult struct {
	autorest.Response `json:"-"`
	Template          *map[string]interface{} `json:"template,omitempty"`
}

DeploymentExportResult is the deployment export result.

type DeploymentExtended 

type DeploymentExtended struct {
	autorest.Response `json:"-"`
	ID                *string                       `json:"id,omitempty"`
	Name              *string                       `json:"name,omitempty"`
	Properties        *DeploymentPropertiesExtended `json:"properties,omitempty"`
}

DeploymentExtended is deployment information.

type DeploymentExtendedFilter 

type DeploymentExtendedFilter struct {
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

DeploymentExtendedFilter is deployment filter.

type DeploymentListResult 

type DeploymentListResult struct {
	autorest.Response `json:"-"`
	Value             *[]DeploymentExtended `json:"value,omitempty"`
	NextLink          *string               `json:"nextLink,omitempty"`
}

DeploymentListResult is list of deployments.

func (DeploymentListResult) DeploymentListResultPreparer 

func (client DeploymentListResult) DeploymentListResultPreparer() (*http.Request, error)

DeploymentListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type DeploymentMode 

type DeploymentMode string

DeploymentMode enumerates the values for deployment mode. 

const (
	// Complete specifies the complete state for deployment mode.
	Complete DeploymentMode = "Complete"
	// Incremental specifies the incremental state for deployment mode.
	Incremental DeploymentMode = "Incremental"
)

type DeploymentOperation 

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

DeploymentOperation is deployment operation information.

type DeploymentOperationProperties 

type DeploymentOperationProperties struct {
	ProvisioningState *string                 `json:"provisioningState,omitempty"`
	Timestamp         *date.Time              `json:"timestamp,omitempty"`
	ServiceRequestID  *string                 `json:"serviceRequestId,omitempty"`
	StatusCode        *string                 `json:"statusCode,omitempty"`
	StatusMessage     *map[string]interface{} `json:"statusMessage,omitempty"`
	TargetResource    *TargetResource         `json:"targetResource,omitempty"`
	Request           *HTTPMessage            `json:"request,omitempty"`
	Response          *HTTPMessage            `json:"response,omitempty"`
}

DeploymentOperationProperties is deployment operation properties.

type DeploymentOperationsClient 

type DeploymentOperationsClient struct {
	ManagementClient
}

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

func NewDeploymentOperationsClient 

func NewDeploymentOperationsClient(subscriptionID string) DeploymentOperationsClient

NewDeploymentOperationsClient creates an instance of the DeploymentOperationsClient client.

func NewDeploymentOperationsClientWithBaseURI 

func NewDeploymentOperationsClientWithBaseURI(baseURI string, subscriptionID string) DeploymentOperationsClient

NewDeploymentOperationsClientWithBaseURI creates an instance of the DeploymentOperationsClient client.

func (DeploymentOperationsClient) Get 

func (client DeploymentOperationsClient) Get(resourceGroupName string, deploymentName string, operationID string) (result DeploymentOperation, err error)

Get gets a deployments operation.

resourceGroupName is the name of the resource group. The name is case insensitive. deploymentName is the name of the deployment. operationID is the ID of the operation to get.

func (DeploymentOperationsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (DeploymentOperationsClient) GetResponder 

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

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

func (DeploymentOperationsClient) GetSender 

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

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

func (DeploymentOperationsClient) List 

func (client DeploymentOperationsClient) List(resourceGroupName string, deploymentName string, top *int32) (result DeploymentOperationsListResult, err error)

List gets all deployments operations for a deployment.

resourceGroupName is the name of the resource group. The name is case insensitive. deploymentName is the name of the deployment with the operation to get. top is the number of results to return.

func (DeploymentOperationsClient) ListNextResults 

func (client DeploymentOperationsClient) ListNextResults(lastResults DeploymentOperationsListResult) (result DeploymentOperationsListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (DeploymentOperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (DeploymentOperationsClient) ListResponder 

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

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

func (DeploymentOperationsClient) ListSender 

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

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

type DeploymentOperationsListResult 

type DeploymentOperationsListResult struct {
	autorest.Response `json:"-"`
	Value             *[]DeploymentOperation `json:"value,omitempty"`
	NextLink          *string                `json:"nextLink,omitempty"`
}

DeploymentOperationsListResult is list of deployment operations.

func (DeploymentOperationsListResult) DeploymentOperationsListResultPreparer 

func (client DeploymentOperationsListResult) DeploymentOperationsListResultPreparer() (*http.Request, error)

DeploymentOperationsListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type DeploymentProperties 

type DeploymentProperties struct {
	Template       *map[string]interface{} `json:"template,omitempty"`
	TemplateLink   *TemplateLink           `json:"templateLink,omitempty"`
	Parameters     *map[string]interface{} `json:"parameters,omitempty"`
	ParametersLink *ParametersLink         `json:"parametersLink,omitempty"`
	Mode           DeploymentMode          `json:"mode,omitempty"`
	DebugSetting   *DebugSetting           `json:"debugSetting,omitempty"`
}

DeploymentProperties is deployment properties.

type DeploymentPropertiesExtended 

type DeploymentPropertiesExtended struct {
	ProvisioningState *string                 `json:"provisioningState,omitempty"`
	CorrelationID     *string                 `json:"correlationId,omitempty"`
	Timestamp         *date.Time              `json:"timestamp,omitempty"`
	Outputs           *map[string]interface{} `json:"outputs,omitempty"`
	Providers         *[]Provider             `json:"providers,omitempty"`
	Dependencies      *[]Dependency           `json:"dependencies,omitempty"`
	Template          *map[string]interface{} `json:"template,omitempty"`
	TemplateLink      *TemplateLink           `json:"templateLink,omitempty"`
	Parameters        *map[string]interface{} `json:"parameters,omitempty"`
	ParametersLink    *ParametersLink         `json:"parametersLink,omitempty"`
	Mode              DeploymentMode          `json:"mode,omitempty"`
	DebugSetting      *DebugSetting           `json:"debugSetting,omitempty"`
}

DeploymentPropertiesExtended is deployment properties with additional details.

type DeploymentValidateResult 

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

DeploymentValidateResult is information from validate template deployment response.

type DeploymentsClient 

type DeploymentsClient struct {
	ManagementClient
}

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

func NewDeploymentsClient 

func NewDeploymentsClient(subscriptionID string) DeploymentsClient

NewDeploymentsClient creates an instance of the DeploymentsClient client.

func NewDeploymentsClientWithBaseURI 

func NewDeploymentsClientWithBaseURI(baseURI string, subscriptionID string) DeploymentsClient

NewDeploymentsClientWithBaseURI creates an instance of the DeploymentsClient client.

func (DeploymentsClient) Cancel 

func (client DeploymentsClient) Cancel(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.

resourceGroupName is the name of the resource group. The name is case insensitive. deploymentName is the name of the deployment to cancel.

func (DeploymentsClient) CancelPreparer 

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

CancelPreparer prepares the Cancel request.

func (DeploymentsClient) CancelResponder 

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

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

func (DeploymentsClient) CancelSender 

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

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

func (DeploymentsClient) CheckExistence 

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

CheckExistence checks whether the deployment exists.

resourceGroupName is the name of the resource group with the deployment to check. The name is case insensitive. deploymentName is the name of the deployment to check.

func (DeploymentsClient) CheckExistencePreparer 

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

CheckExistencePreparer prepares the CheckExistence request.

func (DeploymentsClient) CheckExistenceResponder 

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

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

func (DeploymentsClient) CheckExistenceSender 

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

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

func (DeploymentsClient) CreateOrUpdate 

func (client DeploymentsClient) CreateOrUpdate(resourceGroupName string, deploymentName string, parameters Deployment, cancel <-chan struct{}) (result autorest.Response, err error)

CreateOrUpdate you can provide the template and parameters directly in the request or link to JSON files. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. deploymentName is the name of the deployment. parameters is additional parameters supplied to the operation.

func (DeploymentsClient) CreateOrUpdatePreparer 

func (client DeploymentsClient) CreateOrUpdatePreparer(resourceGroupName string, deploymentName string, parameters Deployment, cancel <-chan struct{}) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DeploymentsClient) CreateOrUpdateResponder 

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

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

func (DeploymentsClient) CreateOrUpdateSender 

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

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

func (DeploymentsClient) Delete 

func (client DeploymentsClient) Delete(resourceGroupName string, deploymentName string, cancel <-chan struct{}) (result autorest.Response, 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group with the deployment to delete. The name is case insensitive. deploymentName is the name of the deployment to delete.

func (DeploymentsClient) DeletePreparer 

func (client DeploymentsClient) DeletePreparer(resourceGroupName string, deploymentName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DeploymentsClient) DeleteResponder 

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

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

func (DeploymentsClient) DeleteSender 

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

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

func (DeploymentsClient) ExportTemplate 

func (client DeploymentsClient) ExportTemplate(resourceGroupName string, deploymentName string) (result DeploymentExportResult, err error)

ExportTemplate exports the template used for specified deployment.

resourceGroupName is the name of the resource group. The name is case insensitive. deploymentName is the name of the deployment from which to get the template.

func (DeploymentsClient) ExportTemplatePreparer 

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

ExportTemplatePreparer prepares the ExportTemplate request.

func (DeploymentsClient) ExportTemplateResponder 

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

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

func (DeploymentsClient) ExportTemplateSender 

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

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

func (DeploymentsClient) Get 

func (client DeploymentsClient) Get(resourceGroupName string, deploymentName string) (result DeploymentExtended, err error)

Get gets a deployment.

resourceGroupName is the name of the resource group. The name is case insensitive. deploymentName is the name of the deployment to get.

func (DeploymentsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (DeploymentsClient) GetResponder 

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

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

func (DeploymentsClient) GetSender 

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

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

func (DeploymentsClient) List 

func (client DeploymentsClient) List(resourceGroupName string, filter string, top *int32) (result DeploymentListResult, err error)

List get all the deployments for a resource group.

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

func (DeploymentsClient) ListNextResults 

func (client DeploymentsClient) ListNextResults(lastResults DeploymentListResult) (result DeploymentListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (DeploymentsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (DeploymentsClient) ListResponder 

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

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

func (DeploymentsClient) ListSender 

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

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

func (DeploymentsClient) Validate 

func (client DeploymentsClient) Validate(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..

resourceGroupName is the name of the resource group the template will be deployed to. The name is case insensitive. deploymentName is the name of the deployment. parameters is parameters to validate.

func (DeploymentsClient) ValidatePreparer 

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

ValidatePreparer prepares the Validate request.

func (DeploymentsClient) ValidateResponder 

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

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

func (DeploymentsClient) ValidateSender 

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

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

type ExportTemplateRequest 

type ExportTemplateRequest struct {
	ResourcesProperty *[]string `json:"resources,omitempty"`
	Options           *string   `json:"options,omitempty"`
}

ExportTemplateRequest is export resource group template request parameters.

type GenericResource 

type GenericResource struct {
	autorest.Response `json:"-"`
	ID                *string                 `json:"id,omitempty"`
	Name              *string                 `json:"name,omitempty"`
	Type              *string                 `json:"type,omitempty"`
	Location          *string                 `json:"location,omitempty"`
	Tags              *map[string]*string     `json:"tags,omitempty"`
	Plan              *Plan                   `json:"plan,omitempty"`
	Properties        *map[string]interface{} `json:"properties,omitempty"`
	Kind              *string                 `json:"kind,omitempty"`
	ManagedBy         *string                 `json:"managedBy,omitempty"`
	Sku               *Sku                    `json:"sku,omitempty"`
	Identity          *Identity               `json:"identity,omitempty"`
}

GenericResource is resource information.

type GenericResourceFilter 

type GenericResourceFilter struct {
	ResourceType *string `json:"resourceType,omitempty"`
	Tagname      *string `json:"tagname,omitempty"`
	Tagvalue     *string `json:"tagvalue,omitempty"`
}

GenericResourceFilter is resource filter.

type Group 

type Group struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	Name              *string             `json:"name,omitempty"`
	Properties        *GroupProperties    `json:"properties,omitempty"`
	Location          *string             `json:"location,omitempty"`
	ManagedBy         *string             `json:"managedBy,omitempty"`
	Tags              *map[string]*string `json:"tags,omitempty"`
}

Group is resource group information.

type GroupClient 

type GroupClient struct {
	ManagementClient
}

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

func NewGroupClient 

func NewGroupClient(subscriptionID string) GroupClient

NewGroupClient creates an instance of the GroupClient client.

func NewGroupClientWithBaseURI 

func NewGroupClientWithBaseURI(baseURI string, subscriptionID string) GroupClient

NewGroupClientWithBaseURI creates an instance of the GroupClient client.

func (GroupClient) CheckExistence 

func (client GroupClient) CheckExistence(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (result autorest.Response, err error)

CheckExistence checks whether a resource exists.

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

func (GroupClient) CheckExistenceByID 

func (client GroupClient) CheckExistenceByID(resourceID string) (result autorest.Response, err error)

CheckExistenceByID checks by ID whether a resource exists.

resourceID is the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

func (GroupClient) CheckExistenceByIDPreparer 

func (client GroupClient) CheckExistenceByIDPreparer(resourceID string) (*http.Request, error)

CheckExistenceByIDPreparer prepares the CheckExistenceByID request.

func (GroupClient) CheckExistenceByIDResponder 

func (client GroupClient) 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 (GroupClient) CheckExistenceByIDSender 

func (client GroupClient) 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 (GroupClient) CheckExistencePreparer 

func (client GroupClient) CheckExistencePreparer(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (*http.Request, error)

CheckExistencePreparer prepares the CheckExistence request.

func (GroupClient) CheckExistenceResponder 

func (client GroupClient) 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 (GroupClient) CheckExistenceSender 

func (client GroupClient) 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 (GroupClient) CreateOrUpdate 

func (client GroupClient) CreateOrUpdate(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, parameters GenericResource, cancel <-chan struct{}) (result autorest.Response, err error)

CreateOrUpdate creates a resource. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group for the resource. The name is case insensitive. resourceProviderNamespace is the namespace of the resource provider. parentResourcePath is the parent resource identity. resourceType is the resource type of the resource to create. resourceName is the name of the resource to create. parameters is parameters for creating or updating the resource.

func (GroupClient) CreateOrUpdateByID 

func (client GroupClient) CreateOrUpdateByID(resourceID string, parameters GenericResource, cancel <-chan struct{}) (result autorest.Response, err error)

CreateOrUpdateByID create a resource by ID. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

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

func (GroupClient) CreateOrUpdateByIDPreparer 

func (client GroupClient) CreateOrUpdateByIDPreparer(resourceID string, parameters GenericResource, cancel <-chan struct{}) (*http.Request, error)

CreateOrUpdateByIDPreparer prepares the CreateOrUpdateByID request.

func (GroupClient) CreateOrUpdateByIDResponder 

func (client GroupClient) CreateOrUpdateByIDResponder(resp *http.Response) (result autorest.Response, err error)

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

func (GroupClient) CreateOrUpdateByIDSender 

func (client GroupClient) CreateOrUpdateByIDSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) CreateOrUpdatePreparer 

func (client GroupClient) CreateOrUpdatePreparer(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, parameters GenericResource, cancel <-chan struct{}) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupClient) CreateOrUpdateResponder 

func (client GroupClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (GroupClient) CreateOrUpdateSender 

func (client GroupClient) 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 (GroupClient) Delete 

func (client GroupClient) Delete(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, cancel <-chan struct{}) (result autorest.Response, err error)

Delete deletes a resource. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

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

func (GroupClient) DeleteByID 

func (client GroupClient) DeleteByID(resourceID string, cancel <-chan struct{}) (result autorest.Response, err error)

DeleteByID deletes a resource by ID. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceID is the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

func (GroupClient) DeleteByIDPreparer 

func (client GroupClient) DeleteByIDPreparer(resourceID string, cancel <-chan struct{}) (*http.Request, error)

DeleteByIDPreparer prepares the DeleteByID request.

func (GroupClient) DeleteByIDResponder 

func (client GroupClient) 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 (GroupClient) DeleteByIDSender 

func (client GroupClient) DeleteByIDSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) DeletePreparer 

func (client GroupClient) DeletePreparer(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupClient) DeleteResponder 

func (client GroupClient) 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 (GroupClient) DeleteSender 

func (client GroupClient) 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 (GroupClient) Get 

func (client GroupClient) Get(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (result GenericResource, err error)

Get gets a resource.

resourceGroupName is the name of the resource group containing the resource to get. The name is case insensitive. resourceProviderNamespace is the namespace of the resource provider. parentResourcePath is the parent resource identity. resourceType is the resource type of the resource. resourceName is the name of the resource to get.

func (GroupClient) GetByID 

func (client GroupClient) GetByID(resourceID string) (result GenericResource, err error)

GetByID gets a resource by ID.

resourceID is the fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

func (GroupClient) GetByIDPreparer 

func (client GroupClient) GetByIDPreparer(resourceID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (GroupClient) GetByIDResponder 

func (client GroupClient) 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 (GroupClient) GetByIDSender 

func (client GroupClient) 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 (GroupClient) GetPreparer 

func (client GroupClient) GetPreparer(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupClient) GetResponder 

func (client GroupClient) 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 (GroupClient) GetSender 

func (client GroupClient) 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 (GroupClient) List 

func (client GroupClient) List(filter string, expand string, top *int32) (result ListResult, err error)

List get all the resources in a subscription.

filter is the filter to apply on the operation. expand is the $expand query parameter. top is the number of results to return. If null is passed, returns all resource groups.

func (GroupClient) ListNextResults 

func (client GroupClient) ListNextResults(lastResults ListResult) (result ListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (GroupClient) ListPreparer 

func (client GroupClient) ListPreparer(filter string, expand string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupClient) ListResponder 

func (client GroupClient) 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 (GroupClient) ListSender 

func (client GroupClient) 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 (GroupClient) MoveResources 

func (client GroupClient) MoveResources(sourceResourceGroupName string, parameters MoveInfo, cancel <-chan struct{}) (result autorest.Response, 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

sourceResourceGroupName is the name of the resource group containing the rsources to move. parameters is parameters for moving resources.

func (GroupClient) MoveResourcesPreparer 

func (client GroupClient) MoveResourcesPreparer(sourceResourceGroupName string, parameters MoveInfo, cancel <-chan struct{}) (*http.Request, error)

MoveResourcesPreparer prepares the MoveResources request.

func (GroupClient) MoveResourcesResponder 

func (client GroupClient) 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 (GroupClient) MoveResourcesSender 

func (client GroupClient) MoveResourcesSender(req *http.Request) (*http.Response, error)

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

type GroupExportResult 

type GroupExportResult struct {
	autorest.Response `json:"-"`
	Template          *map[string]interface{}     `json:"template,omitempty"`
	Error             *ManagementErrorWithDetails `json:"error,omitempty"`
}

GroupExportResult is

type GroupFilter 

type GroupFilter struct {
	TagName  *string `json:"tagName,omitempty"`
	TagValue *string `json:"tagValue,omitempty"`
}

GroupFilter is resource group filter.

type GroupListResult 

type GroupListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Group `json:"value,omitempty"`
	NextLink          *string  `json:"nextLink,omitempty"`
}

GroupListResult is list of resource groups.

func (GroupListResult) GroupListResultPreparer 

func (client GroupListResult) GroupListResultPreparer() (*http.Request, error)

GroupListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type GroupProperties 

type GroupProperties struct {
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

GroupProperties is the resource group properties.

type GroupsClient 

type GroupsClient struct {
	ManagementClient
}

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

func NewGroupsClient 

func NewGroupsClient(subscriptionID string) GroupsClient

NewGroupsClient creates an instance of the GroupsClient client.

func NewGroupsClientWithBaseURI 

func NewGroupsClientWithBaseURI(baseURI string, subscriptionID string) GroupsClient

NewGroupsClientWithBaseURI creates an instance of the GroupsClient client.

func (GroupsClient) CheckExistence 

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

CheckExistence checks whether a resource group exists.

resourceGroupName is the name of the resource group to check. The name is case insensitive.

func (GroupsClient) CheckExistencePreparer 

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

CheckExistencePreparer prepares the CheckExistence request.

func (GroupsClient) CheckExistenceResponder 

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

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

func (GroupsClient) CheckExistenceSender 

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

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

func (GroupsClient) CreateOrUpdate 

func (client GroupsClient) CreateOrUpdate(resourceGroupName string, parameters Group) (result Group, err error)

CreateOrUpdate creates a resource group.

resourceGroupName is the name of the resource group to create or update. parameters is parameters supplied to the create or update a resource group.

func (GroupsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupsClient) CreateOrUpdateResponder 

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

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

func (GroupsClient) CreateOrUpdateSender 

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

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

func (GroupsClient) Delete 

func (client GroupsClient) Delete(resourceGroupName string, cancel <-chan struct{}) (result autorest.Response, 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group to delete. The name is case insensitive.

func (GroupsClient) DeletePreparer 

func (client GroupsClient) DeletePreparer(resourceGroupName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupsClient) DeleteResponder 

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

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

func (GroupsClient) DeleteSender 

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

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

func (GroupsClient) ExportTemplate 

func (client GroupsClient) ExportTemplate(resourceGroupName string, parameters ExportTemplateRequest) (result GroupExportResult, err error)

ExportTemplate captures the specified resource group as a template.

resourceGroupName is the name of the resource group to export as a template. parameters is parameters for exporting the template.

func (GroupsClient) ExportTemplatePreparer 

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

ExportTemplatePreparer prepares the ExportTemplate request.

func (GroupsClient) ExportTemplateResponder 

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

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

func (GroupsClient) ExportTemplateSender 

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

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

func (GroupsClient) Get 

func (client GroupsClient) Get(resourceGroupName string) (result Group, err error)

Get gets a resource group.

resourceGroupName is the name of the resource group to get. The name is case insensitive.

func (GroupsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (GroupsClient) GetResponder 

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

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

func (GroupsClient) GetSender 

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

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

func (GroupsClient) List 

func (client GroupsClient) List(filter string, top *int32) (result GroupListResult, err error)

List gets all the resource groups for a subscription.

filter is the filter to apply on the operation. top is the number of results to return. If null is passed, returns all resource groups.

func (GroupsClient) ListNextResults 

func (client GroupsClient) ListNextResults(lastResults GroupListResult) (result GroupListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (GroupsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (GroupsClient) ListResources 

func (client GroupsClient) ListResources(resourceGroupName string, filter string, expand string, top *int32) (result ListResult, err error)

ListResources get all the resources for a resource group.

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

func (GroupsClient) ListResourcesNextResults 

func (client GroupsClient) ListResourcesNextResults(lastResults ListResult) (result ListResult, err error)

ListResourcesNextResults retrieves the next set of results, if any.

func (GroupsClient) ListResourcesPreparer 

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

ListResourcesPreparer prepares the ListResources request.

func (GroupsClient) ListResourcesResponder 

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

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

func (GroupsClient) ListResourcesSender 

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

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

func (GroupsClient) ListResponder 

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

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

func (GroupsClient) ListSender 

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

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

func (GroupsClient) Patch 

func (client GroupsClient) Patch(resourceGroupName string, parameters Group) (result Group, err error)

Patch resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

resourceGroupName is the name of the resource group to update. The name is case insensitive. parameters is parameters supplied to update a resource group.

func (GroupsClient) PatchPreparer 

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

PatchPreparer prepares the Patch request.

func (GroupsClient) PatchResponder 

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

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

func (GroupsClient) PatchSender 

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

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

type HTTPMessage 

type HTTPMessage struct {
	Content *map[string]interface{} `json:"content,omitempty"`
}

HTTPMessage is

type Identity 

type Identity struct {
	PrincipalID *string              `json:"principalId,omitempty"`
	TenantID    *string              `json:"tenantId,omitempty"`
	Type        ResourceIdentityType `json:"type,omitempty"`
}

Identity is identity for the resource.

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	Value             *[]GenericResource `json:"value,omitempty"`
	NextLink          *string            `json:"nextLink,omitempty"`
}

ListResult is list of resource groups.

func (ListResult) ListResultPreparer 

func (client ListResult) ListResultPreparer() (*http.Request, error)

ListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Resources.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type ManagementErrorWithDetails 

type ManagementErrorWithDetails struct {
	Code    *string                       `json:"code,omitempty"`
	Message *string                       `json:"message,omitempty"`
	Target  *string                       `json:"target,omitempty"`
	Details *[]ManagementErrorWithDetails `json:"details,omitempty"`
}

ManagementErrorWithDetails is

type MoveInfo 

type MoveInfo struct {
	ResourcesProperty   *[]string `json:"resources,omitempty"`
	TargetResourceGroup *string   `json:"targetResourceGroup,omitempty"`
}

MoveInfo is parameters of move resources. 

type ParametersLink struct {
	URI            *string `json:"uri,omitempty"`
	ContentVersion *string `json:"contentVersion,omitempty"`
}

ParametersLink is entity representing the reference to the deployment paramaters.

type Plan 

type Plan struct {
	Name          *string `json:"name,omitempty"`
	Publisher     *string `json:"publisher,omitempty"`
	Product       *string `json:"product,omitempty"`
	PromotionCode *string `json:"promotionCode,omitempty"`
}

Plan is plan for the resource.

type Provider 

type Provider struct {
	autorest.Response `json:"-"`
	ID                *string                 `json:"id,omitempty"`
	Namespace         *string                 `json:"namespace,omitempty"`
	RegistrationState *string                 `json:"registrationState,omitempty"`
	ResourceTypes     *[]ProviderResourceType `json:"resourceTypes,omitempty"`
}

Provider is resource provider information.

type ProviderListResult 

type ProviderListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Provider `json:"value,omitempty"`
	NextLink          *string     `json:"nextLink,omitempty"`
}

ProviderListResult is list of resource providers.

func (ProviderListResult) ProviderListResultPreparer 

func (client ProviderListResult) ProviderListResultPreparer() (*http.Request, error)

ProviderListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ProviderOperationDisplayProperties 

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

ProviderOperationDisplayProperties is resource provider operation's display properties.

type ProviderResourceType 

type ProviderResourceType struct {
	ResourceType *string             `json:"resourceType,omitempty"`
	Locations    *[]string           `json:"locations,omitempty"`
	Aliases      *[]AliasType        `json:"aliases,omitempty"`
	APIVersions  *[]string           `json:"apiVersions,omitempty"`
	Properties   *map[string]*string `json:"properties,omitempty"`
}

ProviderResourceType is resource type managed by the resource provider.

type ProvidersClient 

type ProvidersClient struct {
	ManagementClient
}

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

func NewProvidersClient 

func NewProvidersClient(subscriptionID string) ProvidersClient

NewProvidersClient creates an instance of the ProvidersClient client.

func NewProvidersClientWithBaseURI 

func NewProvidersClientWithBaseURI(baseURI string, subscriptionID string) ProvidersClient

NewProvidersClientWithBaseURI creates an instance of the ProvidersClient client.

func (ProvidersClient) Get 

func (client ProvidersClient) Get(resourceProviderNamespace string, expand string) (result Provider, err error)

Get gets the specified resource provider.

resourceProviderNamespace is the namespace of the resource provider. expand is the $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

func (ProvidersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (ProvidersClient) GetResponder 

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

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

func (ProvidersClient) GetSender 

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

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

func (ProvidersClient) List 

func (client ProvidersClient) List(top *int32, expand string) (result ProviderListResult, err error)

List gets all resource providers for a subscription.

top is the number of results to return. If null is passed returns all deployments. expand is the properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

func (ProvidersClient) ListNextResults 

func (client ProvidersClient) ListNextResults(lastResults ProviderListResult) (result ProviderListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (ProvidersClient) ListPreparer 

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

ListPreparer prepares the List request.

func (ProvidersClient) ListResponder 

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

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

func (ProvidersClient) ListSender 

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

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

func (ProvidersClient) Register 

func (client ProvidersClient) Register(resourceProviderNamespace string) (result Provider, err error)

Register registers a subscription with a resource provider.

resourceProviderNamespace is the namespace of the resource provider to register.

func (ProvidersClient) RegisterPreparer 

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

RegisterPreparer prepares the Register request.

func (ProvidersClient) RegisterResponder 

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

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

func (ProvidersClient) RegisterSender 

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

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

func (ProvidersClient) Unregister 

func (client ProvidersClient) Unregister(resourceProviderNamespace string) (result Provider, err error)

Unregister unregisters a subscription from a resource provider.

resourceProviderNamespace is the namespace of the resource provider to unregister.

func (ProvidersClient) UnregisterPreparer 

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

UnregisterPreparer prepares the Unregister request.

func (ProvidersClient) UnregisterResponder 

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

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

func (ProvidersClient) UnregisterSender 

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

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

type Resource 

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

Resource is

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType enumerates the values for resource identity type. 

const (
	// SystemAssigned specifies the system assigned state for resource identity
	// type.
	SystemAssigned ResourceIdentityType = "SystemAssigned"
)

type Sku 

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

Sku is sKU for the resource.

type SubResource 

type SubResource struct {
	ID *string `json:"id,omitempty"`
}

SubResource is

type TagCount 

type TagCount struct {
	Type  *string `json:"type,omitempty"`
	Value *int32  `json:"value,omitempty"`
}

TagCount is tag count.

type TagDetails 

type TagDetails struct {
	autorest.Response `json:"-"`
	ID                *string     `json:"id,omitempty"`
	TagName           *string     `json:"tagName,omitempty"`
	Count             *TagCount   `json:"count,omitempty"`
	Values            *[]TagValue `json:"values,omitempty"`
}

TagDetails is tag details.

type TagValue 

type TagValue struct {
	autorest.Response `json:"-"`
	ID                *string   `json:"id,omitempty"`
	TagValue          *string   `json:"tagValue,omitempty"`
	Count             *TagCount `json:"count,omitempty"`
}

TagValue is tag information.

type TagsClient 

type TagsClient struct {
	ManagementClient
}

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

func NewTagsClient 

func NewTagsClient(subscriptionID string) TagsClient

NewTagsClient creates an instance of the TagsClient client.

func NewTagsClientWithBaseURI 

func NewTagsClientWithBaseURI(baseURI string, subscriptionID string) TagsClient

NewTagsClientWithBaseURI creates an instance of the TagsClient client.

func (TagsClient) CreateOrUpdate 

func (client TagsClient) CreateOrUpdate(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.

tagName is the name of the tag to create.

func (TagsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TagsClient) CreateOrUpdateResponder 

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

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

func (TagsClient) CreateOrUpdateSender 

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

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

func (TagsClient) CreateOrUpdateValue 

func (client TagsClient) CreateOrUpdateValue(tagName string, tagValue string) (result TagValue, err error)

CreateOrUpdateValue creates a tag value. The name of the tag must already exist.

tagName is the name of the tag. tagValue is the value of the tag to create.

func (TagsClient) CreateOrUpdateValuePreparer 

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

CreateOrUpdateValuePreparer prepares the CreateOrUpdateValue request.

func (TagsClient) CreateOrUpdateValueResponder 

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

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

func (TagsClient) CreateOrUpdateValueSender 

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

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

func (TagsClient) Delete 

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

Delete you must remove all values from a resource tag before you can delete it.

tagName is the name of the tag.

func (TagsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (TagsClient) DeleteResponder 

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

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

func (TagsClient) DeleteSender 

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

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

func (TagsClient) DeleteValue 

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

DeleteValue deletes a tag value.

tagName is the name of the tag. tagValue is the value of the tag to delete.

func (TagsClient) DeleteValuePreparer 

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

DeleteValuePreparer prepares the DeleteValue request.

func (TagsClient) DeleteValueResponder 

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

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

func (TagsClient) DeleteValueSender 

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

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

func (TagsClient) List 

func (client TagsClient) List() (result TagsListResult, err error)

List gets the names and values of all resource tags that are defined in a subscription.

func (TagsClient) ListNextResults 

func (client TagsClient) ListNextResults(lastResults TagsListResult) (result TagsListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (TagsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (TagsClient) ListResponder 

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

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

func (TagsClient) ListSender 

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

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

type TagsListResult 

type TagsListResult struct {
	autorest.Response `json:"-"`
	Value             *[]TagDetails `json:"value,omitempty"`
	NextLink          *string       `json:"nextLink,omitempty"`
}

TagsListResult is list of subscription tags.

func (TagsListResult) TagsListResultPreparer 

func (client TagsListResult) TagsListResultPreparer() (*http.Request, error)

TagsListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type TargetResource 

type TargetResource struct {
	ID           *string `json:"id,omitempty"`
	ResourceName *string `json:"resourceName,omitempty"`
	ResourceType *string `json:"resourceType,omitempty"`
}

TargetResource is target resource. 

type TemplateLink struct {
	URI            *string `json:"uri,omitempty"`
	ContentVersion *string `json:"contentVersion,omitempty"`
}

TemplateLink is entity representing the reference to the template.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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