blueprint

package
v23.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

Blueprint Client

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type Artifact 

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

Artifact represents a Blueprint artifact.

func (Artifact) AsArtifact 

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

AsArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsBasicArtifact 

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

AsBasicArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsPolicyAssignmentArtifact 

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

AsPolicyAssignmentArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsRoleAssignmentArtifact 

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

AsRoleAssignmentArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) AsTemplateArtifact 

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

AsTemplateArtifact is the BasicArtifact implementation for Artifact.

func (Artifact) MarshalJSON 

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

MarshalJSON is the custom marshaler for Artifact.

type ArtifactList 

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

ArtifactList list of Blueprint artifacts

func (ArtifactList) IsEmpty 

func (al ArtifactList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*ArtifactList) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ArtifactList struct.

type ArtifactListIterator 

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

ArtifactListIterator provides access to a complete listing of Artifact values.

func NewArtifactListIterator 

func NewArtifactListIterator(page ArtifactListPage) ArtifactListIterator

Creates a new instance of the ArtifactListIterator type.

func (*ArtifactListIterator) Next 

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 

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 

func (iter ArtifactListIterator) NotDone() bool

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

func (ArtifactListIterator) Response 

func (iter ArtifactListIterator) Response() ArtifactList

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

func (ArtifactListIterator) Value 

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 

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

ArtifactListPage contains a page of BasicArtifact values.

func NewArtifactListPage 

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

Creates a new instance of the ArtifactListPage type.

func (*ArtifactListPage) Next 

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 

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 

func (page ArtifactListPage) NotDone() bool

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

func (ArtifactListPage) Response 

func (page ArtifactListPage) Response() ArtifactList

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

func (ArtifactListPage) Values 

func (page ArtifactListPage) Values() []BasicArtifact

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

type ArtifactModel 

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

ArtifactModel ...

func (*ArtifactModel) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ArtifactModel struct.

type ArtifactPropertiesBase 

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 

type ArtifactsClient struct {
	BaseClient
}

ArtifactsClient is the blueprint Client

func NewArtifactsClient 

func NewArtifactsClient() ArtifactsClient

NewArtifactsClient creates an instance of the ArtifactsClient client.

func NewArtifactsClientWithBaseURI 

func NewArtifactsClientWithBaseURI(baseURI string) ArtifactsClient

NewArtifactsClientWithBaseURI creates an instance of the ArtifactsClient client.

func (ArtifactsClient) CreateOrUpdate 

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

CreateOrUpdate create or update Blueprint artifact. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. artifactName - name of the artifact. artifact - blueprint artifact to save.

func (ArtifactsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ArtifactsClient) CreateOrUpdateResponder 

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 

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 

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

Delete delete a Blueprint artifact. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. artifactName - name of the artifact.

func (ArtifactsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (ArtifactsClient) DeleteResponder 

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 

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 

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

Get get a Blueprint artifact. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. artifactName - name of the artifact.

func (ArtifactsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (ArtifactsClient) GetResponder 

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 

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 

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

List list artifacts for a given Blueprint. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint.

func (ArtifactsClient) ListComplete 

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

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

func (ArtifactsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (ArtifactsClient) ListResponder 

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 

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 

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

Assignment represents a Blueprint assignment.

func (Assignment) MarshalJSON 

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

MarshalJSON is the custom marshaler for Assignment.

func (*Assignment) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for Assignment struct.

type AssignmentList 

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

AssignmentList list of Blueprint assignments

func (AssignmentList) IsEmpty 

func (al AssignmentList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AssignmentListIterator 

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

AssignmentListIterator provides access to a complete listing of Assignment values.

func NewAssignmentListIterator 

func NewAssignmentListIterator(page AssignmentListPage) AssignmentListIterator

Creates a new instance of the AssignmentListIterator type.

func (*AssignmentListIterator) Next 

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 

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 

func (iter AssignmentListIterator) NotDone() bool

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

func (AssignmentListIterator) Response 

func (iter AssignmentListIterator) Response() AssignmentList

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

func (AssignmentListIterator) Value 

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 

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

AssignmentListPage contains a page of Assignment values.

func NewAssignmentListPage 

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

Creates a new instance of the AssignmentListPage type.

func (*AssignmentListPage) Next 

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 

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 

func (page AssignmentListPage) NotDone() bool

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

func (AssignmentListPage) Response 

func (page AssignmentListPage) Response() AssignmentList

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

func (AssignmentListPage) Values 

func (page AssignmentListPage) Values() []Assignment

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

type AssignmentLockMode 

type AssignmentLockMode string

AssignmentLockMode enumerates the values for assignment lock mode. 

const (
	// AllResources ...
	AllResources AssignmentLockMode = "AllResources"
	// None ...
	None AssignmentLockMode = "None"
)

func PossibleAssignmentLockModeValues 

func PossibleAssignmentLockModeValues() []AssignmentLockMode

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

type AssignmentLockSettings 

type AssignmentLockSettings struct {
	// Mode - Lock mode. Possible values include: 'None', 'AllResources'
	Mode AssignmentLockMode `json:"mode,omitempty"`
}

AssignmentLockSettings defines how Blueprint-managed resources will be locked.

type AssignmentProperties 

type AssignmentProperties struct {
	// BlueprintID - ID of the Blueprint definition resource.
	BlueprintID *string `json:"blueprintId,omitempty"`
	// Parameters - Blueprint parameter values.
	Parameters map[string]*ParameterValueBase `json:"parameters"`
	// ResourceGroups - Names and locations of resource group placeholders.
	ResourceGroups map[string]*ResourceGroupValue `json:"resourceGroups"`
	// Status - Status of Blueprint assignment. This field is readonly.
	Status *AssignmentStatus `json:"status,omitempty"`
	// Locks - Defines how Blueprint-managed resources will be locked.
	Locks *AssignmentLockSettings `json:"locks,omitempty"`
	// ProvisioningState - State of the 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 Assignment.

func (AssignmentProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for AssignmentProperties.

type AssignmentProvisioningState 

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 

func PossibleAssignmentProvisioningStateValues() []AssignmentProvisioningState

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

type AssignmentStatus 

type AssignmentStatus struct {
	// TimeCreated - Creation time of this blueprint.
	TimeCreated *string `json:"timeCreated,omitempty"`
	// LastModified - Last modified time of this blueprint.
	LastModified *string `json:"lastModified,omitempty"`
}

AssignmentStatus the status of Blueprint assignment. This field is readonly.

type AssignmentsClient 

type AssignmentsClient struct {
	BaseClient
}

AssignmentsClient is the blueprint Client

func NewAssignmentsClient 

func NewAssignmentsClient() AssignmentsClient

NewAssignmentsClient creates an instance of the AssignmentsClient client.

func NewAssignmentsClientWithBaseURI 

func NewAssignmentsClientWithBaseURI(baseURI string) AssignmentsClient

NewAssignmentsClientWithBaseURI creates an instance of the AssignmentsClient client.

func (AssignmentsClient) CreateOrUpdate 

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

CreateOrUpdate create or update a Blueprint assignment. Parameters: subscriptionID - azure subscriptionId, which we assign the blueprint to. assignmentName - name of the assignment. assignment - assignment object to save.

func (AssignmentsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AssignmentsClient) CreateOrUpdateResponder 

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 

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 

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

Delete delete a Blueprint assignment. Parameters: subscriptionID - azure subscriptionId, which we assign the blueprint to. assignmentName - name of the assignment.

func (AssignmentsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (AssignmentsClient) DeleteResponder 

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 

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 

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

Get get a Blueprint assignment. Parameters: subscriptionID - azure subscriptionId, which we assign the blueprint to. assignmentName - name of the assignment.

func (AssignmentsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (AssignmentsClient) GetResponder 

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 

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 

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

List list Blueprint assignments within a subscription. Parameters: subscriptionID - azure subscriptionId, which we assign the blueprint to.

func (AssignmentsClient) ListComplete 

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

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

func (AssignmentsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (AssignmentsClient) ListResponder 

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 

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.

type AzureResourceBase 

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

AzureResourceBase common properties for all Azure resources.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Blueprint.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BasicArtifact 

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

BasicArtifact represents a Blueprint artifact.

type BlueprintsClient 

type BlueprintsClient struct {
	BaseClient
}

BlueprintsClient is the blueprint Client

func NewBlueprintsClient 

func NewBlueprintsClient() BlueprintsClient

NewBlueprintsClient creates an instance of the BlueprintsClient client.

func NewBlueprintsClientWithBaseURI 

func NewBlueprintsClientWithBaseURI(baseURI string) BlueprintsClient

NewBlueprintsClientWithBaseURI creates an instance of the BlueprintsClient client.

func (BlueprintsClient) CreateOrUpdate 

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

CreateOrUpdate create or update Blueprint definition. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. blueprint - blueprint definition.

func (BlueprintsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BlueprintsClient) CreateOrUpdateResponder 

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 

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 

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

Delete delete a blueprint definition. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint.

func (BlueprintsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (BlueprintsClient) DeleteResponder 

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 

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 

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

Get get a blueprint definition. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint.

func (BlueprintsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (BlueprintsClient) GetResponder 

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 

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 

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

List create or update blueprint definition. Parameters: managementGroupName - managementGroup where blueprint stores.

func (BlueprintsClient) ListComplete 

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

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

func (BlueprintsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (BlueprintsClient) ListResponder 

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 

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 

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

KeyVaultReference specifies the link to a KeyVault.

type Kind 

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 

func PossibleKindValues() []Kind

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

type List 

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

List list of Blueprint definitions.

func (List) IsEmpty 

func (l List) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListIterator 

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

ListIterator provides access to a complete listing of Model values.

func NewListIterator 

func NewListIterator(page ListPage) ListIterator

Creates a new instance of the ListIterator type.

func (*ListIterator) Next 

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 

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 

func (iter ListIterator) NotDone() bool

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

func (ListIterator) Response 

func (iter ListIterator) Response() List

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

func (ListIterator) Value 

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 

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

ListPage contains a page of Model values.

func NewListPage 

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

Creates a new instance of the ListPage type.

func (*ListPage) Next 

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 

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 

func (page ListPage) NotDone() bool

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

func (ListPage) Response 

func (page ListPage) Response() List

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

func (ListPage) Values 

func (page ListPage) Values() []Model

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

type ManagedServiceIdentity 

type ManagedServiceIdentity struct {
	// Type - Type of the Managed Service 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"`
}

ManagedServiceIdentity managed Service Identity

type ManagedServiceIdentityType 

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 

func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType

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

type Model 

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

Model represents a Blueprint definition.

func (Model) MarshalJSON 

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

MarshalJSON is the custom marshaler for Model.

func (*Model) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for Model struct.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the blueprint Client

func NewOperationsClient 

func NewOperationsClient() OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

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

List list all of the available operations the Blueprint resource provider supports.

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

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

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

func (OperationsClient) ListSender 

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

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

type ParameterDefinition 

type ParameterDefinition struct {
	// Type - Allowed data types for Azure 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 

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

MarshalJSON is the custom marshaler for ParameterDefinition.

func (*ParameterDefinition) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ParameterDefinition struct.

type ParameterDefinitionMetadata 

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 assignment time.
	StrongType *string `json:"strongType,omitempty"`
}

ParameterDefinitionMetadata user-friendly properties for this parameter.

type ParameterValue 

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

ParameterValue value for the specified parameter.

type ParameterValueBase 

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

ParameterValueBase base class for ParameterValue.

type PolicyAssignmentArtifact 

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

PolicyAssignmentArtifact blueprint artifact applies Policy assignments.

func (PolicyAssignmentArtifact) AsArtifact 

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

AsArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsBasicArtifact 

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

AsBasicArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsPolicyAssignmentArtifact 

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

AsPolicyAssignmentArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsRoleAssignmentArtifact 

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

AsRoleAssignmentArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) AsTemplateArtifact 

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

AsTemplateArtifact is the BasicArtifact implementation for PolicyAssignmentArtifact.

func (PolicyAssignmentArtifact) MarshalJSON 

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

MarshalJSON is the custom marshaler for PolicyAssignmentArtifact.

func (*PolicyAssignmentArtifact) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for PolicyAssignmentArtifact struct.

type PolicyAssignmentArtifactProperties 

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 policyAssignment properties

func (PolicyAssignmentArtifactProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for PolicyAssignmentArtifactProperties.

type Properties 

type Properties struct {
	// Versions - Published versions of this blueprint.
	Versions interface{} `json:"versions,omitempty"`
	// Layout - Layout view of the blueprint, for UI reference.
	Layout interface{} `json:"layout,omitempty"`
	// Status - Status of the Blueprint. This field is readonly.
	Status *Status `json:"status,omitempty"`
	// TargetScope - The scope where this Blueprint can be applied. 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 properties.

func (Properties) MarshalJSON 

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

MarshalJSON is the custom marshaler for Properties.

type PublishedArtifactsClient 

type PublishedArtifactsClient struct {
	BaseClient
}

PublishedArtifactsClient is the blueprint Client

func NewPublishedArtifactsClient 

func NewPublishedArtifactsClient() PublishedArtifactsClient

NewPublishedArtifactsClient creates an instance of the PublishedArtifactsClient client.

func NewPublishedArtifactsClientWithBaseURI 

func NewPublishedArtifactsClientWithBaseURI(baseURI string) PublishedArtifactsClient

NewPublishedArtifactsClientWithBaseURI creates an instance of the PublishedArtifactsClient client.

func (PublishedArtifactsClient) Get 

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

Get get an artifact for a published Blueprint. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. versionID - version of the published blueprint. artifactName - name of the artifact.

func (PublishedArtifactsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PublishedArtifactsClient) GetResponder 

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 

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 

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

List list artifacts for a published Blueprint. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. versionID - version of the published blueprint.

func (PublishedArtifactsClient) ListComplete 

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

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

func (PublishedArtifactsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (PublishedArtifactsClient) ListResponder 

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 

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 

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

PublishedBlueprint represents a published Blueprint.

func (PublishedBlueprint) MarshalJSON 

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

MarshalJSON is the custom marshaler for PublishedBlueprint.

func (*PublishedBlueprint) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for PublishedBlueprint struct.

type PublishedBlueprintList 

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

PublishedBlueprintList list of published Blueprints

func (PublishedBlueprintList) IsEmpty 

func (pbl PublishedBlueprintList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PublishedBlueprintListIterator 

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

PublishedBlueprintListIterator provides access to a complete listing of PublishedBlueprint values.

func NewPublishedBlueprintListIterator 

func NewPublishedBlueprintListIterator(page PublishedBlueprintListPage) PublishedBlueprintListIterator

Creates a new instance of the PublishedBlueprintListIterator type.

func (*PublishedBlueprintListIterator) Next 

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 

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 

func (iter PublishedBlueprintListIterator) NotDone() bool

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

func (PublishedBlueprintListIterator) Response 

func (iter PublishedBlueprintListIterator) Response() PublishedBlueprintList

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

func (PublishedBlueprintListIterator) Value 

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 

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

PublishedBlueprintListPage contains a page of PublishedBlueprint values.

func NewPublishedBlueprintListPage 

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

Creates a new instance of the PublishedBlueprintListPage type.

func (*PublishedBlueprintListPage) Next 

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 

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 

func (page PublishedBlueprintListPage) NotDone() bool

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

func (PublishedBlueprintListPage) Response 

func (page PublishedBlueprintListPage) Response() PublishedBlueprintList

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

func (PublishedBlueprintListPage) Values 

func (page PublishedBlueprintListPage) Values() []PublishedBlueprint

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

type PublishedBlueprintProperties 

type PublishedBlueprintProperties struct {
	// BlueprintName - Name of the Blueprint definition.
	BlueprintName *string `json:"blueprintName,omitempty"`
	// ChangeNotes - Version-specific change notes
	ChangeNotes *string `json:"changeNotes,omitempty"`
	// Status - Status of the Blueprint. This field is readonly.
	Status *Status `json:"status,omitempty"`
	// TargetScope - The scope where this Blueprint can be applied. 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 properties.

func (PublishedBlueprintProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for PublishedBlueprintProperties.

type PublishedBlueprintsClient 

type PublishedBlueprintsClient struct {
	BaseClient
}

PublishedBlueprintsClient is the blueprint Client

func NewPublishedBlueprintsClient 

func NewPublishedBlueprintsClient() PublishedBlueprintsClient

NewPublishedBlueprintsClient creates an instance of the PublishedBlueprintsClient client.

func NewPublishedBlueprintsClientWithBaseURI 

func NewPublishedBlueprintsClientWithBaseURI(baseURI string) PublishedBlueprintsClient

NewPublishedBlueprintsClientWithBaseURI creates an instance of the PublishedBlueprintsClient client.

func (PublishedBlueprintsClient) Create 

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

Create publish a new version of the Blueprint with the latest artifacts. Published Blueprints are immutable. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. versionID - version of the published blueprint.

func (PublishedBlueprintsClient) CreatePreparer 

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

CreatePreparer prepares the Create request.

func (PublishedBlueprintsClient) CreateResponder 

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 

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 

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

Delete delete a published Blueprint. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. versionID - version of the published blueprint.

func (PublishedBlueprintsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (PublishedBlueprintsClient) DeleteResponder 

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 

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 

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

Get get a published Blueprint. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint. versionID - version of the published blueprint.

func (PublishedBlueprintsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PublishedBlueprintsClient) GetResponder 

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 

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 

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

List list published versions of given Blueprint. Parameters: managementGroupName - managementGroup where blueprint stores. blueprintName - name of the blueprint.

func (PublishedBlueprintsClient) ListComplete 

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

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

func (PublishedBlueprintsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (PublishedBlueprintsClient) ListResponder 

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 

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 

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"`
}

ResourceGroupDefinition represents an Azure resource group in a Blueprint definition.

func (ResourceGroupDefinition) MarshalJSON 

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

MarshalJSON is the custom marshaler for ResourceGroupDefinition.

func (*ResourceGroupDefinition) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ResourceGroupDefinition struct.

type ResourceGroupValue 

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 

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 

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 operation of this resource provider.

type ResourceProviderOperationDisplay 

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 

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

ResourceProviderOperationList result of the request to list operations.

type ResourceStatusBase 

type ResourceStatusBase struct {
	// TimeCreated - Creation time of this blueprint.
	TimeCreated *string `json:"timeCreated,omitempty"`
	// LastModified - Last modified time of this blueprint.
	LastModified *string `json:"lastModified,omitempty"`
}

ResourceStatusBase shared status properties between all Blueprint resources.

type RoleAssignmentArtifact 

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

RoleAssignmentArtifact blueprint artifact applies Azure role assignment.

func (RoleAssignmentArtifact) AsArtifact 

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

AsArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsBasicArtifact 

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

AsBasicArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsPolicyAssignmentArtifact 

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

AsPolicyAssignmentArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsRoleAssignmentArtifact 

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

AsRoleAssignmentArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) AsTemplateArtifact 

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

AsTemplateArtifact is the BasicArtifact implementation for RoleAssignmentArtifact.

func (RoleAssignmentArtifact) MarshalJSON 

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

MarshalJSON is the custom marshaler for RoleAssignmentArtifact.

func (*RoleAssignmentArtifact) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for RoleAssignmentArtifact struct.

type RoleAssignmentArtifactProperties 

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 these identity.
	PrincipalIds interface{} `json:"principalIds,omitempty"`
	// ResourceGroup - RoleAssignment will be scope to this resourceGroup, if left empty, it would scope to the subscription.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoleAssignmentArtifactProperties properties of the Role assignment artifact.

type SecretReferenceParameterValue 

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

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

type SecretValueReference 

type SecretValueReference struct {
	// KeyVault - Specifies the reference to a given Azure KeyVault.
	KeyVault *KeyVaultReference `json:"keyVault,omitempty"`
	// SecretName - Name of the secret.
	SecretName *string `json:"secretName,omitempty"`
	// SecretVersion - Version of the secret, (if there are multiple versions)
	SecretVersion *string `json:"secretVersion,omitempty"`
}

SecretValueReference reference to a KeyVault secret.

type SharedBlueprintProperties 

type SharedBlueprintProperties struct {
	// Status - Status of the Blueprint. This field is readonly.
	Status *Status `json:"status,omitempty"`
	// TargetScope - The scope where this Blueprint can be applied. 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 

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

MarshalJSON is the custom marshaler for SharedBlueprintProperties.

type Status 

type Status struct {
	// TimeCreated - Creation time of this blueprint.
	TimeCreated *string `json:"timeCreated,omitempty"`
	// LastModified - Last modified time of this blueprint.
	LastModified *string `json:"lastModified,omitempty"`
}

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

type TargetScope 

type TargetScope string

TargetScope enumerates the values for target scope. 

const (
	// ManagementGroup ...
	ManagementGroup TargetScope = "managementGroup"
	// Subscription ...
	Subscription TargetScope = "subscription"
)

func PossibleTargetScopeValues 

func PossibleTargetScopeValues() []TargetScope

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

type TemplateArtifact 

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

TemplateArtifact blueprint artifact deploys Azure resource manager template.

func (TemplateArtifact) AsArtifact 

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

AsArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsBasicArtifact 

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

AsBasicArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsPolicyAssignmentArtifact 

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

AsPolicyAssignmentArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsRoleAssignmentArtifact 

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

AsRoleAssignmentArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) AsTemplateArtifact 

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

AsTemplateArtifact is the BasicArtifact implementation for TemplateArtifact.

func (TemplateArtifact) MarshalJSON 

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

MarshalJSON is the custom marshaler for TemplateArtifact.

func (*TemplateArtifact) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for TemplateArtifact struct.

type TemplateArtifactProperties 

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 Azure Resource Manager template body.
	Template interface{} `json:"template,omitempty"`
	// ResourceGroup - If applicable, the name of the resource group placeholder to which the template will be deployed.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
	// Parameters - Template parameter values.
	Parameters map[string]*ParameterValueBase `json:"parameters"`
}

TemplateArtifactProperties properties of a Template Artifact.

func (TemplateArtifactProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for TemplateArtifactProperties.

type TemplateParameterType 

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 

func PossibleTemplateParameterTypeValues() []TemplateParameterType

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

type TrackedResource 

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

TrackedResource common properties for all Azure tracked resources.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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