deploymentmanager

package
v45.1.2+incompatible Latest Latest
Warning

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

Go to latest
Published: Aug 18, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package deploymentmanager implements the Azure ARM Deploymentmanager service API version 2019-11-01-preview.

REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Deploymentmanager
	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 APIKeyAuthentication

type APIKeyAuthentication struct {
	// Name - The key name of the authentication key/value pair.
	Name *string `json:"name,omitempty"`
	// In - The location of the authentication key/value pair in the request. Possible values include: 'Query', 'Header'
	In RestAuthLocation `json:"in,omitempty"`
	// Value - The value of the authentication key/value pair.
	Value *string `json:"value,omitempty"`
	// Type - Possible values include: 'TypeRestRequestAuthentication', 'TypeRolloutIdentity', 'TypeAPIKey'
	Type TypeBasicRestRequestAuthentication `json:"type,omitempty"`
}

APIKeyAuthentication apiKey authentication gives a name and a value that can be included in either the request header or query parameters.

func (APIKeyAuthentication) AsAPIKeyAuthentication

func (aka APIKeyAuthentication) AsAPIKeyAuthentication() (*APIKeyAuthentication, bool)

AsAPIKeyAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) AsBasicRestRequestAuthentication

func (aka APIKeyAuthentication) AsBasicRestRequestAuthentication() (BasicRestRequestAuthentication, bool)

AsBasicRestRequestAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) AsRestRequestAuthentication

func (aka APIKeyAuthentication) AsRestRequestAuthentication() (*RestRequestAuthentication, bool)

AsRestRequestAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) AsRolloutIdentityAuthentication

func (aka APIKeyAuthentication) AsRolloutIdentityAuthentication() (*RolloutIdentityAuthentication, bool)

AsRolloutIdentityAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) MarshalJSON

func (aka APIKeyAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for APIKeyAuthentication.

type ArtifactSource

type ArtifactSource struct {
	autorest.Response `json:"-"`
	// ArtifactSourceProperties - The properties that define the artifact source.
	*ArtifactSourceProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

ArtifactSource the resource that defines the source location where the artifacts are located.

func (ArtifactSource) MarshalJSON

func (as ArtifactSource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ArtifactSource.

func (*ArtifactSource) UnmarshalJSON

func (as *ArtifactSource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ArtifactSource struct.

type ArtifactSourceProperties

type ArtifactSourceProperties struct {
	// SourceType - The type of artifact source used.
	SourceType *string `json:"sourceType,omitempty"`
	// ArtifactRoot - The path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.
	ArtifactRoot *string `json:"artifactRoot,omitempty"`
	// Authentication - The authentication method to use to access the artifact source.
	Authentication BasicAuthentication `json:"authentication,omitempty"`
}

ArtifactSourceProperties the properties that define the artifact source.

func (*ArtifactSourceProperties) UnmarshalJSON

func (as *ArtifactSourceProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ArtifactSourceProperties struct.

type ArtifactSourcePropertiesModel

type ArtifactSourcePropertiesModel struct {
	// SourceType - The type of artifact source used.
	SourceType *string `json:"sourceType,omitempty"`
	// ArtifactRoot - The path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.
	ArtifactRoot *string `json:"artifactRoot,omitempty"`
	// Authentication - The authentication method to use to access the artifact source.
	Authentication BasicAuthentication `json:"authentication,omitempty"`
}

ArtifactSourcePropertiesModel the properties that define the source location where the artifacts are located.

func (*ArtifactSourcePropertiesModel) UnmarshalJSON

func (aspm *ArtifactSourcePropertiesModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ArtifactSourcePropertiesModel struct.

type ArtifactSourcesClient

type ArtifactSourcesClient struct {
	BaseClient
}

ArtifactSourcesClient is the REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

func NewArtifactSourcesClient

func NewArtifactSourcesClient(subscriptionID string) ArtifactSourcesClient

NewArtifactSourcesClient creates an instance of the ArtifactSourcesClient client.

func NewArtifactSourcesClientWithBaseURI

func NewArtifactSourcesClientWithBaseURI(baseURI string, subscriptionID string) ArtifactSourcesClient

NewArtifactSourcesClientWithBaseURI creates an instance of the ArtifactSourcesClient 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 (ArtifactSourcesClient) CreateOrUpdate

func (client ArtifactSourcesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, artifactSourceName string, artifactSourceInfo *ArtifactSource) (result ArtifactSource, err error)

CreateOrUpdate synchronously creates a new artifact source or updates an existing artifact source. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. artifactSourceName - the name of the artifact source. artifactSourceInfo - source object that defines the resource.

func (ArtifactSourcesClient) CreateOrUpdatePreparer

func (client ArtifactSourcesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, artifactSourceName string, artifactSourceInfo *ArtifactSource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ArtifactSourcesClient) CreateOrUpdateResponder

func (client ArtifactSourcesClient) CreateOrUpdateResponder(resp *http.Response) (result ArtifactSource, err error)

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

func (ArtifactSourcesClient) CreateOrUpdateSender

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

func (client ArtifactSourcesClient) Delete(ctx context.Context, resourceGroupName string, artifactSourceName string) (result autorest.Response, err error)

Delete sends the delete request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. artifactSourceName - the name of the artifact source.

func (ArtifactSourcesClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (ArtifactSourcesClient) DeleteResponder

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

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

func (client ArtifactSourcesClient) Get(ctx context.Context, resourceGroupName string, artifactSourceName string) (result ArtifactSource, err error)

Get sends the get request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. artifactSourceName - the name of the artifact source.

func (ArtifactSourcesClient) GetPreparer

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

GetPreparer prepares the Get request.

func (ArtifactSourcesClient) GetResponder

func (client ArtifactSourcesClient) GetResponder(resp *http.Response) (result ArtifactSource, err error)

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

func (ArtifactSourcesClient) GetSender

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

func (client ArtifactSourcesClient) List(ctx context.Context, resourceGroupName string) (result ListArtifactSource, err error)

List sends the list request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (ArtifactSourcesClient) ListPreparer

func (client ArtifactSourcesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (ArtifactSourcesClient) ListResponder

func (client ArtifactSourcesClient) ListResponder(resp *http.Response) (result ListArtifactSource, err error)

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

func (ArtifactSourcesClient) ListSender

func (client ArtifactSourcesClient) 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 Authentication

type Authentication struct {
	// Type - Possible values include: 'TypeAuthentication', 'TypeSas'
	Type Type `json:"type,omitempty"`
}

Authentication defines the authentication method and properties to access the artifacts.

func (Authentication) AsAuthentication

func (a Authentication) AsAuthentication() (*Authentication, bool)

AsAuthentication is the BasicAuthentication implementation for Authentication.

func (Authentication) AsBasicAuthentication

func (a Authentication) AsBasicAuthentication() (BasicAuthentication, bool)

AsBasicAuthentication is the BasicAuthentication implementation for Authentication.

func (Authentication) AsSasAuthentication

func (a Authentication) AsSasAuthentication() (*SasAuthentication, bool)

AsSasAuthentication is the BasicAuthentication implementation for Authentication.

func (Authentication) MarshalJSON

func (a Authentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Authentication.

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for a Azure Resource Manager resource with an etag.

type BaseClient

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

BaseClient is the base client for Deploymentmanager.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

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

type BasicAuthentication

type BasicAuthentication interface {
	AsSasAuthentication() (*SasAuthentication, bool)
	AsAuthentication() (*Authentication, bool)
}

BasicAuthentication defines the authentication method and properties to access the artifacts.

type BasicHealthCheckStepAttributes

type BasicHealthCheckStepAttributes interface {
	AsRestHealthCheckStepAttributes() (*RestHealthCheckStepAttributes, bool)
	AsHealthCheckStepAttributes() (*HealthCheckStepAttributes, bool)
}

BasicHealthCheckStepAttributes the attributes for the health check step.

type BasicRestRequestAuthentication

type BasicRestRequestAuthentication interface {
	AsRolloutIdentityAuthentication() (*RolloutIdentityAuthentication, bool)
	AsAPIKeyAuthentication() (*APIKeyAuthentication, bool)
	AsRestRequestAuthentication() (*RestRequestAuthentication, bool)
}

BasicRestRequestAuthentication the authentication information required in the REST health check request to the health provider.

type BasicStepProperties

type BasicStepProperties interface {
	AsHealthCheckStepProperties() (*HealthCheckStepProperties, bool)
	AsWaitStepProperties() (*WaitStepProperties, bool)
	AsStepProperties() (*StepProperties, bool)
}

BasicStepProperties the properties of a step resource.

type CloudError

type CloudError struct {
	// Error - The properties that define the error.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError the error information object.

type CloudErrorBody

type CloudErrorBody struct {
	// Code - READ-ONLY; Error code string.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; Descriptive error information.
	Message *string `json:"message,omitempty"`
	// Target - Error target
	Target *string `json:"target,omitempty"`
	// Details - More detailed error information.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody detailed error information of any failure.

func (CloudErrorBody) MarshalJSON

func (ceb CloudErrorBody) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CloudErrorBody.

type DeploymentMode

type DeploymentMode string

DeploymentMode enumerates the values for deployment mode.

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

func PossibleDeploymentModeValues

func PossibleDeploymentModeValues() []DeploymentMode

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

type HealthCheckStepAttributes

type HealthCheckStepAttributes struct {
	// WaitDuration - The duration in ISO 8601 format for which health check waits idly without any checks.
	WaitDuration *string `json:"waitDuration,omitempty"`
	// MaxElasticDuration - The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
	MaxElasticDuration *string `json:"maxElasticDuration,omitempty"`
	// HealthyStateDuration - The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
	HealthyStateDuration *string `json:"healthyStateDuration,omitempty"`
	// Type - Possible values include: 'TypeHealthCheckStepAttributes', 'TypeREST'
	Type TypeBasicHealthCheckStepAttributes `json:"type,omitempty"`
}

HealthCheckStepAttributes the attributes for the health check step.

func (HealthCheckStepAttributes) AsBasicHealthCheckStepAttributes

func (hcsa HealthCheckStepAttributes) AsBasicHealthCheckStepAttributes() (BasicHealthCheckStepAttributes, bool)

AsBasicHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for HealthCheckStepAttributes.

func (HealthCheckStepAttributes) AsHealthCheckStepAttributes

func (hcsa HealthCheckStepAttributes) AsHealthCheckStepAttributes() (*HealthCheckStepAttributes, bool)

AsHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for HealthCheckStepAttributes.

func (HealthCheckStepAttributes) AsRestHealthCheckStepAttributes

func (hcsa HealthCheckStepAttributes) AsRestHealthCheckStepAttributes() (*RestHealthCheckStepAttributes, bool)

AsRestHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for HealthCheckStepAttributes.

func (HealthCheckStepAttributes) MarshalJSON

func (hcsa HealthCheckStepAttributes) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HealthCheckStepAttributes.

type HealthCheckStepProperties

type HealthCheckStepProperties struct {
	// Attributes - The health check step attributes
	Attributes BasicHealthCheckStepAttributes `json:"attributes,omitempty"`
	// StepType - Possible values include: 'StepTypeStepProperties', 'StepTypeHealthCheck', 'StepTypeWait'
	StepType StepType `json:"stepType,omitempty"`
}

HealthCheckStepProperties defines the properties of a health check step.

func (HealthCheckStepProperties) AsBasicStepProperties

func (hcsp HealthCheckStepProperties) AsBasicStepProperties() (BasicStepProperties, bool)

AsBasicStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) AsHealthCheckStepProperties

func (hcsp HealthCheckStepProperties) AsHealthCheckStepProperties() (*HealthCheckStepProperties, bool)

AsHealthCheckStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) AsStepProperties

func (hcsp HealthCheckStepProperties) AsStepProperties() (*StepProperties, bool)

AsStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) AsWaitStepProperties

func (hcsp HealthCheckStepProperties) AsWaitStepProperties() (*WaitStepProperties, bool)

AsWaitStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) MarshalJSON

func (hcsp HealthCheckStepProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HealthCheckStepProperties.

func (*HealthCheckStepProperties) UnmarshalJSON

func (hcsp *HealthCheckStepProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for HealthCheckStepProperties struct.

type Identity

type Identity struct {
	// Type - The identity type.
	Type *string `json:"type,omitempty"`
	// IdentityIds - The list of identities.
	IdentityIds *[]string `json:"identityIds,omitempty"`
}

Identity identity for the resource.

type ListArtifactSource

type ListArtifactSource struct {
	autorest.Response `json:"-"`
	Value             *[]ArtifactSource `json:"value,omitempty"`
}

ListArtifactSource ...

type ListRollout

type ListRollout struct {
	autorest.Response `json:"-"`
	Value             *[]Rollout `json:"value,omitempty"`
}

ListRollout ...

type ListServiceResource

type ListServiceResource struct {
	autorest.Response `json:"-"`
	Value             *[]ServiceResource `json:"value,omitempty"`
}

ListServiceResource ...

type ListServiceTopologyResource

type ListServiceTopologyResource struct {
	autorest.Response `json:"-"`
	Value             *[]ServiceTopologyResource `json:"value,omitempty"`
}

ListServiceTopologyResource ...

type ListServiceUnitResource

type ListServiceUnitResource struct {
	autorest.Response `json:"-"`
	Value             *[]ServiceUnitResource `json:"value,omitempty"`
}

ListServiceUnitResource ...

type ListStepResource

type ListStepResource struct {
	autorest.Response `json:"-"`
	Value             *[]StepResource `json:"value,omitempty"`
}

ListStepResource ...

type Message

type Message struct {
	// TimeStamp - READ-ONLY; Time in UTC this message was provided.
	TimeStamp *date.Time `json:"timeStamp,omitempty"`
	// Message - READ-ONLY; The actual message text.
	Message *string `json:"message,omitempty"`
}

Message supplementary contextual messages during a rollout.

type Operation

type Operation struct {
	// Name - The name of the operation.
	Name *string `json:"name,omitempty"`
	// Display - The display name of the operation.
	Display *OperationDetail `json:"display,omitempty"`
	// Origin - The origin of the operation.
	Origin *string `json:"origin,omitempty"`
	// Properties - The properties of the operation.
	Properties interface{} `json:"properties,omitempty"`
}

Operation represents an operation that can be performed on the service.

type OperationDetail

type OperationDetail struct {
	// Provider - The name of the provider that supports the operation.
	Provider *string `json:"provider,omitempty"`
	// Resource - The resource type on which this operation can be performed.
	Resource *string `json:"resource,omitempty"`
	// Operation - The name of the operation.
	Operation *string `json:"operation,omitempty"`
	// Description - The description of the operation.
	Description *string `json:"description,omitempty"`
}

OperationDetail the detail about an operation.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationsList, err error)

List sends the list request.

func (OperationsClient) ListPreparer

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationsList, err error)

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

func (OperationsClient) ListSender

func (client OperationsClient) 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 OperationsList

type OperationsList struct {
	autorest.Response `json:"-"`
	// Value - The list of supported operations
	Value *Operation `json:"value,omitempty"`
}

OperationsList the operations response.

type PrePostStep

type PrePostStep struct {
	// StepID - The resource Id of the step to be run.
	StepID *string `json:"stepId,omitempty"`
}

PrePostStep the properties that define a step.

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

Resource ...

type ResourceOperation

type ResourceOperation struct {
	// ResourceName - Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template.
	ResourceName *string `json:"resourceName,omitempty"`
	// OperationID - READ-ONLY; Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service.
	OperationID *string `json:"operationId,omitempty"`
	// ResourceType - Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template.
	ResourceType *string `json:"resourceType,omitempty"`
	// ProvisioningState - READ-ONLY; State of the resource deployment. For ARM resources, this is the current provisioning state of the resource.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// StatusMessage - READ-ONLY; Descriptive information of the resource operation.
	StatusMessage *string `json:"statusMessage,omitempty"`
	// StatusCode - READ-ONLY; Http status code of the operation.
	StatusCode *string `json:"statusCode,omitempty"`
}

ResourceOperation individual resource operation information.

func (ResourceOperation) MarshalJSON

func (ro ResourceOperation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceOperation.

type RestAuthLocation

type RestAuthLocation string

RestAuthLocation enumerates the values for rest auth location.

const (
	// Header ...
	Header RestAuthLocation = "Header"
	// Query ...
	Query RestAuthLocation = "Query"
)

func PossibleRestAuthLocationValues

func PossibleRestAuthLocationValues() []RestAuthLocation

PossibleRestAuthLocationValues returns an array of possible values for the RestAuthLocation const type.

type RestHealthCheck

type RestHealthCheck struct {
	// Name - A unique name for this check.
	Name *string `json:"name,omitempty"`
	// Request - The request to the health provider.
	Request *RestRequest `json:"request,omitempty"`
	// Response - The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.
	Response *RestResponse `json:"response,omitempty"`
}

RestHealthCheck a REST based health check

type RestHealthCheckStepAttributes

type RestHealthCheckStepAttributes struct {
	// RestParameters - The REST health check parameters.
	*RestParameters `json:"properties,omitempty"`
	// WaitDuration - The duration in ISO 8601 format for which health check waits idly without any checks.
	WaitDuration *string `json:"waitDuration,omitempty"`
	// MaxElasticDuration - The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
	MaxElasticDuration *string `json:"maxElasticDuration,omitempty"`
	// HealthyStateDuration - The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
	HealthyStateDuration *string `json:"healthyStateDuration,omitempty"`
	// Type - Possible values include: 'TypeHealthCheckStepAttributes', 'TypeREST'
	Type TypeBasicHealthCheckStepAttributes `json:"type,omitempty"`
}

RestHealthCheckStepAttributes defines the REST health check step properties.

func (RestHealthCheckStepAttributes) AsBasicHealthCheckStepAttributes

func (rhcsa RestHealthCheckStepAttributes) AsBasicHealthCheckStepAttributes() (BasicHealthCheckStepAttributes, bool)

AsBasicHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for RestHealthCheckStepAttributes.

func (RestHealthCheckStepAttributes) AsHealthCheckStepAttributes

func (rhcsa RestHealthCheckStepAttributes) AsHealthCheckStepAttributes() (*HealthCheckStepAttributes, bool)

AsHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for RestHealthCheckStepAttributes.

func (RestHealthCheckStepAttributes) AsRestHealthCheckStepAttributes

func (rhcsa RestHealthCheckStepAttributes) AsRestHealthCheckStepAttributes() (*RestHealthCheckStepAttributes, bool)

AsRestHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for RestHealthCheckStepAttributes.

func (RestHealthCheckStepAttributes) MarshalJSON

func (rhcsa RestHealthCheckStepAttributes) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RestHealthCheckStepAttributes.

func (*RestHealthCheckStepAttributes) UnmarshalJSON

func (rhcsa *RestHealthCheckStepAttributes) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RestHealthCheckStepAttributes struct.

type RestMatchQuantifier

type RestMatchQuantifier string

RestMatchQuantifier enumerates the values for rest match quantifier.

const (
	// All ...
	All RestMatchQuantifier = "All"
	// Any ...
	Any RestMatchQuantifier = "Any"
)

func PossibleRestMatchQuantifierValues

func PossibleRestMatchQuantifierValues() []RestMatchQuantifier

PossibleRestMatchQuantifierValues returns an array of possible values for the RestMatchQuantifier const type.

type RestParameters

type RestParameters struct {
	// HealthChecks - The list of checks that form the health check step.
	HealthChecks *[]RestHealthCheck `json:"healthChecks,omitempty"`
}

RestParameters the parameters for the REST health check.

type RestRequest

type RestRequest struct {
	// Method - The HTTP method to use for the request. Possible values include: 'GET', 'POST'
	Method RestRequestMethod `json:"method,omitempty"`
	// URI - The HTTP URI to use for the request.
	URI *string `json:"uri,omitempty"`
	// Authentication - The authentication information required in the request to the health provider.
	Authentication BasicRestRequestAuthentication `json:"authentication,omitempty"`
}

RestRequest the properties that make up a REST request

func (*RestRequest) UnmarshalJSON

func (rr *RestRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RestRequest struct.

type RestRequestAuthentication

type RestRequestAuthentication struct {
	// Type - Possible values include: 'TypeRestRequestAuthentication', 'TypeRolloutIdentity', 'TypeAPIKey'
	Type TypeBasicRestRequestAuthentication `json:"type,omitempty"`
}

RestRequestAuthentication the authentication information required in the REST health check request to the health provider.

func (RestRequestAuthentication) AsAPIKeyAuthentication

func (rra RestRequestAuthentication) AsAPIKeyAuthentication() (*APIKeyAuthentication, bool)

AsAPIKeyAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) AsBasicRestRequestAuthentication

func (rra RestRequestAuthentication) AsBasicRestRequestAuthentication() (BasicRestRequestAuthentication, bool)

AsBasicRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) AsRestRequestAuthentication

func (rra RestRequestAuthentication) AsRestRequestAuthentication() (*RestRequestAuthentication, bool)

AsRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) AsRolloutIdentityAuthentication

func (rra RestRequestAuthentication) AsRolloutIdentityAuthentication() (*RolloutIdentityAuthentication, bool)

AsRolloutIdentityAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) MarshalJSON

func (rra RestRequestAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RestRequestAuthentication.

type RestRequestMethod

type RestRequestMethod string

RestRequestMethod enumerates the values for rest request method.

const (
	// GET ...
	GET RestRequestMethod = "GET"
	// POST ...
	POST RestRequestMethod = "POST"
)

func PossibleRestRequestMethodValues

func PossibleRestRequestMethodValues() []RestRequestMethod

PossibleRestRequestMethodValues returns an array of possible values for the RestRequestMethod const type.

type RestResponse

type RestResponse struct {
	// SuccessStatusCodes - The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.
	SuccessStatusCodes *[]string `json:"successStatusCodes,omitempty"`
	// Regex - The regular expressions to match the response content with.
	Regex *RestResponseRegex `json:"regex,omitempty"`
}

RestResponse the properties that make up the expected REST response

type RestResponseRegex

type RestResponseRegex struct {
	// Matches - The list of regular expressions.
	Matches *[]string `json:"matches,omitempty"`
	// MatchQuantifier - Indicates whether any or all of the expressions should match with the response content. Possible values include: 'All', 'Any'
	MatchQuantifier RestMatchQuantifier `json:"matchQuantifier,omitempty"`
}

RestResponseRegex the regular expressions to match the response content with.

type Rollout

type Rollout struct {
	autorest.Response `json:"-"`
	// Identity - Identity for the resource.
	Identity *Identity `json:"identity,omitempty"`
	// RolloutProperties - The properties that define a rollout.
	*RolloutProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

Rollout defines the rollout.

func (Rollout) MarshalJSON

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

MarshalJSON is the custom marshaler for Rollout.

func (*Rollout) UnmarshalJSON

func (r *Rollout) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Rollout struct.

type RolloutIdentityAuthentication

type RolloutIdentityAuthentication struct {
	// Type - Possible values include: 'TypeRestRequestAuthentication', 'TypeRolloutIdentity', 'TypeAPIKey'
	Type TypeBasicRestRequestAuthentication `json:"type,omitempty"`
}

RolloutIdentityAuthentication rolloutIdentity uses the user-assigned managed identity authentication context specified in the Identity property during rollout creation.

func (RolloutIdentityAuthentication) AsAPIKeyAuthentication

func (ria RolloutIdentityAuthentication) AsAPIKeyAuthentication() (*APIKeyAuthentication, bool)

AsAPIKeyAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) AsBasicRestRequestAuthentication

func (ria RolloutIdentityAuthentication) AsBasicRestRequestAuthentication() (BasicRestRequestAuthentication, bool)

AsBasicRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) AsRestRequestAuthentication

func (ria RolloutIdentityAuthentication) AsRestRequestAuthentication() (*RestRequestAuthentication, bool)

AsRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) AsRolloutIdentityAuthentication

func (ria RolloutIdentityAuthentication) AsRolloutIdentityAuthentication() (*RolloutIdentityAuthentication, bool)

AsRolloutIdentityAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) MarshalJSON

func (ria RolloutIdentityAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RolloutIdentityAuthentication.

type RolloutOperationInfo

type RolloutOperationInfo struct {
	// RetryAttempt - READ-ONLY; The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0.
	RetryAttempt *int32 `json:"retryAttempt,omitempty"`
	// SkipSucceededOnRetry - READ-ONLY; True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise.
	SkipSucceededOnRetry *bool `json:"skipSucceededOnRetry,omitempty"`
	// StartTime - READ-ONLY; The start time of the rollout in UTC.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet.
	EndTime *date.Time `json:"endTime,omitempty"`
	// Error - READ-ONLY; The detailed error information for any failure.
	Error *CloudErrorBody `json:"error,omitempty"`
}

RolloutOperationInfo detailed runtime information of the rollout.

type RolloutProperties

type RolloutProperties struct {
	// BuildVersion - The version of the build being deployed.
	BuildVersion *string `json:"buildVersion,omitempty"`
	// ArtifactSourceID - The reference to the artifact source resource Id where the payload is located.
	ArtifactSourceID *string `json:"artifactSourceId,omitempty"`
	// TargetServiceTopologyID - The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
	TargetServiceTopologyID *string `json:"targetServiceTopologyId,omitempty"`
	// StepGroups - The list of step groups that define the orchestration.
	StepGroups *[]StepGroup `json:"stepGroups,omitempty"`
	// Status - READ-ONLY; The current status of the rollout.
	Status *string `json:"status,omitempty"`
	// TotalRetryAttempts - READ-ONLY; The cardinal count of total number of retries performed on the rollout at a given time.
	TotalRetryAttempts *int32 `json:"totalRetryAttempts,omitempty"`
	// OperationInfo - READ-ONLY; Operational information of the rollout.
	OperationInfo *RolloutOperationInfo `json:"operationInfo,omitempty"`
	// Services - READ-ONLY; The detailed information on the services being deployed.
	Services *[]Service `json:"services,omitempty"`
}

RolloutProperties the properties that define a rollout.

func (RolloutProperties) MarshalJSON

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

MarshalJSON is the custom marshaler for RolloutProperties.

type RolloutPropertiesModel

type RolloutPropertiesModel struct {
	// Status - READ-ONLY; The current status of the rollout.
	Status *string `json:"status,omitempty"`
	// TotalRetryAttempts - READ-ONLY; The cardinal count of total number of retries performed on the rollout at a given time.
	TotalRetryAttempts *int32 `json:"totalRetryAttempts,omitempty"`
	// OperationInfo - READ-ONLY; Operational information of the rollout.
	OperationInfo *RolloutOperationInfo `json:"operationInfo,omitempty"`
	// Services - READ-ONLY; The detailed information on the services being deployed.
	Services *[]Service `json:"services,omitempty"`
}

RolloutPropertiesModel defines the properties of a rollout.

type RolloutRequest

type RolloutRequest struct {
	autorest.Response `json:"-"`
	// Identity - Identity for the resource.
	Identity *Identity `json:"identity,omitempty"`
	// RolloutRequestProperties - Defines the properties that make up a rollout request.
	*RolloutRequestProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

RolloutRequest defines the PUT rollout request body.

func (RolloutRequest) MarshalJSON

func (rr RolloutRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RolloutRequest.

func (*RolloutRequest) UnmarshalJSON

func (rr *RolloutRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RolloutRequest struct.

type RolloutRequestProperties

type RolloutRequestProperties struct {
	// BuildVersion - The version of the build being deployed.
	BuildVersion *string `json:"buildVersion,omitempty"`
	// ArtifactSourceID - The reference to the artifact source resource Id where the payload is located.
	ArtifactSourceID *string `json:"artifactSourceId,omitempty"`
	// TargetServiceTopologyID - The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
	TargetServiceTopologyID *string `json:"targetServiceTopologyId,omitempty"`
	// StepGroups - The list of step groups that define the orchestration.
	StepGroups *[]StepGroup `json:"stepGroups,omitempty"`
}

RolloutRequestProperties the properties for defining a rollout.

type RolloutStep

type RolloutStep struct {
	// Name - Name of the step.
	Name *string `json:"name,omitempty"`
	// Status - READ-ONLY; Current state of the step.
	Status *string `json:"status,omitempty"`
	// StepGroup - The step group the current step is part of.
	StepGroup *string `json:"stepGroup,omitempty"`
	// OperationInfo - READ-ONLY; Detailed information of specific action execution.
	OperationInfo *StepOperationInfo `json:"operationInfo,omitempty"`
	// ResourceOperations - READ-ONLY; Set of resource operations that were performed, if any, on an Azure resource.
	ResourceOperations *[]ResourceOperation `json:"resourceOperations,omitempty"`
	// Messages - READ-ONLY; Supplementary informative messages during rollout.
	Messages *[]Message `json:"messages,omitempty"`
}

RolloutStep defines a specific step on a target service unit.

func (RolloutStep) MarshalJSON

func (rs RolloutStep) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RolloutStep.

type RolloutsClient

type RolloutsClient struct {
	BaseClient
}

RolloutsClient is the REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

func NewRolloutsClient

func NewRolloutsClient(subscriptionID string) RolloutsClient

NewRolloutsClient creates an instance of the RolloutsClient client.

func NewRolloutsClientWithBaseURI

func NewRolloutsClientWithBaseURI(baseURI string, subscriptionID string) RolloutsClient

NewRolloutsClientWithBaseURI creates an instance of the RolloutsClient 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 (RolloutsClient) Cancel

func (client RolloutsClient) Cancel(ctx context.Context, resourceGroupName string, rolloutName string) (result Rollout, err error)

Cancel only running rollouts can be canceled. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. rolloutName - the rollout name.

func (RolloutsClient) CancelPreparer

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

CancelPreparer prepares the Cancel request.

func (RolloutsClient) CancelResponder

func (client RolloutsClient) CancelResponder(resp *http.Response) (result Rollout, err error)

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

func (RolloutsClient) CancelSender

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

func (client RolloutsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, rolloutName string, rolloutRequest *RolloutRequest) (result RolloutsCreateOrUpdateFuture, err error)

CreateOrUpdate this is an asynchronous operation and can be polled to completion using the location header returned by this operation. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. rolloutName - the rollout name. rolloutRequest - source rollout request object that defines the rollout.

func (RolloutsClient) CreateOrUpdatePreparer

func (client RolloutsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, rolloutName string, rolloutRequest *RolloutRequest) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RolloutsClient) CreateOrUpdateResponder

func (client RolloutsClient) CreateOrUpdateResponder(resp *http.Response) (result RolloutRequest, err error)

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

func (RolloutsClient) CreateOrUpdateSender

func (client RolloutsClient) CreateOrUpdateSender(req *http.Request) (future RolloutsCreateOrUpdateFuture, err error)

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

func (RolloutsClient) Delete

func (client RolloutsClient) Delete(ctx context.Context, resourceGroupName string, rolloutName string) (result autorest.Response, err error)

Delete only rollouts in terminal state can be deleted. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. rolloutName - the rollout name.

func (RolloutsClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (RolloutsClient) DeleteResponder

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

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

func (client RolloutsClient) Get(ctx context.Context, resourceGroupName string, rolloutName string, retryAttempt *int32) (result Rollout, err error)

Get sends the get request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. rolloutName - the rollout name. retryAttempt - rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.

func (RolloutsClient) GetPreparer

func (client RolloutsClient) GetPreparer(ctx context.Context, resourceGroupName string, rolloutName string, retryAttempt *int32) (*http.Request, error)

GetPreparer prepares the Get request.

func (RolloutsClient) GetResponder

func (client RolloutsClient) GetResponder(resp *http.Response) (result Rollout, err error)

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

func (RolloutsClient) GetSender

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

func (client RolloutsClient) List(ctx context.Context, resourceGroupName string) (result ListRollout, err error)

List sends the list request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (RolloutsClient) ListPreparer

func (client RolloutsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (RolloutsClient) ListResponder

func (client RolloutsClient) ListResponder(resp *http.Response) (result ListRollout, err error)

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

func (RolloutsClient) ListSender

func (client RolloutsClient) 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 (RolloutsClient) Restart

func (client RolloutsClient) Restart(ctx context.Context, resourceGroupName string, rolloutName string, skipSucceeded *bool) (result Rollout, err error)

Restart only failed rollouts can be restarted. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. rolloutName - the rollout name. skipSucceeded - if true, will skip all succeeded steps so far in the rollout. If false, will execute the entire rollout again regardless of the current state of individual resources. Defaults to false if not specified.

func (RolloutsClient) RestartPreparer

func (client RolloutsClient) RestartPreparer(ctx context.Context, resourceGroupName string, rolloutName string, skipSucceeded *bool) (*http.Request, error)

RestartPreparer prepares the Restart request.

func (RolloutsClient) RestartResponder

func (client RolloutsClient) RestartResponder(resp *http.Response) (result Rollout, err error)

RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.

func (RolloutsClient) RestartSender

func (client RolloutsClient) RestartSender(req *http.Request) (*http.Response, error)

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

type RolloutsCreateOrUpdateFuture

type RolloutsCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*RolloutsCreateOrUpdateFuture) Result

func (future *RolloutsCreateOrUpdateFuture) Result(client RolloutsClient) (rr RolloutRequest, err error)

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

type SasAuthentication

type SasAuthentication struct {
	// SasProperties - The SAS properties
	*SasProperties `json:"properties,omitempty"`
	// Type - Possible values include: 'TypeAuthentication', 'TypeSas'
	Type Type `json:"type,omitempty"`
}

SasAuthentication defines the properties to access the artifacts using an Azure Storage SAS URI.

func (SasAuthentication) AsAuthentication

func (sa SasAuthentication) AsAuthentication() (*Authentication, bool)

AsAuthentication is the BasicAuthentication implementation for SasAuthentication.

func (SasAuthentication) AsBasicAuthentication

func (sa SasAuthentication) AsBasicAuthentication() (BasicAuthentication, bool)

AsBasicAuthentication is the BasicAuthentication implementation for SasAuthentication.

func (SasAuthentication) AsSasAuthentication

func (sa SasAuthentication) AsSasAuthentication() (*SasAuthentication, bool)

AsSasAuthentication is the BasicAuthentication implementation for SasAuthentication.

func (SasAuthentication) MarshalJSON

func (sa SasAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SasAuthentication.

func (*SasAuthentication) UnmarshalJSON

func (sa *SasAuthentication) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SasAuthentication struct.

type SasProperties

type SasProperties struct {
	// SasURI - The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot.
	SasURI *string `json:"sasUri,omitempty"`
}

SasProperties the properties that define SAS authentication.

type Service

type Service struct {
	// Name - Name of the service.
	Name *string `json:"name,omitempty"`
	// ServiceUnits - The detailed information about the units that make up the service.
	ServiceUnits *[]ServiceUnit `json:"serviceUnits,omitempty"`
	// TargetLocation - The Azure location to which the resources in the service belong to or should be deployed to.
	TargetLocation *string `json:"targetLocation,omitempty"`
	// TargetSubscriptionID - The subscription to which the resources in the service belong to or should be deployed to.
	TargetSubscriptionID *string `json:"targetSubscriptionId,omitempty"`
}

Service defines a service.

type ServiceProperties

type ServiceProperties struct {
	// TargetLocation - The Azure location to which the resources in the service belong to or should be deployed to.
	TargetLocation *string `json:"targetLocation,omitempty"`
	// TargetSubscriptionID - The subscription to which the resources in the service belong to or should be deployed to.
	TargetSubscriptionID *string `json:"targetSubscriptionId,omitempty"`
}

ServiceProperties the properties of a service.

type ServiceResource

type ServiceResource struct {
	autorest.Response `json:"-"`
	// ServiceResourceProperties - The properties that define a service in a service topology.
	*ServiceResourceProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

ServiceResource the resource representation of a service in a service topology.

func (ServiceResource) MarshalJSON

func (sr ServiceResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceResource.

func (*ServiceResource) UnmarshalJSON

func (sr *ServiceResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceResource struct.

type ServiceResourceProperties

type ServiceResourceProperties struct {
	// TargetLocation - The Azure location to which the resources in the service belong to or should be deployed to.
	TargetLocation *string `json:"targetLocation,omitempty"`
	// TargetSubscriptionID - The subscription to which the resources in the service belong to or should be deployed to.
	TargetSubscriptionID *string `json:"targetSubscriptionId,omitempty"`
}

ServiceResourceProperties the properties that define a service in a service topology.

type ServiceTopologiesClient

type ServiceTopologiesClient struct {
	BaseClient
}

ServiceTopologiesClient is the REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

func NewServiceTopologiesClient

func NewServiceTopologiesClient(subscriptionID string) ServiceTopologiesClient

NewServiceTopologiesClient creates an instance of the ServiceTopologiesClient client.

func NewServiceTopologiesClientWithBaseURI

func NewServiceTopologiesClientWithBaseURI(baseURI string, subscriptionID string) ServiceTopologiesClient

NewServiceTopologiesClientWithBaseURI creates an instance of the ServiceTopologiesClient 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 (ServiceTopologiesClient) CreateOrUpdate

func (client ServiceTopologiesClient) CreateOrUpdate(ctx context.Context, serviceTopologyInfo ServiceTopologyResource, resourceGroupName string, serviceTopologyName string) (result ServiceTopologyResource, err error)

CreateOrUpdate synchronously creates a new service topology or updates an existing service topology. Parameters: serviceTopologyInfo - source topology object defines the resource. resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology .

func (ServiceTopologiesClient) CreateOrUpdatePreparer

func (client ServiceTopologiesClient) CreateOrUpdatePreparer(ctx context.Context, serviceTopologyInfo ServiceTopologyResource, resourceGroupName string, serviceTopologyName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ServiceTopologiesClient) CreateOrUpdateResponder

func (client ServiceTopologiesClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceTopologyResource, err error)

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

func (ServiceTopologiesClient) CreateOrUpdateSender

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

func (client ServiceTopologiesClient) Delete(ctx context.Context, resourceGroupName string, serviceTopologyName string) (result autorest.Response, err error)

Delete sends the delete request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology .

func (ServiceTopologiesClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (ServiceTopologiesClient) DeleteResponder

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

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

func (client ServiceTopologiesClient) Get(ctx context.Context, resourceGroupName string, serviceTopologyName string) (result ServiceTopologyResource, err error)

Get sends the get request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology .

func (ServiceTopologiesClient) GetPreparer

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

GetPreparer prepares the Get request.

func (ServiceTopologiesClient) GetResponder

func (client ServiceTopologiesClient) GetResponder(resp *http.Response) (result ServiceTopologyResource, err error)

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

func (ServiceTopologiesClient) GetSender

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

func (client ServiceTopologiesClient) List(ctx context.Context, resourceGroupName string) (result ListServiceTopologyResource, err error)

List sends the list request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (ServiceTopologiesClient) ListPreparer

func (client ServiceTopologiesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (ServiceTopologiesClient) ListResponder

func (client ServiceTopologiesClient) ListResponder(resp *http.Response) (result ListServiceTopologyResource, err error)

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

func (ServiceTopologiesClient) ListSender

func (client ServiceTopologiesClient) 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 ServiceTopologyProperties

type ServiceTopologyProperties struct {
	// ArtifactSourceID - The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.
	ArtifactSourceID *string `json:"artifactSourceId,omitempty"`
}

ServiceTopologyProperties the properties of a service topology.

type ServiceTopologyResource

type ServiceTopologyResource struct {
	autorest.Response `json:"-"`
	// ServiceTopologyResourceProperties - The properties that define the service topology.
	*ServiceTopologyResourceProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

ServiceTopologyResource the resource representation of a service topology.

func (ServiceTopologyResource) MarshalJSON

func (str ServiceTopologyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceTopologyResource.

func (*ServiceTopologyResource) UnmarshalJSON

func (str *ServiceTopologyResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceTopologyResource struct.

type ServiceTopologyResourceProperties

type ServiceTopologyResourceProperties struct {
	// ArtifactSourceID - The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.
	ArtifactSourceID *string `json:"artifactSourceId,omitempty"`
}

ServiceTopologyResourceProperties the properties that define the service topology.

type ServiceUnit

type ServiceUnit struct {
	// Name - Name of the service unit.
	Name *string `json:"name,omitempty"`
	// Steps - Detailed step information, if present.
	Steps *[]RolloutStep `json:"steps,omitempty"`
	// TargetResourceGroup - The Azure Resource Group to which the resources in the service unit belong to or should be deployed to.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
	// DeploymentMode - Describes the type of ARM deployment to be performed on the resource. Possible values include: 'Incremental', 'Complete'
	DeploymentMode DeploymentMode `json:"deploymentMode,omitempty"`
	// Artifacts - The artifacts for the service unit.
	Artifacts *ServiceUnitArtifacts `json:"artifacts,omitempty"`
}

ServiceUnit defines a service unit.

type ServiceUnitArtifacts

type ServiceUnitArtifacts struct {
	// TemplateURI - The full URI of the ARM template file with the SAS token.
	TemplateURI *string `json:"templateUri,omitempty"`
	// ParametersURI - The full URI of the ARM parameters file with the SAS token.
	ParametersURI *string `json:"parametersUri,omitempty"`
	// TemplateArtifactSourceRelativePath - The path to the ARM template file relative to the artifact source.
	TemplateArtifactSourceRelativePath *string `json:"templateArtifactSourceRelativePath,omitempty"`
	// ParametersArtifactSourceRelativePath - The path to the ARM parameters file relative to the artifact source.
	ParametersArtifactSourceRelativePath *string `json:"parametersArtifactSourceRelativePath,omitempty"`
}

ServiceUnitArtifacts defines the artifacts of a service unit.

type ServiceUnitProperties

type ServiceUnitProperties struct {
	// TargetResourceGroup - The Azure Resource Group to which the resources in the service unit belong to or should be deployed to.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
	// DeploymentMode - Describes the type of ARM deployment to be performed on the resource. Possible values include: 'Incremental', 'Complete'
	DeploymentMode DeploymentMode `json:"deploymentMode,omitempty"`
	// Artifacts - The artifacts for the service unit.
	Artifacts *ServiceUnitArtifacts `json:"artifacts,omitempty"`
}

ServiceUnitProperties defines the properties of a service unit.

type ServiceUnitResource

type ServiceUnitResource struct {
	autorest.Response `json:"-"`
	// ServiceUnitResourceProperties - The properties that define the service unit.
	*ServiceUnitResourceProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

ServiceUnitResource represents the response of a service unit resource.

func (ServiceUnitResource) MarshalJSON

func (sur ServiceUnitResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceUnitResource.

func (*ServiceUnitResource) UnmarshalJSON

func (sur *ServiceUnitResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceUnitResource struct.

type ServiceUnitResourceProperties

type ServiceUnitResourceProperties struct {
	// TargetResourceGroup - The Azure Resource Group to which the resources in the service unit belong to or should be deployed to.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
	// DeploymentMode - Describes the type of ARM deployment to be performed on the resource. Possible values include: 'Incremental', 'Complete'
	DeploymentMode DeploymentMode `json:"deploymentMode,omitempty"`
	// Artifacts - The artifacts for the service unit.
	Artifacts *ServiceUnitArtifacts `json:"artifacts,omitempty"`
}

ServiceUnitResourceProperties the properties that define the service unit.

type ServiceUnitsClient

type ServiceUnitsClient struct {
	BaseClient
}

ServiceUnitsClient is the REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

func NewServiceUnitsClient

func NewServiceUnitsClient(subscriptionID string) ServiceUnitsClient

NewServiceUnitsClient creates an instance of the ServiceUnitsClient client.

func NewServiceUnitsClientWithBaseURI

func NewServiceUnitsClientWithBaseURI(baseURI string, subscriptionID string) ServiceUnitsClient

NewServiceUnitsClientWithBaseURI creates an instance of the ServiceUnitsClient 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 (ServiceUnitsClient) CreateOrUpdate

func (client ServiceUnitsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceUnitName string, serviceUnitInfo ServiceUnitResource) (result ServiceUnitsCreateOrUpdateFuture, err error)

CreateOrUpdate this is an asynchronous operation and can be polled to completion using the operation resource returned by this operation. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology . serviceName - the name of the service resource. serviceUnitName - the name of the service unit resource. serviceUnitInfo - the service unit resource object.

func (ServiceUnitsClient) CreateOrUpdatePreparer

func (client ServiceUnitsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceUnitName string, serviceUnitInfo ServiceUnitResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ServiceUnitsClient) CreateOrUpdateResponder

func (client ServiceUnitsClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceUnitResource, err error)

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

func (ServiceUnitsClient) CreateOrUpdateSender

func (client ServiceUnitsClient) CreateOrUpdateSender(req *http.Request) (future ServiceUnitsCreateOrUpdateFuture, err error)

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

func (ServiceUnitsClient) Delete

func (client ServiceUnitsClient) Delete(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceUnitName string) (result autorest.Response, err error)

Delete sends the delete request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology . serviceName - the name of the service resource. serviceUnitName - the name of the service unit resource.

func (ServiceUnitsClient) DeletePreparer

func (client ServiceUnitsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceUnitName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ServiceUnitsClient) DeleteResponder

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

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

func (client ServiceUnitsClient) Get(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceUnitName string) (result ServiceUnitResource, err error)

Get sends the get request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology . serviceName - the name of the service resource. serviceUnitName - the name of the service unit resource.

func (ServiceUnitsClient) GetPreparer

func (client ServiceUnitsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceUnitName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ServiceUnitsClient) GetResponder

func (client ServiceUnitsClient) GetResponder(resp *http.Response) (result ServiceUnitResource, err error)

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

func (ServiceUnitsClient) GetSender

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

func (client ServiceUnitsClient) List(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string) (result ListServiceUnitResource, err error)

List sends the list request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology . serviceName - the name of the service resource.

func (ServiceUnitsClient) ListPreparer

func (client ServiceUnitsClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (ServiceUnitsClient) ListResponder

func (client ServiceUnitsClient) ListResponder(resp *http.Response) (result ListServiceUnitResource, err error)

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

func (ServiceUnitsClient) ListSender

func (client ServiceUnitsClient) 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 ServiceUnitsCreateOrUpdateFuture

type ServiceUnitsCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*ServiceUnitsCreateOrUpdateFuture) Result

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

type ServicesClient

type ServicesClient struct {
	BaseClient
}

ServicesClient is the REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

func NewServicesClient

func NewServicesClient(subscriptionID string) ServicesClient

NewServicesClient creates an instance of the ServicesClient client.

func NewServicesClientWithBaseURI

func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient

NewServicesClientWithBaseURI creates an instance of the ServicesClient 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 (ServicesClient) CreateOrUpdate

func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceInfo ServiceResource) (result ServiceResource, err error)

CreateOrUpdate synchronously creates a new service or updates an existing service. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology . serviceName - the name of the service resource. serviceInfo - the service object

func (ServicesClient) CreateOrUpdatePreparer

func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string, serviceInfo ServiceResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ServicesClient) CreateOrUpdateResponder

func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceResource, err error)

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

func (ServicesClient) CreateOrUpdateSender

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

func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string) (result autorest.Response, err error)

Delete sends the delete request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology . serviceName - the name of the service resource.

func (ServicesClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (ServicesClient) DeleteResponder

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

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

func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, serviceTopologyName string, serviceName string) (result ServiceResource, err error)

Get sends the get request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology . serviceName - the name of the service resource.

func (ServicesClient) GetPreparer

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

GetPreparer prepares the Get request.

func (ServicesClient) GetResponder

func (client ServicesClient) GetResponder(resp *http.Response) (result ServiceResource, err error)

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

func (ServicesClient) GetSender

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

func (client ServicesClient) List(ctx context.Context, resourceGroupName string, serviceTopologyName string) (result ListServiceResource, err error)

List sends the list request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. serviceTopologyName - the name of the service topology .

func (ServicesClient) ListPreparer

func (client ServicesClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceTopologyName string) (*http.Request, error)

ListPreparer prepares the List request.

func (ServicesClient) ListResponder

func (client ServicesClient) ListResponder(resp *http.Response) (result ListServiceResource, err error)

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

func (ServicesClient) ListSender

func (client ServicesClient) 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 StepGroup

type StepGroup struct {
	// Name - The name of the step group.
	Name *string `json:"name,omitempty"`
	// DependsOnStepGroups - The list of step group names on which this step group depends on.
	DependsOnStepGroups *[]string `json:"dependsOnStepGroups,omitempty"`
	// PreDeploymentSteps - The list of steps to be run before deploying the target.
	PreDeploymentSteps *[]PrePostStep `json:"preDeploymentSteps,omitempty"`
	// DeploymentTargetID - The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId
	DeploymentTargetID *string `json:"deploymentTargetId,omitempty"`
	// PostDeploymentSteps - The list of steps to be run after deploying the target.
	PostDeploymentSteps *[]PrePostStep `json:"postDeploymentSteps,omitempty"`
}

StepGroup the properties that define a Step group in a rollout.

type StepOperationInfo

type StepOperationInfo struct {
	// DeploymentName - READ-ONLY; The name of the ARM deployment initiated as part of the step.
	DeploymentName *string `json:"deploymentName,omitempty"`
	// CorrelationID - READ-ONLY; Unique identifier to track the request for ARM-based resources.
	CorrelationID *string `json:"correlationId,omitempty"`
	// StartTime - READ-ONLY; Start time of the action in UTC.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; End time of the action in UTC.
	EndTime *date.Time `json:"endTime,omitempty"`
	// LastUpdatedTime - READ-ONLY; Last time in UTC this operation was updated.
	LastUpdatedTime *date.Time `json:"lastUpdatedTime,omitempty"`
	// Error - The errors, if any, for the action.
	Error *CloudErrorBody `json:"error,omitempty"`
}

StepOperationInfo detailed information of a specific step run.

func (StepOperationInfo) MarshalJSON

func (soi StepOperationInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StepOperationInfo.

type StepProperties

type StepProperties struct {
	// StepType - Possible values include: 'StepTypeStepProperties', 'StepTypeHealthCheck', 'StepTypeWait'
	StepType StepType `json:"stepType,omitempty"`
}

StepProperties the properties of a step resource.

func (StepProperties) AsBasicStepProperties

func (sp StepProperties) AsBasicStepProperties() (BasicStepProperties, bool)

AsBasicStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) AsHealthCheckStepProperties

func (sp StepProperties) AsHealthCheckStepProperties() (*HealthCheckStepProperties, bool)

AsHealthCheckStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) AsStepProperties

func (sp StepProperties) AsStepProperties() (*StepProperties, bool)

AsStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) AsWaitStepProperties

func (sp StepProperties) AsWaitStepProperties() (*WaitStepProperties, bool)

AsWaitStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) MarshalJSON

func (sp StepProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StepProperties.

type StepResource

type StepResource struct {
	autorest.Response `json:"-"`
	// Properties - The properties that define the step.
	Properties BasicStepProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

StepResource the resource representation of a rollout step.

func (StepResource) MarshalJSON

func (sr StepResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StepResource.

func (*StepResource) UnmarshalJSON

func (sr *StepResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for StepResource struct.

type StepType

type StepType string

StepType enumerates the values for step type.

const (
	// StepTypeHealthCheck ...
	StepTypeHealthCheck StepType = "HealthCheck"
	// StepTypeStepProperties ...
	StepTypeStepProperties StepType = "StepProperties"
	// StepTypeWait ...
	StepTypeWait StepType = "Wait"
)

func PossibleStepTypeValues

func PossibleStepTypeValues() []StepType

PossibleStepTypeValues returns an array of possible values for the StepType const type.

type StepsClient

type StepsClient struct {
	BaseClient
}

StepsClient is the REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

func NewStepsClient

func NewStepsClient(subscriptionID string) StepsClient

NewStepsClient creates an instance of the StepsClient client.

func NewStepsClientWithBaseURI

func NewStepsClientWithBaseURI(baseURI string, subscriptionID string) StepsClient

NewStepsClientWithBaseURI creates an instance of the StepsClient 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 (StepsClient) CreateOrUpdate

func (client StepsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, stepName string, stepInfo *StepResource) (result StepResource, err error)

CreateOrUpdate synchronously creates a new step or updates an existing step. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. stepName - the name of the deployment step. stepInfo - the step object.

func (StepsClient) CreateOrUpdatePreparer

func (client StepsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, stepName string, stepInfo *StepResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (StepsClient) CreateOrUpdateResponder

func (client StepsClient) CreateOrUpdateResponder(resp *http.Response) (result StepResource, err error)

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

func (StepsClient) CreateOrUpdateSender

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

func (client StepsClient) Delete(ctx context.Context, resourceGroupName string, stepName string) (result autorest.Response, err error)

Delete sends the delete request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. stepName - the name of the deployment step.

func (StepsClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (StepsClient) DeleteResponder

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

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

func (client StepsClient) Get(ctx context.Context, resourceGroupName string, stepName string) (result StepResource, err error)

Get sends the get request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. stepName - the name of the deployment step.

func (StepsClient) GetPreparer

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

GetPreparer prepares the Get request.

func (StepsClient) GetResponder

func (client StepsClient) GetResponder(resp *http.Response) (result StepResource, err error)

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

func (StepsClient) GetSender

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

func (client StepsClient) List(ctx context.Context, resourceGroupName string) (result ListStepResource, err error)

List sends the list request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (StepsClient) ListPreparer

func (client StepsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (StepsClient) ListResponder

func (client StepsClient) ListResponder(resp *http.Response) (result ListStepResource, err error)

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

func (StepsClient) ListSender

func (client StepsClient) 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 TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type Type

type Type string

Type enumerates the values for type.

const (
	// TypeAuthentication ...
	TypeAuthentication Type = "Authentication"
	// TypeSas ...
	TypeSas Type = "Sas"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type TypeBasicHealthCheckStepAttributes

type TypeBasicHealthCheckStepAttributes string

TypeBasicHealthCheckStepAttributes enumerates the values for type basic health check step attributes.

const (
	// TypeHealthCheckStepAttributes ...
	TypeHealthCheckStepAttributes TypeBasicHealthCheckStepAttributes = "HealthCheckStepAttributes"
	// TypeREST ...
	TypeREST TypeBasicHealthCheckStepAttributes = "REST"
)

func PossibleTypeBasicHealthCheckStepAttributesValues

func PossibleTypeBasicHealthCheckStepAttributesValues() []TypeBasicHealthCheckStepAttributes

PossibleTypeBasicHealthCheckStepAttributesValues returns an array of possible values for the TypeBasicHealthCheckStepAttributes const type.

type TypeBasicRestRequestAuthentication

type TypeBasicRestRequestAuthentication string

TypeBasicRestRequestAuthentication enumerates the values for type basic rest request authentication.

const (
	// TypeAPIKey ...
	TypeAPIKey TypeBasicRestRequestAuthentication = "ApiKey"
	// TypeRestRequestAuthentication ...
	TypeRestRequestAuthentication TypeBasicRestRequestAuthentication = "RestRequestAuthentication"
	// TypeRolloutIdentity ...
	TypeRolloutIdentity TypeBasicRestRequestAuthentication = "RolloutIdentity"
)

func PossibleTypeBasicRestRequestAuthenticationValues

func PossibleTypeBasicRestRequestAuthenticationValues() []TypeBasicRestRequestAuthentication

PossibleTypeBasicRestRequestAuthenticationValues returns an array of possible values for the TypeBasicRestRequestAuthentication const type.

type WaitStepAttributes

type WaitStepAttributes struct {
	// Duration - The duration in ISO 8601 format of how long the wait should be.
	Duration *string `json:"duration,omitempty"`
}

WaitStepAttributes the parameters for the wait step.

type WaitStepProperties

type WaitStepProperties struct {
	// Attributes - The Wait attributes
	Attributes *WaitStepAttributes `json:"attributes,omitempty"`
	// StepType - Possible values include: 'StepTypeStepProperties', 'StepTypeHealthCheck', 'StepTypeWait'
	StepType StepType `json:"stepType,omitempty"`
}

WaitStepProperties defines the properties of a Wait step.

func (WaitStepProperties) AsBasicStepProperties

func (wsp WaitStepProperties) AsBasicStepProperties() (BasicStepProperties, bool)

AsBasicStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) AsHealthCheckStepProperties

func (wsp WaitStepProperties) AsHealthCheckStepProperties() (*HealthCheckStepProperties, bool)

AsHealthCheckStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) AsStepProperties

func (wsp WaitStepProperties) AsStepProperties() (*StepProperties, bool)

AsStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) AsWaitStepProperties

func (wsp WaitStepProperties) AsWaitStepProperties() (*WaitStepProperties, bool)

AsWaitStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) MarshalJSON

func (wsp WaitStepProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WaitStepProperties.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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