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

package blueprint

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

Package blueprint implements the Azure ARM Blueprint service API version 2018-11-01-preview.

Blueprint Client

Index

Package Files

artifacts.go assignmentoperations.go assignments.go blueprints.go client.go models.go publishedartifacts.go publishedblueprints.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Blueprint
    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 Artifact Uses

type Artifact struct {
    autorest.Response `json:"-"`
    // Kind - Possible values include: 'KindArtifact', 'KindTemplate', 'KindRoleAssignment', 'KindPolicyAssignment'
    Kind Kind `json:"kind,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

Artifact represents a blueprint artifact.

func (Artifact) AsArtifact Uses

func (a Artifact) AsArtifact() (*Artifact, bool)

AsArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsBasicArtifact Uses

func (a Artifact) AsBasicArtifact() (BasicArtifact, bool)

AsBasicArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsPolicyAssignmentArtifact Uses

func (a Artifact) AsPolicyAssignmentArtifact() (*PolicyAssignmentArtifact, bool)

AsPolicyAssignmentArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsRoleAssignmentArtifact Uses

func (a Artifact) AsRoleAssignmentArtifact() (*RoleAssignmentArtifact, bool)

AsRoleAssignmentArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsTemplateArtifact Uses

func (a Artifact) AsTemplateArtifact() (*TemplateArtifact, bool)

AsTemplateArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Artifact.

type ArtifactList Uses

type ArtifactList struct {
    autorest.Response `json:"-"`
    // Value - List of blueprint artifacts.
    Value *[]BasicArtifact `json:"value,omitempty"`
    // NextLink - READ-ONLY; Link to the next page of results.
    NextLink *string `json:"nextLink,omitempty"`
}

ArtifactList list of blueprint artifacts.

func (ArtifactList) IsEmpty Uses

func (al ArtifactList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*ArtifactList) UnmarshalJSON Uses

func (al *ArtifactList) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ArtifactList struct.

type ArtifactListIterator Uses

type ArtifactListIterator struct {
    // contains filtered or unexported fields
}

ArtifactListIterator provides access to a complete listing of Artifact values.

func NewArtifactListIterator Uses

func NewArtifactListIterator(page ArtifactListPage) ArtifactListIterator

Creates a new instance of the ArtifactListIterator type.

func (*ArtifactListIterator) Next Uses

func (iter *ArtifactListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ArtifactListIterator) NextWithContext Uses

func (iter *ArtifactListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ArtifactListIterator) NotDone Uses

func (iter ArtifactListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ArtifactListIterator) Response Uses

func (iter ArtifactListIterator) Response() ArtifactList

Response returns the raw server response from the last page request.

func (ArtifactListIterator) Value Uses

func (iter ArtifactListIterator) Value() BasicArtifact

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ArtifactListPage Uses

type ArtifactListPage struct {
    // contains filtered or unexported fields
}

ArtifactListPage contains a page of BasicArtifact values.

func NewArtifactListPage Uses

func NewArtifactListPage(getNextPage func(context.Context, ArtifactList) (ArtifactList, error)) ArtifactListPage

Creates a new instance of the ArtifactListPage type.

func (*ArtifactListPage) Next Uses

func (page *ArtifactListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ArtifactListPage) NextWithContext Uses

func (page *ArtifactListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ArtifactListPage) NotDone Uses

func (page ArtifactListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ArtifactListPage) Response Uses

func (page ArtifactListPage) Response() ArtifactList

Response returns the raw server response from the last page request.

func (ArtifactListPage) Values Uses

func (page ArtifactListPage) Values() []BasicArtifact

Values returns the slice of values for the current page or nil if there are no values.

type ArtifactModel Uses

type ArtifactModel struct {
    autorest.Response `json:"-"`
    Value             BasicArtifact `json:"value,omitempty"`
}

ArtifactModel ...

func (*ArtifactModel) UnmarshalJSON Uses

func (am *ArtifactModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ArtifactModel struct.

type ArtifactPropertiesBase Uses

type ArtifactPropertiesBase struct {
    // DependsOn - Artifacts which need to be deployed before the specified artifact.
    DependsOn *[]string `json:"dependsOn,omitempty"`
}

ArtifactPropertiesBase common properties shared by different artifacts.

type ArtifactsClient Uses

type ArtifactsClient struct {
    BaseClient
}

ArtifactsClient is the blueprint Client

func NewArtifactsClient Uses

func NewArtifactsClient() ArtifactsClient

NewArtifactsClient creates an instance of the ArtifactsClient client.

func NewArtifactsClientWithBaseURI Uses

func NewArtifactsClientWithBaseURI(baseURI string) ArtifactsClient

NewArtifactsClientWithBaseURI creates an instance of the ArtifactsClient client.

func (ArtifactsClient) CreateOrUpdate Uses

func (client ArtifactsClient) CreateOrUpdate(ctx context.Context, scope string, blueprintName string, artifactName string, artifact BasicArtifact) (result ArtifactModel, err error)

CreateOrUpdate create or update blueprint artifact. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. artifactName - name of the blueprint artifact. artifact - blueprint artifact to create or update.

func (ArtifactsClient) CreateOrUpdatePreparer Uses

func (client ArtifactsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, blueprintName string, artifactName string, artifact BasicArtifact) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ArtifactsClient) CreateOrUpdateResponder Uses

func (client ArtifactsClient) CreateOrUpdateResponder(resp *http.Response) (result ArtifactModel, err error)

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

func (ArtifactsClient) CreateOrUpdateSender Uses

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

func (client ArtifactsClient) Delete(ctx context.Context, scope string, blueprintName string, artifactName string) (result ArtifactModel, err error)

Delete delete a blueprint artifact. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. artifactName - name of the blueprint artifact.

func (ArtifactsClient) DeletePreparer Uses

func (client ArtifactsClient) DeletePreparer(ctx context.Context, scope string, blueprintName string, artifactName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ArtifactsClient) DeleteResponder Uses

func (client ArtifactsClient) DeleteResponder(resp *http.Response) (result ArtifactModel, err error)

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

func (ArtifactsClient) DeleteSender Uses

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

func (client ArtifactsClient) Get(ctx context.Context, scope string, blueprintName string, artifactName string) (result ArtifactModel, err error)

Get get a blueprint artifact. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. artifactName - name of the blueprint artifact.

func (ArtifactsClient) GetPreparer Uses

func (client ArtifactsClient) GetPreparer(ctx context.Context, scope string, blueprintName string, artifactName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ArtifactsClient) GetResponder Uses

func (client ArtifactsClient) GetResponder(resp *http.Response) (result ArtifactModel, err error)

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

func (ArtifactsClient) GetSender Uses

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

func (client ArtifactsClient) List(ctx context.Context, scope string, blueprintName string) (result ArtifactListPage, err error)

List list artifacts for a given blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition.

func (ArtifactsClient) ListComplete Uses

func (client ArtifactsClient) ListComplete(ctx context.Context, scope string, blueprintName string) (result ArtifactListIterator, err error)

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

func (ArtifactsClient) ListPreparer Uses

func (client ArtifactsClient) ListPreparer(ctx context.Context, scope string, blueprintName string) (*http.Request, error)

ListPreparer prepares the List request.

func (ArtifactsClient) ListResponder Uses

func (client ArtifactsClient) ListResponder(resp *http.Response) (result ArtifactList, err error)

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

func (ArtifactsClient) ListSender Uses

func (client ArtifactsClient) 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 Assignment Uses

type Assignment struct {
    autorest.Response `json:"-"`
    // Identity - Managed identity for this blueprint assignment.
    Identity *ManagedServiceIdentity `json:"identity,omitempty"`
    // AssignmentProperties - Properties for blueprint assignment object.
    *AssignmentProperties `json:"properties,omitempty"`
    // Location - The location of this blueprint assignment.
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

Assignment represents a blueprint assignment.

func (Assignment) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Assignment.

func (*Assignment) UnmarshalJSON Uses

func (a *Assignment) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Assignment struct.

type AssignmentDeploymentJob Uses

type AssignmentDeploymentJob struct {
    // Kind - Kind of job.
    Kind *string `json:"kind,omitempty"`
    // Action - Name of the action performed in this job.
    Action *string `json:"action,omitempty"`
    // JobID - Id of this job.
    JobID *string `json:"jobId,omitempty"`
    // JobState - State of this job.
    JobState *string `json:"jobState,omitempty"`
    // Result - Deployment job result.
    Result *AssignmentDeploymentJobResult `json:"result,omitempty"`
    // History - Result of this deployment job for each retry.
    History *[]AssignmentDeploymentJobResult `json:"history,omitempty"`
    // RequestURI - Reference to deployment job resource id.
    RequestURI *string `json:"requestUri,omitempty"`
}

AssignmentDeploymentJob represents individual job in given blueprint assignment operation.

type AssignmentDeploymentJobResult Uses

type AssignmentDeploymentJobResult struct {
    // Error - Contains error details if deployment job failed.
    Error *AzureResourceManagerError `json:"error,omitempty"`
    // Resources - Resources created as result of the deployment job.
    Resources *[]AssignmentJobCreatedResource `json:"resources,omitempty"`
}

AssignmentDeploymentJobResult result of each individual deployment in a blueprint assignment.

type AssignmentJobCreatedResource Uses

type AssignmentJobCreatedResource struct {
    // Properties - Additional properties in a dictionary.
    Properties map[string]*string `json:"properties"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

AssignmentJobCreatedResource azure resource created from deployment job.

func (AssignmentJobCreatedResource) MarshalJSON Uses

func (ajcr AssignmentJobCreatedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentJobCreatedResource.

type AssignmentList Uses

type AssignmentList struct {
    autorest.Response `json:"-"`
    // Value - List of blueprint assignments.
    Value *[]Assignment `json:"value,omitempty"`
    // NextLink - READ-ONLY; Link to the next page of results.
    NextLink *string `json:"nextLink,omitempty"`
}

AssignmentList list of blueprint assignments

func (AssignmentList) IsEmpty Uses

func (al AssignmentList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AssignmentListIterator Uses

type AssignmentListIterator struct {
    // contains filtered or unexported fields
}

AssignmentListIterator provides access to a complete listing of Assignment values.

func NewAssignmentListIterator Uses

func NewAssignmentListIterator(page AssignmentListPage) AssignmentListIterator

Creates a new instance of the AssignmentListIterator type.

func (*AssignmentListIterator) Next Uses

func (iter *AssignmentListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AssignmentListIterator) NextWithContext Uses

func (iter *AssignmentListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AssignmentListIterator) NotDone Uses

func (iter AssignmentListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AssignmentListIterator) Response Uses

func (iter AssignmentListIterator) Response() AssignmentList

Response returns the raw server response from the last page request.

func (AssignmentListIterator) Value Uses

func (iter AssignmentListIterator) Value() Assignment

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AssignmentListPage Uses

type AssignmentListPage struct {
    // contains filtered or unexported fields
}

AssignmentListPage contains a page of Assignment values.

func NewAssignmentListPage Uses

func NewAssignmentListPage(getNextPage func(context.Context, AssignmentList) (AssignmentList, error)) AssignmentListPage

Creates a new instance of the AssignmentListPage type.

func (*AssignmentListPage) Next Uses

func (page *AssignmentListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AssignmentListPage) NextWithContext Uses

func (page *AssignmentListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AssignmentListPage) NotDone Uses

func (page AssignmentListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AssignmentListPage) Response Uses

func (page AssignmentListPage) Response() AssignmentList

Response returns the raw server response from the last page request.

func (AssignmentListPage) Values Uses

func (page AssignmentListPage) Values() []Assignment

Values returns the slice of values for the current page or nil if there are no values.

type AssignmentLockMode Uses

type AssignmentLockMode string

AssignmentLockMode enumerates the values for assignment lock mode.

const (
    // AllResourcesDoNotDelete ...
    AllResourcesDoNotDelete AssignmentLockMode = "AllResourcesDoNotDelete"
    // AllResourcesReadOnly ...
    AllResourcesReadOnly AssignmentLockMode = "AllResourcesReadOnly"
    // None ...
    None AssignmentLockMode = "None"
)

func PossibleAssignmentLockModeValues Uses

func PossibleAssignmentLockModeValues() []AssignmentLockMode

PossibleAssignmentLockModeValues returns an array of possible values for the AssignmentLockMode const type.

type AssignmentLockSettings Uses

type AssignmentLockSettings struct {
    // Mode - Lock mode. Possible values include: 'None', 'AllResourcesReadOnly', 'AllResourcesDoNotDelete'
    Mode AssignmentLockMode `json:"mode,omitempty"`
    // ExcludedPrincipals - List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
    ExcludedPrincipals *[]string `json:"excludedPrincipals,omitempty"`
}

AssignmentLockSettings defines how resources deployed by a blueprint assignment are locked.

type AssignmentOperation Uses

type AssignmentOperation struct {
    autorest.Response `json:"-"`
    // AssignmentOperationProperties - Properties for AssignmentOperation.
    *AssignmentOperationProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

AssignmentOperation represents underlying deployment detail for each update to the blueprint assignment.

func (AssignmentOperation) MarshalJSON Uses

func (ao AssignmentOperation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentOperation.

func (*AssignmentOperation) UnmarshalJSON Uses

func (ao *AssignmentOperation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AssignmentOperation struct.

type AssignmentOperationList Uses

type AssignmentOperationList struct {
    autorest.Response `json:"-"`
    // Value - List of AssignmentOperation.
    Value *[]AssignmentOperation `json:"value,omitempty"`
    // NextLink - READ-ONLY; Link to the next page of results.
    NextLink *string `json:"nextLink,omitempty"`
}

AssignmentOperationList list of AssignmentOperation.

func (AssignmentOperationList) IsEmpty Uses

func (aol AssignmentOperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AssignmentOperationListIterator Uses

type AssignmentOperationListIterator struct {
    // contains filtered or unexported fields
}

AssignmentOperationListIterator provides access to a complete listing of AssignmentOperation values.

func NewAssignmentOperationListIterator Uses

func NewAssignmentOperationListIterator(page AssignmentOperationListPage) AssignmentOperationListIterator

Creates a new instance of the AssignmentOperationListIterator type.

func (*AssignmentOperationListIterator) Next Uses

func (iter *AssignmentOperationListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AssignmentOperationListIterator) NextWithContext Uses

func (iter *AssignmentOperationListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AssignmentOperationListIterator) NotDone Uses

func (iter AssignmentOperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AssignmentOperationListIterator) Response Uses

func (iter AssignmentOperationListIterator) Response() AssignmentOperationList

Response returns the raw server response from the last page request.

func (AssignmentOperationListIterator) Value Uses

func (iter AssignmentOperationListIterator) Value() AssignmentOperation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AssignmentOperationListPage Uses

type AssignmentOperationListPage struct {
    // contains filtered or unexported fields
}

AssignmentOperationListPage contains a page of AssignmentOperation values.

func NewAssignmentOperationListPage Uses

func NewAssignmentOperationListPage(getNextPage func(context.Context, AssignmentOperationList) (AssignmentOperationList, error)) AssignmentOperationListPage

Creates a new instance of the AssignmentOperationListPage type.

func (*AssignmentOperationListPage) Next Uses

func (page *AssignmentOperationListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AssignmentOperationListPage) NextWithContext Uses

func (page *AssignmentOperationListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AssignmentOperationListPage) NotDone Uses

func (page AssignmentOperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AssignmentOperationListPage) Response Uses

func (page AssignmentOperationListPage) Response() AssignmentOperationList

Response returns the raw server response from the last page request.

func (AssignmentOperationListPage) Values Uses

func (page AssignmentOperationListPage) Values() []AssignmentOperation

Values returns the slice of values for the current page or nil if there are no values.

type AssignmentOperationProperties Uses

type AssignmentOperationProperties struct {
    // BlueprintVersion - The published version of the blueprint definition used for the blueprint assignment operation.
    BlueprintVersion *string `json:"blueprintVersion,omitempty"`
    // AssignmentState - State of this blueprint assignment operation.
    AssignmentState *string `json:"assignmentState,omitempty"`
    // TimeCreated - Create time of this blueprint assignment operation.
    TimeCreated *string `json:"timeCreated,omitempty"`
    // TimeStarted - Start time of the underlying deployment.
    TimeStarted *string `json:"timeStarted,omitempty"`
    // TimeFinished - Finish time of the overall underlying deployments.
    TimeFinished *string `json:"timeFinished,omitempty"`
    // Deployments - List of jobs in this blueprint assignment operation.
    Deployments *[]AssignmentDeploymentJob `json:"deployments,omitempty"`
}

AssignmentOperationProperties properties of AssignmentOperation.

type AssignmentOperationsClient Uses

type AssignmentOperationsClient struct {
    BaseClient
}

AssignmentOperationsClient is the blueprint Client

func NewAssignmentOperationsClient Uses

func NewAssignmentOperationsClient() AssignmentOperationsClient

NewAssignmentOperationsClient creates an instance of the AssignmentOperationsClient client.

func NewAssignmentOperationsClientWithBaseURI Uses

func NewAssignmentOperationsClientWithBaseURI(baseURI string) AssignmentOperationsClient

NewAssignmentOperationsClientWithBaseURI creates an instance of the AssignmentOperationsClient client.

func (AssignmentOperationsClient) Get Uses

func (client AssignmentOperationsClient) Get(ctx context.Context, scope string, assignmentName string, assignmentOperationName string) (result AssignmentOperation, err error)

Get get a blueprint assignment operation. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. assignmentName - name of the blueprint assignment. assignmentOperationName - name of the blueprint assignment operation.

func (AssignmentOperationsClient) GetPreparer Uses

func (client AssignmentOperationsClient) GetPreparer(ctx context.Context, scope string, assignmentName string, assignmentOperationName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AssignmentOperationsClient) GetResponder Uses

func (client AssignmentOperationsClient) GetResponder(resp *http.Response) (result AssignmentOperation, err error)

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

func (AssignmentOperationsClient) GetSender Uses

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

func (client AssignmentOperationsClient) List(ctx context.Context, scope string, assignmentName string) (result AssignmentOperationListPage, err error)

List list operations for given blueprint assignment within a subscription. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. assignmentName - name of the blueprint assignment.

func (AssignmentOperationsClient) ListComplete Uses

func (client AssignmentOperationsClient) ListComplete(ctx context.Context, scope string, assignmentName string) (result AssignmentOperationListIterator, err error)

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

func (AssignmentOperationsClient) ListPreparer Uses

func (client AssignmentOperationsClient) ListPreparer(ctx context.Context, scope string, assignmentName string) (*http.Request, error)

ListPreparer prepares the List request.

func (AssignmentOperationsClient) ListResponder Uses

func (client AssignmentOperationsClient) ListResponder(resp *http.Response) (result AssignmentOperationList, err error)

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

func (AssignmentOperationsClient) ListSender Uses

func (client AssignmentOperationsClient) 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 AssignmentProperties Uses

type AssignmentProperties struct {
    // BlueprintID - ID of the published version of a blueprint definition.
    BlueprintID *string `json:"blueprintId,omitempty"`
    // Parameters - Blueprint assignment parameter values.
    Parameters map[string]*ParameterValueBase `json:"parameters"`
    // ResourceGroups - Names and locations of resource group placeholders.
    ResourceGroups map[string]*ResourceGroupValue `json:"resourceGroups"`
    // Status - READ-ONLY; Status of blueprint assignment. This field is readonly.
    Status *AssignmentStatus `json:"status,omitempty"`
    // Locks - Defines how resources deployed by a blueprint assignment are locked.
    Locks *AssignmentLockSettings `json:"locks,omitempty"`
    // ProvisioningState - READ-ONLY; State of the blueprint assignment. Possible values include: 'Creating', 'Validating', 'Waiting', 'Deploying', 'Cancelling', 'Locking', 'Succeeded', 'Failed', 'Canceled', 'Deleting'
    ProvisioningState AssignmentProvisioningState `json:"provisioningState,omitempty"`
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
}

AssignmentProperties detailed properties for a blueprint assignment.

func (AssignmentProperties) MarshalJSON Uses

func (ap AssignmentProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentProperties.

type AssignmentProvisioningState Uses

type AssignmentProvisioningState string

AssignmentProvisioningState enumerates the values for assignment provisioning state.

const (
    // Canceled ...
    Canceled AssignmentProvisioningState = "canceled"
    // Cancelling ...
    Cancelling AssignmentProvisioningState = "cancelling"
    // Creating ...
    Creating AssignmentProvisioningState = "creating"
    // Deleting ...
    Deleting AssignmentProvisioningState = "deleting"
    // Deploying ...
    Deploying AssignmentProvisioningState = "deploying"
    // Failed ...
    Failed AssignmentProvisioningState = "failed"
    // Locking ...
    Locking AssignmentProvisioningState = "locking"
    // Succeeded ...
    Succeeded AssignmentProvisioningState = "succeeded"
    // Validating ...
    Validating AssignmentProvisioningState = "validating"
    // Waiting ...
    Waiting AssignmentProvisioningState = "waiting"
)

func PossibleAssignmentProvisioningStateValues Uses

func PossibleAssignmentProvisioningStateValues() []AssignmentProvisioningState

PossibleAssignmentProvisioningStateValues returns an array of possible values for the AssignmentProvisioningState const type.

type AssignmentStatus Uses

type AssignmentStatus struct {
    // TimeCreated - READ-ONLY; Creation time of this blueprint definition.
    TimeCreated *date.Time `json:"timeCreated,omitempty"`
    // LastModified - READ-ONLY; Last modified time of this blueprint definition.
    LastModified *date.Time `json:"lastModified,omitempty"`
}

AssignmentStatus the status of a blueprint assignment. This field is readonly.

type AssignmentsClient Uses

type AssignmentsClient struct {
    BaseClient
}

AssignmentsClient is the blueprint Client

func NewAssignmentsClient Uses

func NewAssignmentsClient() AssignmentsClient

NewAssignmentsClient creates an instance of the AssignmentsClient client.

func NewAssignmentsClientWithBaseURI Uses

func NewAssignmentsClientWithBaseURI(baseURI string) AssignmentsClient

NewAssignmentsClientWithBaseURI creates an instance of the AssignmentsClient client.

func (AssignmentsClient) CreateOrUpdate Uses

func (client AssignmentsClient) CreateOrUpdate(ctx context.Context, scope string, assignmentName string, assignment Assignment) (result Assignment, err error)

CreateOrUpdate create or update a blueprint assignment. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. assignmentName - name of the blueprint assignment. assignment - blueprint assignment object to save.

func (AssignmentsClient) CreateOrUpdatePreparer Uses

func (client AssignmentsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, assignmentName string, assignment Assignment) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AssignmentsClient) CreateOrUpdateResponder Uses

func (client AssignmentsClient) CreateOrUpdateResponder(resp *http.Response) (result Assignment, err error)

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

func (AssignmentsClient) CreateOrUpdateSender Uses

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

func (client AssignmentsClient) Delete(ctx context.Context, scope string, assignmentName string) (result Assignment, err error)

Delete delete a blueprint assignment. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. assignmentName - name of the blueprint assignment.

func (AssignmentsClient) DeletePreparer Uses

func (client AssignmentsClient) DeletePreparer(ctx context.Context, scope string, assignmentName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AssignmentsClient) DeleteResponder Uses

func (client AssignmentsClient) DeleteResponder(resp *http.Response) (result Assignment, err error)

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

func (AssignmentsClient) DeleteSender Uses

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

func (client AssignmentsClient) Get(ctx context.Context, scope string, assignmentName string) (result Assignment, err error)

Get get a blueprint assignment. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. assignmentName - name of the blueprint assignment.

func (AssignmentsClient) GetPreparer Uses

func (client AssignmentsClient) GetPreparer(ctx context.Context, scope string, assignmentName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AssignmentsClient) GetResponder Uses

func (client AssignmentsClient) GetResponder(resp *http.Response) (result Assignment, err error)

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

func (AssignmentsClient) GetSender Uses

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

func (client AssignmentsClient) List(ctx context.Context, scope string) (result AssignmentListPage, err error)

List list blueprint assignments within a subscription. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use.

func (AssignmentsClient) ListComplete Uses

func (client AssignmentsClient) ListComplete(ctx context.Context, scope string) (result AssignmentListIterator, err error)

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

func (AssignmentsClient) ListPreparer Uses

func (client AssignmentsClient) ListPreparer(ctx context.Context, scope string) (*http.Request, error)

ListPreparer prepares the List request.

func (AssignmentsClient) ListResponder Uses

func (client AssignmentsClient) ListResponder(resp *http.Response) (result AssignmentList, err error)

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

func (AssignmentsClient) ListSender Uses

func (client AssignmentsClient) 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 (AssignmentsClient) WhoIsBlueprint Uses

func (client AssignmentsClient) WhoIsBlueprint(ctx context.Context, scope string, assignmentName string) (result WhoIsBlueprintContract, err error)

WhoIsBlueprint get Blueprints service SPN objectId Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. assignmentName - name of the blueprint assignment.

func (AssignmentsClient) WhoIsBlueprintPreparer Uses

func (client AssignmentsClient) WhoIsBlueprintPreparer(ctx context.Context, scope string, assignmentName string) (*http.Request, error)

WhoIsBlueprintPreparer prepares the WhoIsBlueprint request.

func (AssignmentsClient) WhoIsBlueprintResponder Uses

func (client AssignmentsClient) WhoIsBlueprintResponder(resp *http.Response) (result WhoIsBlueprintContract, err error)

WhoIsBlueprintResponder handles the response to the WhoIsBlueprint request. The method always closes the http.Response Body.

func (AssignmentsClient) WhoIsBlueprintSender Uses

func (client AssignmentsClient) WhoIsBlueprintSender(req *http.Request) (*http.Response, error)

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

type AzureResourceBase Uses

type AzureResourceBase struct {
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

AzureResourceBase common properties for all Azure resources.

type AzureResourceManagerError Uses

type AzureResourceManagerError struct {
    // Code - Error code.
    Code *string `json:"code,omitempty"`
    // Message - Error message.
    Message *string `json:"message,omitempty"`
}

AzureResourceManagerError error code and message

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI string
}

BaseClient is the base client for Blueprint.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BasicArtifact Uses

type BasicArtifact interface {
    AsTemplateArtifact() (*TemplateArtifact, bool)
    AsRoleAssignmentArtifact() (*RoleAssignmentArtifact, bool)
    AsPolicyAssignmentArtifact() (*PolicyAssignmentArtifact, bool)
    AsArtifact() (*Artifact, bool)
}

BasicArtifact represents a blueprint artifact.

type BlueprintsClient Uses

type BlueprintsClient struct {
    BaseClient
}

BlueprintsClient is the blueprint Client

func NewBlueprintsClient Uses

func NewBlueprintsClient() BlueprintsClient

NewBlueprintsClient creates an instance of the BlueprintsClient client.

func NewBlueprintsClientWithBaseURI Uses

func NewBlueprintsClientWithBaseURI(baseURI string) BlueprintsClient

NewBlueprintsClientWithBaseURI creates an instance of the BlueprintsClient client.

func (BlueprintsClient) CreateOrUpdate Uses

func (client BlueprintsClient) CreateOrUpdate(ctx context.Context, scope string, blueprintName string, blueprint Model) (result Model, err error)

CreateOrUpdate create or update a blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. blueprint - blueprint definition.

func (BlueprintsClient) CreateOrUpdatePreparer Uses

func (client BlueprintsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, blueprintName string, blueprint Model) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BlueprintsClient) CreateOrUpdateResponder Uses

func (client BlueprintsClient) CreateOrUpdateResponder(resp *http.Response) (result Model, err error)

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

func (BlueprintsClient) CreateOrUpdateSender Uses

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

func (client BlueprintsClient) Delete(ctx context.Context, scope string, blueprintName string) (result Model, err error)

Delete delete a blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition.

func (BlueprintsClient) DeletePreparer Uses

func (client BlueprintsClient) DeletePreparer(ctx context.Context, scope string, blueprintName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BlueprintsClient) DeleteResponder Uses

func (client BlueprintsClient) DeleteResponder(resp *http.Response) (result Model, err error)

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

func (BlueprintsClient) DeleteSender Uses

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

func (client BlueprintsClient) Get(ctx context.Context, scope string, blueprintName string) (result Model, err error)

Get get a blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition.

func (BlueprintsClient) GetPreparer Uses

func (client BlueprintsClient) GetPreparer(ctx context.Context, scope string, blueprintName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BlueprintsClient) GetResponder Uses

func (client BlueprintsClient) GetResponder(resp *http.Response) (result Model, err error)

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

func (BlueprintsClient) GetSender Uses

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

func (client BlueprintsClient) List(ctx context.Context, scope string) (result ListPage, err error)

List list blueprint definitions. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use.

func (BlueprintsClient) ListComplete Uses

func (client BlueprintsClient) ListComplete(ctx context.Context, scope string) (result ListIterator, err error)

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

func (BlueprintsClient) ListPreparer Uses

func (client BlueprintsClient) ListPreparer(ctx context.Context, scope string) (*http.Request, error)

ListPreparer prepares the List request.

func (BlueprintsClient) ListResponder Uses

func (client BlueprintsClient) ListResponder(resp *http.Response) (result List, err error)

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

func (BlueprintsClient) ListSender Uses

func (client BlueprintsClient) 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 KeyVaultReference Uses

type KeyVaultReference struct {
    // ID - Azure resource ID of the Key Vault.
    ID *string `json:"id,omitempty"`
}

KeyVaultReference specifies the link to a Key Vault.

type Kind Uses

type Kind string

Kind enumerates the values for kind.

const (
    // KindArtifact ...
    KindArtifact Kind = "Artifact"
    // KindPolicyAssignment ...
    KindPolicyAssignment Kind = "policyAssignment"
    // KindRoleAssignment ...
    KindRoleAssignment Kind = "roleAssignment"
    // KindTemplate ...
    KindTemplate Kind = "template"
)

func PossibleKindValues Uses

func PossibleKindValues() []Kind

PossibleKindValues returns an array of possible values for the Kind const type.

type List Uses

type List struct {
    autorest.Response `json:"-"`
    // Value - List of blueprint definitions.
    Value *[]Model `json:"value,omitempty"`
    // NextLink - READ-ONLY; Link to the next page of results.
    NextLink *string `json:"nextLink,omitempty"`
}

List list of blueprint definitions.

func (List) IsEmpty Uses

func (l List) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListIterator Uses

type ListIterator struct {
    // contains filtered or unexported fields
}

ListIterator provides access to a complete listing of Model values.

func NewListIterator Uses

func NewListIterator(page ListPage) ListIterator

Creates a new instance of the ListIterator type.

func (*ListIterator) Next Uses

func (iter *ListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListIterator) NextWithContext Uses

func (iter *ListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ListIterator) NotDone Uses

func (iter ListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListIterator) Response Uses

func (iter ListIterator) Response() List

Response returns the raw server response from the last page request.

func (ListIterator) Value Uses

func (iter ListIterator) Value() Model

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ListPage Uses

type ListPage struct {
    // contains filtered or unexported fields
}

ListPage contains a page of Model values.

func NewListPage Uses

func NewListPage(getNextPage func(context.Context, List) (List, error)) ListPage

Creates a new instance of the ListPage type.

func (*ListPage) Next Uses

func (page *ListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListPage) NextWithContext Uses

func (page *ListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ListPage) NotDone Uses

func (page ListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListPage) Response Uses

func (page ListPage) Response() List

Response returns the raw server response from the last page request.

func (ListPage) Values Uses

func (page ListPage) Values() []Model

Values returns the slice of values for the current page or nil if there are no values.

type ManagedServiceIdentity Uses

type ManagedServiceIdentity struct {
    // Type - Type of the managed identity. Possible values include: 'ManagedServiceIdentityTypeNone', 'ManagedServiceIdentityTypeSystemAssigned', 'ManagedServiceIdentityTypeUserAssigned'
    Type ManagedServiceIdentityType `json:"type,omitempty"`
    // PrincipalID - Azure Active Directory principal ID associated with this Identity.
    PrincipalID *string `json:"principalId,omitempty"`
    // TenantID - ID of the Azure Active Directory.
    TenantID *string `json:"tenantId,omitempty"`
    // UserAssignedIdentities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
    UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities"`
}

ManagedServiceIdentity managed identity generic object.

func (ManagedServiceIdentity) MarshalJSON Uses

func (msi ManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagedServiceIdentity.

type ManagedServiceIdentityType Uses

type ManagedServiceIdentityType string

ManagedServiceIdentityType enumerates the values for managed service identity type.

const (
    // ManagedServiceIdentityTypeNone ...
    ManagedServiceIdentityTypeNone ManagedServiceIdentityType = "None"
    // ManagedServiceIdentityTypeSystemAssigned ...
    ManagedServiceIdentityTypeSystemAssigned ManagedServiceIdentityType = "SystemAssigned"
    // ManagedServiceIdentityTypeUserAssigned ...
    ManagedServiceIdentityTypeUserAssigned ManagedServiceIdentityType = "UserAssigned"
)

func PossibleManagedServiceIdentityTypeValues Uses

func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType

PossibleManagedServiceIdentityTypeValues returns an array of possible values for the ManagedServiceIdentityType const type.

type Model Uses

type Model struct {
    autorest.Response `json:"-"`
    // Properties - Detailed properties for blueprint definition.
    *Properties `json:"properties,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

Model represents a Blueprint definition.

func (Model) MarshalJSON Uses

func (mVar Model) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Model.

func (*Model) UnmarshalJSON Uses

func (mVar *Model) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Model struct.

type ParameterDefinition Uses

type ParameterDefinition struct {
    // Type - Allowed data types for Resource Manager template parameters. Possible values include: 'String', 'Array', 'Bool', 'Int', 'Object', 'SecureObject', 'SecureString'
    Type TemplateParameterType `json:"type,omitempty"`
    // ParameterDefinitionMetadata - User-friendly properties for this parameter.
    *ParameterDefinitionMetadata `json:"metadata,omitempty"`
    // DefaultValue - Default Value for this parameter.
    DefaultValue interface{} `json:"defaultValue,omitempty"`
    // AllowedValues - Array of allowed values for this parameter.
    AllowedValues *[]interface{} `json:"allowedValues,omitempty"`
}

ParameterDefinition represent a parameter with constrains and metadata.

func (ParameterDefinition) MarshalJSON Uses

func (pd ParameterDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ParameterDefinition.

func (*ParameterDefinition) UnmarshalJSON Uses

func (pd *ParameterDefinition) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ParameterDefinition struct.

type ParameterDefinitionMetadata Uses

type ParameterDefinitionMetadata struct {
    // DisplayName - DisplayName of this parameter/resourceGroup.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Description of this parameter/resourceGroup.
    Description *string `json:"description,omitempty"`
    // StrongType - StrongType for UI to render rich experience during blueprint assignment.
    StrongType *string `json:"strongType,omitempty"`
}

ParameterDefinitionMetadata user-friendly properties for this parameter.

type ParameterValue Uses

type ParameterValue struct {
    // Value - Actual value.
    Value interface{} `json:"value,omitempty"`
    // Description - Optional property. Establishes ParameterValueBase as a BaseClass.
    Description *string `json:"description,omitempty"`
}

ParameterValue value for the specified parameter.

type ParameterValueBase Uses

type ParameterValueBase struct {
    // Description - Optional property. Establishes ParameterValueBase as a BaseClass.
    Description *string `json:"description,omitempty"`
}

ParameterValueBase base class for ParameterValue.

type PolicyAssignmentArtifact Uses

type PolicyAssignmentArtifact struct {
    // PolicyAssignmentArtifactProperties - properties for policyAssignment Artifact
    *PolicyAssignmentArtifactProperties `json:"properties,omitempty"`
    // Kind - Possible values include: 'KindArtifact', 'KindTemplate', 'KindRoleAssignment', 'KindPolicyAssignment'
    Kind Kind `json:"kind,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

PolicyAssignmentArtifact blueprint artifact that applies a Policy assignment.

func (PolicyAssignmentArtifact) AsArtifact Uses

func (paa PolicyAssignmentArtifact) AsArtifact() (*Artifact, bool)

AsArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsBasicArtifact Uses

func (paa PolicyAssignmentArtifact) AsBasicArtifact() (BasicArtifact, bool)

AsBasicArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsPolicyAssignmentArtifact Uses

func (paa PolicyAssignmentArtifact) AsPolicyAssignmentArtifact() (*PolicyAssignmentArtifact, bool)

AsPolicyAssignmentArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsRoleAssignmentArtifact Uses

func (paa PolicyAssignmentArtifact) AsRoleAssignmentArtifact() (*RoleAssignmentArtifact, bool)

AsRoleAssignmentArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsTemplateArtifact Uses

func (paa PolicyAssignmentArtifact) AsTemplateArtifact() (*TemplateArtifact, bool)

AsTemplateArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) MarshalJSON Uses

func (paa PolicyAssignmentArtifact) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PolicyAssignmentArtifact.

func (*PolicyAssignmentArtifact) UnmarshalJSON Uses

func (paa *PolicyAssignmentArtifact) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PolicyAssignmentArtifact struct.

type PolicyAssignmentArtifactProperties Uses

type PolicyAssignmentArtifactProperties struct {
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
    // DependsOn - Artifacts which need to be deployed before the specified artifact.
    DependsOn *[]string `json:"dependsOn,omitempty"`
    // PolicyDefinitionID - Azure resource ID of the policy definition.
    PolicyDefinitionID *string `json:"policyDefinitionId,omitempty"`
    // Parameters - Parameter values for the policy definition.
    Parameters map[string]*ParameterValueBase `json:"parameters"`
    // ResourceGroup - Name of the resource group placeholder to which the policy will be assigned.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
}

PolicyAssignmentArtifactProperties properties of a Policy assignment blueprint artifact.

func (PolicyAssignmentArtifactProperties) MarshalJSON Uses

func (paap PolicyAssignmentArtifactProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PolicyAssignmentArtifactProperties.

type Properties Uses

type Properties struct {
    // Versions - Published versions of this blueprint definition.
    Versions interface{} `json:"versions,omitempty"`
    // Layout - Layout view of the blueprint definition for UI reference.
    Layout interface{} `json:"layout,omitempty"`
    // Status - READ-ONLY; Status of the blueprint. This field is readonly.
    Status *Status `json:"status,omitempty"`
    // TargetScope - The scope where this blueprint definition can be assigned. Possible values include: 'Subscription', 'ManagementGroup'
    TargetScope TargetScope `json:"targetScope,omitempty"`
    // Parameters - Parameters required by this blueprint definition.
    Parameters map[string]*ParameterDefinition `json:"parameters"`
    // ResourceGroups - Resource group placeholders defined by this blueprint definition.
    ResourceGroups map[string]*ResourceGroupDefinition `json:"resourceGroups"`
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
}

Properties schema for blueprint definition properties.

func (Properties) MarshalJSON Uses

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

type PublishedArtifactsClient Uses

type PublishedArtifactsClient struct {
    BaseClient
}

PublishedArtifactsClient is the blueprint Client

func NewPublishedArtifactsClient Uses

func NewPublishedArtifactsClient() PublishedArtifactsClient

NewPublishedArtifactsClient creates an instance of the PublishedArtifactsClient client.

func NewPublishedArtifactsClientWithBaseURI Uses

func NewPublishedArtifactsClientWithBaseURI(baseURI string) PublishedArtifactsClient

NewPublishedArtifactsClientWithBaseURI creates an instance of the PublishedArtifactsClient client.

func (PublishedArtifactsClient) Get Uses

func (client PublishedArtifactsClient) Get(ctx context.Context, scope string, blueprintName string, versionID string, artifactName string) (result ArtifactModel, err error)

Get get an artifact for a published blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. versionID - version of the published blueprint definition. artifactName - name of the blueprint artifact.

func (PublishedArtifactsClient) GetPreparer Uses

func (client PublishedArtifactsClient) GetPreparer(ctx context.Context, scope string, blueprintName string, versionID string, artifactName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PublishedArtifactsClient) GetResponder Uses

func (client PublishedArtifactsClient) GetResponder(resp *http.Response) (result ArtifactModel, err error)

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

func (PublishedArtifactsClient) GetSender Uses

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

func (client PublishedArtifactsClient) List(ctx context.Context, scope string, blueprintName string, versionID string) (result ArtifactListPage, err error)

List list artifacts for a version of a published blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. versionID - version of the published blueprint definition.

func (PublishedArtifactsClient) ListComplete Uses

func (client PublishedArtifactsClient) ListComplete(ctx context.Context, scope string, blueprintName string, versionID string) (result ArtifactListIterator, err error)

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

func (PublishedArtifactsClient) ListPreparer Uses

func (client PublishedArtifactsClient) ListPreparer(ctx context.Context, scope string, blueprintName string, versionID string) (*http.Request, error)

ListPreparer prepares the List request.

func (PublishedArtifactsClient) ListResponder Uses

func (client PublishedArtifactsClient) ListResponder(resp *http.Response) (result ArtifactList, err error)

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

func (PublishedArtifactsClient) ListSender Uses

func (client PublishedArtifactsClient) 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 PublishedBlueprint Uses

type PublishedBlueprint struct {
    autorest.Response `json:"-"`
    // PublishedBlueprintProperties - Detailed properties for published blueprint.
    *PublishedBlueprintProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

PublishedBlueprint represents a published blueprint.

func (PublishedBlueprint) MarshalJSON Uses

func (pb PublishedBlueprint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PublishedBlueprint.

func (*PublishedBlueprint) UnmarshalJSON Uses

func (pb *PublishedBlueprint) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PublishedBlueprint struct.

type PublishedBlueprintList Uses

type PublishedBlueprintList struct {
    autorest.Response `json:"-"`
    // Value - List of published blueprint definitions.
    Value *[]PublishedBlueprint `json:"value,omitempty"`
    // NextLink - READ-ONLY; Link to the next page of results.
    NextLink *string `json:"nextLink,omitempty"`
}

PublishedBlueprintList list of published blueprint definitions.

func (PublishedBlueprintList) IsEmpty Uses

func (pbl PublishedBlueprintList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PublishedBlueprintListIterator Uses

type PublishedBlueprintListIterator struct {
    // contains filtered or unexported fields
}

PublishedBlueprintListIterator provides access to a complete listing of PublishedBlueprint values.

func NewPublishedBlueprintListIterator Uses

func NewPublishedBlueprintListIterator(page PublishedBlueprintListPage) PublishedBlueprintListIterator

Creates a new instance of the PublishedBlueprintListIterator type.

func (*PublishedBlueprintListIterator) Next Uses

func (iter *PublishedBlueprintListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PublishedBlueprintListIterator) NextWithContext Uses

func (iter *PublishedBlueprintListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PublishedBlueprintListIterator) NotDone Uses

func (iter PublishedBlueprintListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (PublishedBlueprintListIterator) Response Uses

func (iter PublishedBlueprintListIterator) Response() PublishedBlueprintList

Response returns the raw server response from the last page request.

func (PublishedBlueprintListIterator) Value Uses

func (iter PublishedBlueprintListIterator) Value() PublishedBlueprint

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PublishedBlueprintListPage Uses

type PublishedBlueprintListPage struct {
    // contains filtered or unexported fields
}

PublishedBlueprintListPage contains a page of PublishedBlueprint values.

func NewPublishedBlueprintListPage Uses

func NewPublishedBlueprintListPage(getNextPage func(context.Context, PublishedBlueprintList) (PublishedBlueprintList, error)) PublishedBlueprintListPage

Creates a new instance of the PublishedBlueprintListPage type.

func (*PublishedBlueprintListPage) Next Uses

func (page *PublishedBlueprintListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PublishedBlueprintListPage) NextWithContext Uses

func (page *PublishedBlueprintListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PublishedBlueprintListPage) NotDone Uses

func (page PublishedBlueprintListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PublishedBlueprintListPage) Response Uses

func (page PublishedBlueprintListPage) Response() PublishedBlueprintList

Response returns the raw server response from the last page request.

func (PublishedBlueprintListPage) Values Uses

func (page PublishedBlueprintListPage) Values() []PublishedBlueprint

Values returns the slice of values for the current page or nil if there are no values.

type PublishedBlueprintProperties Uses

type PublishedBlueprintProperties struct {
    // BlueprintName - Name of the published blueprint definition.
    BlueprintName *string `json:"blueprintName,omitempty"`
    // ChangeNotes - Version-specific change notes.
    ChangeNotes *string `json:"changeNotes,omitempty"`
    // Status - READ-ONLY; Status of the blueprint. This field is readonly.
    Status *Status `json:"status,omitempty"`
    // TargetScope - The scope where this blueprint definition can be assigned. Possible values include: 'Subscription', 'ManagementGroup'
    TargetScope TargetScope `json:"targetScope,omitempty"`
    // Parameters - Parameters required by this blueprint definition.
    Parameters map[string]*ParameterDefinition `json:"parameters"`
    // ResourceGroups - Resource group placeholders defined by this blueprint definition.
    ResourceGroups map[string]*ResourceGroupDefinition `json:"resourceGroups"`
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
}

PublishedBlueprintProperties schema for published blueprint definition properties.

func (PublishedBlueprintProperties) MarshalJSON Uses

func (pbp PublishedBlueprintProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PublishedBlueprintProperties.

type PublishedBlueprintsClient Uses

type PublishedBlueprintsClient struct {
    BaseClient
}

PublishedBlueprintsClient is the blueprint Client

func NewPublishedBlueprintsClient Uses

func NewPublishedBlueprintsClient() PublishedBlueprintsClient

NewPublishedBlueprintsClient creates an instance of the PublishedBlueprintsClient client.

func NewPublishedBlueprintsClientWithBaseURI Uses

func NewPublishedBlueprintsClientWithBaseURI(baseURI string) PublishedBlueprintsClient

NewPublishedBlueprintsClientWithBaseURI creates an instance of the PublishedBlueprintsClient client.

func (PublishedBlueprintsClient) Create Uses

func (client PublishedBlueprintsClient) Create(ctx context.Context, scope string, blueprintName string, versionID string, publishedBlueprint *PublishedBlueprint) (result PublishedBlueprint, err error)

Create publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. versionID - version of the published blueprint definition. publishedBlueprint - published Blueprint to create or update.

func (PublishedBlueprintsClient) CreatePreparer Uses

func (client PublishedBlueprintsClient) CreatePreparer(ctx context.Context, scope string, blueprintName string, versionID string, publishedBlueprint *PublishedBlueprint) (*http.Request, error)

CreatePreparer prepares the Create request.

func (PublishedBlueprintsClient) CreateResponder Uses

func (client PublishedBlueprintsClient) CreateResponder(resp *http.Response) (result PublishedBlueprint, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (PublishedBlueprintsClient) CreateSender Uses

func (client PublishedBlueprintsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (PublishedBlueprintsClient) Delete Uses

func (client PublishedBlueprintsClient) Delete(ctx context.Context, scope string, blueprintName string, versionID string) (result PublishedBlueprint, err error)

Delete delete a published version of a blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. versionID - version of the published blueprint definition.

func (PublishedBlueprintsClient) DeletePreparer Uses

func (client PublishedBlueprintsClient) DeletePreparer(ctx context.Context, scope string, blueprintName string, versionID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PublishedBlueprintsClient) DeleteResponder Uses

func (client PublishedBlueprintsClient) DeleteResponder(resp *http.Response) (result PublishedBlueprint, err error)

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

func (PublishedBlueprintsClient) DeleteSender Uses

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

func (client PublishedBlueprintsClient) Get(ctx context.Context, scope string, blueprintName string, versionID string) (result PublishedBlueprint, err error)

Get get a published version of a blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition. versionID - version of the published blueprint definition.

func (PublishedBlueprintsClient) GetPreparer Uses

func (client PublishedBlueprintsClient) GetPreparer(ctx context.Context, scope string, blueprintName string, versionID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PublishedBlueprintsClient) GetResponder Uses

func (client PublishedBlueprintsClient) GetResponder(resp *http.Response) (result PublishedBlueprint, err error)

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

func (PublishedBlueprintsClient) GetSender Uses

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

func (client PublishedBlueprintsClient) List(ctx context.Context, scope string, blueprintName string) (result PublishedBlueprintListPage, err error)

List list published versions of given blueprint definition. Parameters: scope - the scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). For blueprint assignments management group scope is reserved for future use. blueprintName - name of the blueprint definition.

func (PublishedBlueprintsClient) ListComplete Uses

func (client PublishedBlueprintsClient) ListComplete(ctx context.Context, scope string, blueprintName string) (result PublishedBlueprintListIterator, err error)

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

func (PublishedBlueprintsClient) ListPreparer Uses

func (client PublishedBlueprintsClient) ListPreparer(ctx context.Context, scope string, blueprintName string) (*http.Request, error)

ListPreparer prepares the List request.

func (PublishedBlueprintsClient) ListResponder Uses

func (client PublishedBlueprintsClient) ListResponder(resp *http.Response) (result PublishedBlueprintList, err error)

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

func (PublishedBlueprintsClient) ListSender Uses

func (client PublishedBlueprintsClient) 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 ResourceGroupDefinition Uses

type ResourceGroupDefinition struct {
    // Name - Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
    Name *string `json:"name,omitempty"`
    // Location - Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
    Location *string `json:"location,omitempty"`
    // ParameterDefinitionMetadata - User-friendly properties for this resource group.
    *ParameterDefinitionMetadata `json:"metadata,omitempty"`
    // DependsOn - Artifacts which need to be deployed before this resource group.
    DependsOn *[]string `json:"dependsOn,omitempty"`
    // Tags - Tags to be assigned to this resource group.
    Tags map[string]*string `json:"tags"`
}

ResourceGroupDefinition represents an Azure resource group in a blueprint definition.

func (ResourceGroupDefinition) MarshalJSON Uses

func (rgd ResourceGroupDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceGroupDefinition.

func (*ResourceGroupDefinition) UnmarshalJSON Uses

func (rgd *ResourceGroupDefinition) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceGroupDefinition struct.

type ResourceGroupValue Uses

type ResourceGroupValue struct {
    // Name - Name of the resource group.
    Name *string `json:"name,omitempty"`
    // Location - Location of the resource group.
    Location *string `json:"location,omitempty"`
}

ResourceGroupValue represents an Azure resource group.

type ResourcePropertiesBase Uses

type ResourcePropertiesBase struct {
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
}

ResourcePropertiesBase shared properties between all blueprint resources.

type ResourceProviderOperation Uses

type ResourceProviderOperation struct {
    // Name - Operation name, in format of {provider}/{resource}/{operation}
    Name *string `json:"name,omitempty"`
    // Display - Display metadata associated with the operation.
    Display *ResourceProviderOperationDisplay `json:"display,omitempty"`
}

ResourceProviderOperation supported operations of this resource provider.

type ResourceProviderOperationDisplay Uses

type ResourceProviderOperationDisplay struct {
    // Provider - Resource provider: Microsoft Blueprint.
    Provider *string `json:"provider,omitempty"`
    // Resource - Resource on which the operation is performed.
    Resource *string `json:"resource,omitempty"`
    // Operation - Type of operation: get, read, delete, etc.
    Operation *string `json:"operation,omitempty"`
    // Description - Description of this operation.
    Description *string `json:"description,omitempty"`
}

ResourceProviderOperationDisplay display metadata associated with the operation.

type ResourceProviderOperationList Uses

type ResourceProviderOperationList struct {
    // Value - List of operations supported by this resource provider.
    Value *[]ResourceProviderOperation `json:"value,omitempty"`
}

ResourceProviderOperationList results of the request to list operations.

type ResourceStatusBase Uses

type ResourceStatusBase struct {
    // TimeCreated - READ-ONLY; Creation time of this blueprint definition.
    TimeCreated *date.Time `json:"timeCreated,omitempty"`
    // LastModified - READ-ONLY; Last modified time of this blueprint definition.
    LastModified *date.Time `json:"lastModified,omitempty"`
}

ResourceStatusBase shared status properties between all blueprint resources.

type RoleAssignmentArtifact Uses

type RoleAssignmentArtifact struct {
    // RoleAssignmentArtifactProperties - Properties for a Role assignment blueprint artifact.
    *RoleAssignmentArtifactProperties `json:"properties,omitempty"`
    // Kind - Possible values include: 'KindArtifact', 'KindTemplate', 'KindRoleAssignment', 'KindPolicyAssignment'
    Kind Kind `json:"kind,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

RoleAssignmentArtifact blueprint artifact that applies a Role assignment.

func (RoleAssignmentArtifact) AsArtifact Uses

func (raa RoleAssignmentArtifact) AsArtifact() (*Artifact, bool)

AsArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsBasicArtifact Uses

func (raa RoleAssignmentArtifact) AsBasicArtifact() (BasicArtifact, bool)

AsBasicArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsPolicyAssignmentArtifact Uses

func (raa RoleAssignmentArtifact) AsPolicyAssignmentArtifact() (*PolicyAssignmentArtifact, bool)

AsPolicyAssignmentArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsRoleAssignmentArtifact Uses

func (raa RoleAssignmentArtifact) AsRoleAssignmentArtifact() (*RoleAssignmentArtifact, bool)

AsRoleAssignmentArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsTemplateArtifact Uses

func (raa RoleAssignmentArtifact) AsTemplateArtifact() (*TemplateArtifact, bool)

AsTemplateArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) MarshalJSON Uses

func (raa RoleAssignmentArtifact) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RoleAssignmentArtifact.

func (*RoleAssignmentArtifact) UnmarshalJSON Uses

func (raa *RoleAssignmentArtifact) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoleAssignmentArtifact struct.

type RoleAssignmentArtifactProperties Uses

type RoleAssignmentArtifactProperties struct {
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
    // DependsOn - Artifacts which need to be deployed before the specified artifact.
    DependsOn *[]string `json:"dependsOn,omitempty"`
    // RoleDefinitionID - Azure resource ID of the RoleDefinition.
    RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
    // PrincipalIds - Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity.
    PrincipalIds interface{} `json:"principalIds,omitempty"`
    // ResourceGroup - RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoleAssignmentArtifactProperties properties of a Role assignment blueprint artifact.

type SecretReferenceParameterValue Uses

type SecretReferenceParameterValue struct {
    // Reference - Specifies the reference.
    Reference *SecretValueReference `json:"reference,omitempty"`
    // Description - Optional property. Establishes ParameterValueBase as a BaseClass.
    Description *string `json:"description,omitempty"`
}

SecretReferenceParameterValue the reference to a secret, if the parameter should be protected.

type SecretValueReference Uses

type SecretValueReference struct {
    // KeyVault - Specifies the reference to a given Azure Key Vault.
    KeyVault *KeyVaultReference `json:"keyVault,omitempty"`
    // SecretName - Name of the secret.
    SecretName *string `json:"secretName,omitempty"`
    // SecretVersion - The version of the secret to use. If left blank, the latest version of the secret is used.
    SecretVersion *string `json:"secretVersion,omitempty"`
}

SecretValueReference reference to a Key Vault secret.

type SharedBlueprintProperties Uses

type SharedBlueprintProperties struct {
    // Status - READ-ONLY; Status of the blueprint. This field is readonly.
    Status *Status `json:"status,omitempty"`
    // TargetScope - The scope where this blueprint definition can be assigned. Possible values include: 'Subscription', 'ManagementGroup'
    TargetScope TargetScope `json:"targetScope,omitempty"`
    // Parameters - Parameters required by this blueprint definition.
    Parameters map[string]*ParameterDefinition `json:"parameters"`
    // ResourceGroups - Resource group placeholders defined by this blueprint definition.
    ResourceGroups map[string]*ResourceGroupDefinition `json:"resourceGroups"`
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
}

SharedBlueprintProperties shared Schema for both blueprintProperties and publishedBlueprintProperties.

func (SharedBlueprintProperties) MarshalJSON Uses

func (sbp SharedBlueprintProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SharedBlueprintProperties.

type Status Uses

type Status struct {
    // TimeCreated - READ-ONLY; Creation time of this blueprint definition.
    TimeCreated *date.Time `json:"timeCreated,omitempty"`
    // LastModified - READ-ONLY; Last modified time of this blueprint definition.
    LastModified *date.Time `json:"lastModified,omitempty"`
}

Status the status of the blueprint. This field is readonly.

type TargetScope Uses

type TargetScope string

TargetScope enumerates the values for target scope.

const (
    // ManagementGroup The blueprint targets a management group during blueprint assignment. This is reserved
    // for future use.
    ManagementGroup TargetScope = "managementGroup"
    // Subscription The blueprint targets a subscription during blueprint assignment.
    Subscription TargetScope = "subscription"
)

func PossibleTargetScopeValues Uses

func PossibleTargetScopeValues() []TargetScope

PossibleTargetScopeValues returns an array of possible values for the TargetScope const type.

type TemplateArtifact Uses

type TemplateArtifact struct {
    // TemplateArtifactProperties - Properties for a Resource Manager template blueprint artifact.
    *TemplateArtifactProperties `json:"properties,omitempty"`
    // Kind - Possible values include: 'KindArtifact', 'KindTemplate', 'KindRoleAssignment', 'KindPolicyAssignment'
    Kind Kind `json:"kind,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

TemplateArtifact blueprint artifact that deploys a Resource Manager template.

func (TemplateArtifact) AsArtifact Uses

func (ta TemplateArtifact) AsArtifact() (*Artifact, bool)

AsArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsBasicArtifact Uses

func (ta TemplateArtifact) AsBasicArtifact() (BasicArtifact, bool)

AsBasicArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsPolicyAssignmentArtifact Uses

func (ta TemplateArtifact) AsPolicyAssignmentArtifact() (*PolicyAssignmentArtifact, bool)

AsPolicyAssignmentArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsRoleAssignmentArtifact Uses

func (ta TemplateArtifact) AsRoleAssignmentArtifact() (*RoleAssignmentArtifact, bool)

AsRoleAssignmentArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsTemplateArtifact Uses

func (ta TemplateArtifact) AsTemplateArtifact() (*TemplateArtifact, bool)

AsTemplateArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) MarshalJSON Uses

func (ta TemplateArtifact) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TemplateArtifact.

func (*TemplateArtifact) UnmarshalJSON Uses

func (ta *TemplateArtifact) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TemplateArtifact struct.

type TemplateArtifactProperties Uses

type TemplateArtifactProperties struct {
    // DisplayName - One-liner string explain this resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Description - Multi-line explain this resource.
    Description *string `json:"description,omitempty"`
    // DependsOn - Artifacts which need to be deployed before the specified artifact.
    DependsOn *[]string `json:"dependsOn,omitempty"`
    // Template - The Resource Manager template blueprint artifact body.
    Template interface{} `json:"template,omitempty"`
    // ResourceGroup - If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // Parameters - Resource Manager template blueprint artifact parameter values.
    Parameters map[string]*ParameterValueBase `json:"parameters"`
}

TemplateArtifactProperties properties of a Resource Manager template blueprint artifact.

func (TemplateArtifactProperties) MarshalJSON Uses

func (tap TemplateArtifactProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TemplateArtifactProperties.

type TemplateParameterType Uses

type TemplateParameterType string

TemplateParameterType enumerates the values for template parameter type.

const (
    // Array ...
    Array TemplateParameterType = "array"
    // Bool ...
    Bool TemplateParameterType = "bool"
    // Int ...
    Int TemplateParameterType = "int"
    // Object ...
    Object TemplateParameterType = "object"
    // SecureObject ...
    SecureObject TemplateParameterType = "secureObject"
    // SecureString ...
    SecureString TemplateParameterType = "secureString"
    // String ...
    String TemplateParameterType = "string"
)

func PossibleTemplateParameterTypeValues Uses

func PossibleTemplateParameterTypeValues() []TemplateParameterType

PossibleTemplateParameterTypeValues returns an array of possible values for the TemplateParameterType const type.

type TrackedResource Uses

type TrackedResource struct {
    // Location - The location of this blueprint assignment.
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; String Id used to locate any resource on Azure.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Type of this resource.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Name of this resource.
    Name *string `json:"name,omitempty"`
}

TrackedResource common properties for all Azure tracked resources.

type UserAssignedIdentity Uses

type UserAssignedIdentity struct {
    // PrincipalID - Azure Active Directory principal ID associated with this Identity.
    PrincipalID *string `json:"principalId,omitempty"`
    // ClientID - Client App Id associated with this identity.
    ClientID *string `json:"clientId,omitempty"`
}

UserAssignedIdentity user-assigned managed identity.

type WhoIsBlueprintContract Uses

type WhoIsBlueprintContract struct {
    autorest.Response `json:"-"`
    // ObjectID - AAD object Id of the Azure Blueprints service principal in the tenant.
    ObjectID *string `json:"objectId,omitempty"`
}

WhoIsBlueprintContract response schema for querying the Azure Blueprints service principal in the tenant.

Directories

PathSynopsis
blueprintapi

Package blueprint imports 10 packages (graph) and is imported by 3 packages. Updated 2019-07-30. Refresh now. Tools for package owners.