azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/deploymentmanager/mgmt/2019-11-01-preview/deploymentmanager Index | Files | Directories

package deploymentmanager

import "github.com/Azure/azure-sdk-for-go/services/preview/deploymentmanager/mgmt/2019-11-01-preview/deploymentmanager"

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

Package Files

artifactsources.go client.go enums.go models.go operations.go rollouts.go services.go servicetopologies.go serviceunits.go steps.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type APIKeyAuthentication Uses

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 Uses

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

AsAPIKeyAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) AsBasicRestRequestAuthentication Uses

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

AsBasicRestRequestAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) AsRestRequestAuthentication Uses

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

AsRestRequestAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) AsRolloutIdentityAuthentication Uses

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

AsRolloutIdentityAuthentication is the BasicRestRequestAuthentication implementation for APIKeyAuthentication.

func (APIKeyAuthentication) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for APIKeyAuthentication.

type ArtifactSource Uses

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. E.g. "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 Uses

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

MarshalJSON is the custom marshaler for ArtifactSource.

func (*ArtifactSource) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ArtifactSource struct.

type ArtifactSourceProperties Uses

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 Uses

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

UnmarshalJSON is the custom unmarshaler for ArtifactSourceProperties struct.

type ArtifactSourcePropertiesModel Uses

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 Uses

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

UnmarshalJSON is the custom unmarshaler for ArtifactSourcePropertiesModel struct.

type ArtifactSourcesClient Uses

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 Uses

func NewArtifactSourcesClient(subscriptionID string) ArtifactSourcesClient

NewArtifactSourcesClient creates an instance of the ArtifactSourcesClient client.

func NewArtifactSourcesClientWithBaseURI Uses

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 Uses

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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ArtifactSourcesClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (ArtifactSourcesClient) DeleteResponder Uses

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 Uses

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 Uses

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 Uses

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

GetPreparer prepares the Get request.

func (ArtifactSourcesClient) GetResponder Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (ArtifactSourcesClient) ListResponder Uses

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 Uses

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 Uses

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 Uses

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

AsAuthentication is the BasicAuthentication implementation for Authentication.

func (Authentication) AsBasicAuthentication Uses

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

AsBasicAuthentication is the BasicAuthentication implementation for Authentication.

func (Authentication) AsSasAuthentication Uses

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

AsSasAuthentication is the BasicAuthentication implementation for Authentication.

func (Authentication) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Authentication.

type AzureEntityResource Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

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

type BaseClient Uses

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

BaseClient is the base client for Deploymentmanager.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

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 Uses

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

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

type BasicHealthCheckStepAttributes Uses

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

BasicHealthCheckStepAttributes the attributes for the health check step.

type BasicRestRequestAuthentication Uses

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 Uses

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

BasicStepProperties the properties of a step resource.

type CloudError Uses

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

CloudError the error information object.

type CloudErrorBody Uses

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 Uses

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

MarshalJSON is the custom marshaler for CloudErrorBody.

type DeploymentMode Uses

type DeploymentMode string

DeploymentMode enumerates the values for deployment mode.

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

func PossibleDeploymentModeValues Uses

func PossibleDeploymentModeValues() []DeploymentMode

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

type HealthCheckStepAttributes Uses

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 Uses

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

AsBasicHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for HealthCheckStepAttributes.

func (HealthCheckStepAttributes) AsHealthCheckStepAttributes Uses

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

AsHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for HealthCheckStepAttributes.

func (HealthCheckStepAttributes) AsRestHealthCheckStepAttributes Uses

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

AsRestHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for HealthCheckStepAttributes.

func (HealthCheckStepAttributes) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for HealthCheckStepAttributes.

type HealthCheckStepProperties Uses

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 Uses

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

AsBasicStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) AsHealthCheckStepProperties Uses

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

AsHealthCheckStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) AsStepProperties Uses

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

AsStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) AsWaitStepProperties Uses

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

AsWaitStepProperties is the BasicStepProperties implementation for HealthCheckStepProperties.

func (HealthCheckStepProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for HealthCheckStepProperties.

func (*HealthCheckStepProperties) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for HealthCheckStepProperties struct.

type Identity Uses

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 Uses

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

ListArtifactSource ...

type ListRollout Uses

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

ListRollout ...

type ListServiceResource Uses

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

ListServiceResource ...

type ListServiceTopologyResource Uses

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

ListServiceTopologyResource ...

type ListServiceUnitResource Uses

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

ListServiceUnitResource ...

type ListStepResource Uses

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

ListStepResource ...

type Message Uses

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 Uses

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 Uses

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 Uses

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 Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

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 Uses

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

List sends the list request.

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

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 Uses

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

OperationsList the operations response.

type PrePostStep Uses

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 Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type Resource Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

type ResourceOperation Uses

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 Uses

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

MarshalJSON is the custom marshaler for ResourceOperation.

type RestAuthLocation Uses

type RestAuthLocation string

RestAuthLocation enumerates the values for rest auth location.

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

func PossibleRestAuthLocationValues Uses

func PossibleRestAuthLocationValues() []RestAuthLocation

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

type RestHealthCheck Uses

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 Uses

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 Uses

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

AsBasicHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for RestHealthCheckStepAttributes.

func (RestHealthCheckStepAttributes) AsHealthCheckStepAttributes Uses

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

AsHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for RestHealthCheckStepAttributes.

func (RestHealthCheckStepAttributes) AsRestHealthCheckStepAttributes Uses

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

AsRestHealthCheckStepAttributes is the BasicHealthCheckStepAttributes implementation for RestHealthCheckStepAttributes.

func (RestHealthCheckStepAttributes) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for RestHealthCheckStepAttributes.

func (*RestHealthCheckStepAttributes) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for RestHealthCheckStepAttributes struct.

type RestMatchQuantifier Uses

type RestMatchQuantifier string

RestMatchQuantifier enumerates the values for rest match quantifier.

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

func PossibleRestMatchQuantifierValues Uses

func PossibleRestMatchQuantifierValues() []RestMatchQuantifier

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

type RestParameters Uses

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 Uses

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 Uses

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

UnmarshalJSON is the custom unmarshaler for RestRequest struct.

type RestRequestAuthentication Uses

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 Uses

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

AsAPIKeyAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) AsBasicRestRequestAuthentication Uses

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

AsBasicRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) AsRestRequestAuthentication Uses

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

AsRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) AsRolloutIdentityAuthentication Uses

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

AsRolloutIdentityAuthentication is the BasicRestRequestAuthentication implementation for RestRequestAuthentication.

func (RestRequestAuthentication) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for RestRequestAuthentication.

type RestRequestMethod Uses

type RestRequestMethod string

RestRequestMethod enumerates the values for rest request method.

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

func PossibleRestRequestMethodValues Uses

func PossibleRestRequestMethodValues() []RestRequestMethod

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

type RestResponse Uses

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 Uses

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 Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

Rollout defines the rollout.

func (Rollout) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Rollout.

func (*Rollout) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Rollout struct.

type RolloutIdentityAuthentication Uses

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 Uses

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

AsAPIKeyAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) AsBasicRestRequestAuthentication Uses

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

AsBasicRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) AsRestRequestAuthentication Uses

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

AsRestRequestAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) AsRolloutIdentityAuthentication Uses

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

AsRolloutIdentityAuthentication is the BasicRestRequestAuthentication implementation for RolloutIdentityAuthentication.

func (RolloutIdentityAuthentication) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for RolloutIdentityAuthentication.

type RolloutOperationInfo Uses

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 Uses

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 Uses

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

MarshalJSON is the custom marshaler for RolloutProperties.

type RolloutPropertiesModel Uses

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 Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

RolloutRequest defines the PUT rollout request body.

func (RolloutRequest) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for RolloutRequest.

func (*RolloutRequest) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for RolloutRequest struct.

type RolloutRequestProperties Uses

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 Uses

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 Uses

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

MarshalJSON is the custom marshaler for RolloutStep.

type RolloutsClient Uses

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 Uses

func NewRolloutsClient(subscriptionID string) RolloutsClient

NewRolloutsClient creates an instance of the RolloutsClient client.

func NewRolloutsClientWithBaseURI Uses

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 Uses

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 Uses

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

CancelPreparer prepares the Cancel request.

func (RolloutsClient) CancelResponder Uses

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 Uses

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 Uses

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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RolloutsClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (RolloutsClient) DeleteResponder Uses

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 Uses

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 Uses

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 Uses

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

GetPreparer prepares the Get request.

func (RolloutsClient) GetResponder Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (RolloutsClient) ListResponder Uses

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 Uses

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 Uses

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 Uses

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

RestartPreparer prepares the Restart request.

func (RolloutsClient) RestartResponder Uses

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 Uses

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 Uses

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

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

type SasAuthentication Uses

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 Uses

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

AsAuthentication is the BasicAuthentication implementation for SasAuthentication.

func (SasAuthentication) AsBasicAuthentication Uses

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

AsBasicAuthentication is the BasicAuthentication implementation for SasAuthentication.

func (SasAuthentication) AsSasAuthentication Uses

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

AsSasAuthentication is the BasicAuthentication implementation for SasAuthentication.

func (SasAuthentication) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for SasAuthentication.

func (*SasAuthentication) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for SasAuthentication struct.

type SasProperties Uses

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 Uses

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 Uses

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 Uses

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. E.g. "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 Uses

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

MarshalJSON is the custom marshaler for ServiceResource.

func (*ServiceResource) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ServiceResource struct.

type ServiceResourceProperties Uses

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 Uses

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 Uses

func NewServiceTopologiesClient(subscriptionID string) ServiceTopologiesClient

NewServiceTopologiesClient creates an instance of the ServiceTopologiesClient client.

func NewServiceTopologiesClientWithBaseURI Uses

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 Uses

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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ServiceTopologiesClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (ServiceTopologiesClient) DeleteResponder Uses

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 Uses

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 Uses

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 Uses

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

GetPreparer prepares the Get request.

func (ServiceTopologiesClient) GetResponder Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (ServiceTopologiesClient) ListResponder Uses

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 Uses

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 Uses

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 Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

ServiceTopologyResource the resource representation of a service topology.

func (ServiceTopologyResource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ServiceTopologyResource.

func (*ServiceTopologyResource) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ServiceTopologyResource struct.

type ServiceTopologyResourceProperties Uses

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 Uses

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 Uses

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 Uses

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 Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

ServiceUnitResource represents the response of a service unit resource.

func (ServiceUnitResource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ServiceUnitResource.

func (*ServiceUnitResource) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ServiceUnitResource struct.

type ServiceUnitResourceProperties Uses

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 Uses

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 Uses

func NewServiceUnitsClient(subscriptionID string) ServiceUnitsClient

NewServiceUnitsClient creates an instance of the ServiceUnitsClient client.

func NewServiceUnitsClientWithBaseURI Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (ServiceUnitsClient) ListResponder Uses

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 Uses

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 Uses

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

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

type ServicesClient Uses

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 Uses

func NewServicesClient(subscriptionID string) ServicesClient

NewServicesClient creates an instance of the ServicesClient client.

func NewServicesClientWithBaseURI Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (ServicesClient) DeleteResponder Uses

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 Uses

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 Uses

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 Uses

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

GetPreparer prepares the Get request.

func (ServicesClient) GetResponder Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (ServicesClient) ListResponder Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

MarshalJSON is the custom marshaler for StepOperationInfo.

type StepProperties Uses

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 Uses

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

AsBasicStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) AsHealthCheckStepProperties Uses

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

AsHealthCheckStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) AsStepProperties Uses

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

AsStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) AsWaitStepProperties Uses

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

AsWaitStepProperties is the BasicStepProperties implementation for StepProperties.

func (StepProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for StepProperties.

type StepResource Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

StepResource the resource representation of a rollout step.

func (StepResource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for StepResource.

func (*StepResource) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for StepResource struct.

type StepType Uses

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 Uses

func PossibleStepTypeValues() []StepType

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

type StepsClient Uses

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 Uses

func NewStepsClient(subscriptionID string) StepsClient

NewStepsClient creates an instance of the StepsClient client.

func NewStepsClientWithBaseURI Uses

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 Uses

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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (StepsClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (StepsClient) DeleteResponder Uses

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 Uses

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 Uses

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 Uses

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

GetPreparer prepares the Get request.

func (StepsClient) GetResponder Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (StepsClient) ListResponder Uses

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 Uses

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 Uses

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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for TrackedResource.

type Type Uses

type Type string

Type enumerates the values for type.

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

func PossibleTypeValues Uses

func PossibleTypeValues() []Type

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

type TypeBasicHealthCheckStepAttributes Uses

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 Uses

func PossibleTypeBasicHealthCheckStepAttributesValues() []TypeBasicHealthCheckStepAttributes

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

type TypeBasicRestRequestAuthentication Uses

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 Uses

func PossibleTypeBasicRestRequestAuthenticationValues() []TypeBasicRestRequestAuthentication

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

type WaitStepAttributes Uses

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 Uses

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 Uses

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

AsBasicStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) AsHealthCheckStepProperties Uses

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

AsHealthCheckStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) AsStepProperties Uses

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

AsStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) AsWaitStepProperties Uses

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

AsWaitStepProperties is the BasicStepProperties implementation for WaitStepProperties.

func (WaitStepProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for WaitStepProperties.

Directories

PathSynopsis
deploymentmanagerapi

Package deploymentmanager imports 9 packages (graph) and is imported by 1 packages. Updated 2021-01-26. Refresh now. Tools for package owners.