Documentation ¶
Overview ¶
Package templatespecs implements the Azure ARM Templatespecs service API version 2019-06-01-preview.
The APIs listed in this specification can be used to manage Template Spec resources through the Azure Resource Manager.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type Artifact
- type AzureResourceBase
- type BaseClient
- type BasicArtifact
- type Client
- func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (result TemplateSpec, err error)
- func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (*http.Request, error)
- func (client Client) CreateOrUpdateResponder(resp *http.Response) (result TemplateSpec, err error)
- func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client Client) Delete(ctx context.Context, resourceGroupName string, templateSpecName string) (result autorest.Response, err error)
- func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, templateSpecName string) (*http.Request, error)
- func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) DeleteSender(req *http.Request) (*http.Response, error)
- func (client Client) Get(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (result TemplateSpec, err error)
- func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (*http.Request, error)
- func (client Client) GetResponder(resp *http.Response) (result TemplateSpec, err error)
- func (client Client) GetSender(req *http.Request) (*http.Response, error)
- func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand TemplateSpecExpandKind) (result ListResultPage, err error)
- func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expand TemplateSpecExpandKind) (result ListResultIterator, err error)
- func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, expand TemplateSpecExpandKind) (*http.Request, error)
- func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client Client) ListBySubscription(ctx context.Context, expand TemplateSpecExpandKind) (result ListResultPage, err error)
- func (client Client) ListBySubscriptionComplete(ctx context.Context, expand TemplateSpecExpandKind) (result ListResultIterator, err error)
- func (client Client) ListBySubscriptionPreparer(ctx context.Context, expand TemplateSpecExpandKind) (*http.Request, error)
- func (client Client) ListBySubscriptionResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client Client) Update(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (result TemplateSpec, err error)
- func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (*http.Request, error)
- func (client Client) UpdateResponder(resp *http.Response) (result TemplateSpec, err error)
- func (client Client) UpdateSender(req *http.Request) (*http.Response, error)
- type CreatedByType
- type Error
- type ErrorAdditionalInfo
- type ErrorResponse
- type Kind
- type ListResult
- type ListResultIterator
- type ListResultPage
- type Properties
- type SystemData
- type TemplateArtifact
- type TemplateSpec
- type TemplateSpecExpandKind
- type UpdateModel
- type VersionInfo
- type VersionProperties
- type VersionTemplatespecs
- type VersionUpdateModel
- type VersionsClient
- func (client VersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (result VersionTemplatespecs, err error)
- func (client VersionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (*http.Request, error)
- func (client VersionsClient) CreateOrUpdateResponder(resp *http.Response) (result VersionTemplatespecs, err error)
- func (client VersionsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client VersionsClient) Delete(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (result autorest.Response, err error)
- func (client VersionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (*http.Request, error)
- func (client VersionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client VersionsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client VersionsClient) Get(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (result VersionTemplatespecs, err error)
- func (client VersionsClient) GetPreparer(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (*http.Request, error)
- func (client VersionsClient) GetResponder(resp *http.Response) (result VersionTemplatespecs, err error)
- func (client VersionsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client VersionsClient) List(ctx context.Context, resourceGroupName string, templateSpecName string) (result VersionsListResultPage, err error)
- func (client VersionsClient) ListComplete(ctx context.Context, resourceGroupName string, templateSpecName string) (result VersionsListResultIterator, err error)
- func (client VersionsClient) ListPreparer(ctx context.Context, resourceGroupName string, templateSpecName string) (*http.Request, error)
- func (client VersionsClient) ListResponder(resp *http.Response) (result VersionsListResult, err error)
- func (client VersionsClient) ListSender(req *http.Request) (*http.Response, error)
- func (client VersionsClient) Update(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (result VersionTemplatespecs, err error)
- func (client VersionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, ...) (*http.Request, error)
- func (client VersionsClient) UpdateResponder(resp *http.Response) (result VersionTemplatespecs, err error)
- func (client VersionsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type VersionsListResult
- type VersionsListResultIterator
- func (iter *VersionsListResultIterator) Next() error
- func (iter *VersionsListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter VersionsListResultIterator) NotDone() bool
- func (iter VersionsListResultIterator) Response() VersionsListResult
- func (iter VersionsListResultIterator) Value() VersionTemplatespecs
- type VersionsListResultPage
- func (page *VersionsListResultPage) Next() error
- func (page *VersionsListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page VersionsListResultPage) NotDone() bool
- func (page VersionsListResultPage) Response() VersionsListResult
- func (page VersionsListResultPage) Values() []VersionTemplatespecs
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Templatespecs
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 { // Path - A filesystem safe relative path of the artifact. Path *string `json:"path,omitempty"` // Kind - Possible values include: 'KindTemplateSpecArtifact', 'KindTemplate' Kind Kind `json:"kind,omitempty"` }
Artifact represents a Template Spec artifact.
func (Artifact) AsArtifact ¶
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) AsTemplateArtifact ¶
func (a Artifact) AsTemplateArtifact() (*TemplateArtifact, bool)
AsTemplateArtifact is the BasicArtifact implementation for Artifact.
func (Artifact) MarshalJSON ¶
MarshalJSON is the custom marshaler for Artifact.
type AzureResourceBase ¶
type AzureResourceBase struct { // ID - READ-ONLY; String Id used to locate any resource on Azure. ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of this resource. Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of this resource. Type *string `json:"type,omitempty"` // SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData *SystemData `json:"systemData,omitempty"` }
AzureResourceBase common properties for all Azure resources.
type BaseClient ¶
BaseClient is the base client for Templatespecs.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type BasicArtifact ¶
type BasicArtifact interface { AsTemplateArtifact() (*TemplateArtifact, bool) AsArtifact() (*Artifact, bool) }
BasicArtifact represents a Template Spec artifact.
type Client ¶
type Client struct {
BaseClient
}
Client is the the APIs listed in this specification can be used to manage Template Spec resources through the Azure Resource Manager.
func NewClientWithBaseURI ¶
NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (Client) CreateOrUpdate ¶
func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpec TemplateSpec) (result TemplateSpec, err error)
CreateOrUpdate creates or updates a Template Spec. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec. templateSpec - template Spec supplied to the operation.
func (Client) CreateOrUpdatePreparer ¶
func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpec TemplateSpec) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (Client) CreateOrUpdateResponder ¶
func (client Client) CreateOrUpdateResponder(resp *http.Response) (result TemplateSpec, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (Client) CreateOrUpdateSender ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (Client) Delete ¶
func (client Client) Delete(ctx context.Context, resourceGroupName string, templateSpecName string) (result autorest.Response, err error)
Delete deletes a Template Spec by name. When operation completes, status code 200 returned without content. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec.
func (Client) DeletePreparer ¶
func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, templateSpecName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (Client) DeleteResponder ¶
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (Client) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (Client) Get ¶
func (client Client) Get(ctx context.Context, resourceGroupName string, templateSpecName string, expand TemplateSpecExpandKind) (result TemplateSpec, err error)
Get gets a Template Spec with a given name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec. expand - allows for expansion of additional Template Spec details in the response. Optional.
func (Client) GetPreparer ¶
func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, templateSpecName string, expand TemplateSpecExpandKind) (*http.Request, error)
GetPreparer prepares the Get request.
func (Client) GetResponder ¶
func (client Client) GetResponder(resp *http.Response) (result TemplateSpec, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (Client) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (Client) ListByResourceGroup ¶
func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand TemplateSpecExpandKind) (result ListResultPage, err error)
ListByResourceGroup lists all the Template Specs within the specified resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. expand - allows for expansion of additional Template Spec details in the response. Optional.
func (Client) ListByResourceGroupComplete ¶
func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expand TemplateSpecExpandKind) (result ListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (Client) ListByResourceGroupPreparer ¶
func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, expand TemplateSpecExpandKind) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (Client) ListByResourceGroupResponder ¶
func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (Client) ListByResourceGroupSender ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (Client) ListBySubscription ¶
func (client Client) ListBySubscription(ctx context.Context, expand TemplateSpecExpandKind) (result ListResultPage, err error)
ListBySubscription lists all the Template Specs within the specified subscriptions. Parameters: expand - allows for expansion of additional Template Spec details in the response. Optional.
func (Client) ListBySubscriptionComplete ¶
func (client Client) ListBySubscriptionComplete(ctx context.Context, expand TemplateSpecExpandKind) (result ListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (Client) ListBySubscriptionPreparer ¶
func (client Client) ListBySubscriptionPreparer(ctx context.Context, expand TemplateSpecExpandKind) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (Client) ListBySubscriptionResponder ¶
func (client Client) ListBySubscriptionResponder(resp *http.Response) (result ListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (Client) ListBySubscriptionSender ¶
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (Client) Update ¶
func (client Client) Update(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpec *UpdateModel) (result TemplateSpec, err error)
Update updates Template Spec tags with specified values. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec. templateSpec - template Spec resource with the tags to be updated.
func (Client) UpdatePreparer ¶
func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpec *UpdateModel) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (Client) UpdateResponder ¶
func (client Client) UpdateResponder(resp *http.Response) (result TemplateSpec, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
type CreatedByType ¶
type CreatedByType string
CreatedByType enumerates the values for created by type.
const ( // Application ... Application CreatedByType = "Application" // Key ... Key CreatedByType = "Key" // ManagedIdentity ... ManagedIdentity CreatedByType = "ManagedIdentity" // User ... User CreatedByType = "User" )
func PossibleCreatedByTypeValues ¶
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.
type Error ¶
type Error struct {
Error *ErrorResponse `json:"error,omitempty"`
}
Error template Specs error response.
type ErrorAdditionalInfo ¶
type ErrorAdditionalInfo struct { // Type - READ-ONLY; The additional info type. Type *string `json:"type,omitempty"` // Info - READ-ONLY; The additional info. Info interface{} `json:"info,omitempty"` }
ErrorAdditionalInfo the resource management error additional info.
type ErrorResponse ¶
type ErrorResponse struct { // Code - READ-ONLY; The error code. Code *string `json:"code,omitempty"` // Message - READ-ONLY; The error message. Message *string `json:"message,omitempty"` // Target - READ-ONLY; The error target. Target *string `json:"target,omitempty"` // Details - READ-ONLY; The error details. Details *[]ErrorResponse `json:"details,omitempty"` // AdditionalInfo - READ-ONLY; The error additional info. AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"` }
ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
type Kind ¶
type Kind string
Kind enumerates the values for kind.
func PossibleKindValues ¶
func PossibleKindValues() []Kind
PossibleKindValues returns an array of possible values for the Kind const type.
type ListResult ¶
type ListResult struct { autorest.Response `json:"-"` // Value - An array of Template Specs. Value *[]TemplateSpec `json:"value,omitempty"` // NextLink - READ-ONLY; The URL to use for getting the next set of results. NextLink *string `json:"nextLink,omitempty"` }
ListResult list of Template Specs.
func (ListResult) IsEmpty ¶
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ListResult) MarshalJSON ¶
func (lr ListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListResult.
type ListResultIterator ¶
type ListResultIterator struct {
// contains filtered or unexported fields
}
ListResultIterator provides access to a complete listing of TemplateSpec values.
func NewListResultIterator ¶
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
func (*ListResultIterator) Next ¶
func (iter *ListResultIterator) 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 (*ListResultIterator) NextWithContext ¶
func (iter *ListResultIterator) 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 (ListResultIterator) NotDone ¶
func (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ListResultIterator) Response ¶
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
func (ListResultIterator) Value ¶
func (iter ListResultIterator) Value() TemplateSpec
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListResultPage ¶
type ListResultPage struct {
// contains filtered or unexported fields
}
ListResultPage contains a page of TemplateSpec values.
func NewListResultPage ¶
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
func (*ListResultPage) Next ¶
func (page *ListResultPage) 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 (*ListResultPage) NextWithContext ¶
func (page *ListResultPage) 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 (ListResultPage) NotDone ¶
func (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ListResultPage) Response ¶
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (ListResultPage) Values ¶
func (page ListResultPage) Values() []TemplateSpec
Values returns the slice of values for the current page or nil if there are no values.
type Properties ¶
type Properties struct { // Description - Template Spec description. Description *string `json:"description,omitempty"` // DisplayName - Template Spec display name. DisplayName *string `json:"displayName,omitempty"` // Versions - READ-ONLY; High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. Versions map[string]*VersionInfo `json:"versions"` }
Properties template Spec properties.
func (Properties) MarshalJSON ¶
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
type SystemData ¶
type SystemData struct { // CreatedBy - The identity that created the resource. CreatedBy *string `json:"createdBy,omitempty"` // CreatedByType - The type of identity that created the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key' CreatedByType CreatedByType `json:"createdByType,omitempty"` // CreatedAt - The timestamp of resource creation (UTC). CreatedAt *date.Time `json:"createdAt,omitempty"` // LastModifiedBy - The identity that last modified the resource. LastModifiedBy *string `json:"lastModifiedBy,omitempty"` // LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key' LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"` // LastModifiedAt - The type of identity that last modified the resource. LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"` }
SystemData metadata pertaining to creation and last modification of the resource.
type TemplateArtifact ¶
type TemplateArtifact struct { // Template - The Azure Resource Manager template. Template interface{} `json:"template,omitempty"` // Path - A filesystem safe relative path of the artifact. Path *string `json:"path,omitempty"` // Kind - Possible values include: 'KindTemplateSpecArtifact', 'KindTemplate' Kind Kind `json:"kind,omitempty"` }
TemplateArtifact represents a Template Spec artifact containing an embedded 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) 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.
type TemplateSpec ¶
type TemplateSpec struct { autorest.Response `json:"-"` // Location - The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. Location *string `json:"location,omitempty"` // Properties - Template Spec properties. *Properties `json:"properties,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` // ID - READ-ONLY; String Id used to locate any resource on Azure. ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of this resource. Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of this resource. Type *string `json:"type,omitempty"` // SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData *SystemData `json:"systemData,omitempty"` }
TemplateSpec template Spec object.
func (TemplateSpec) MarshalJSON ¶
func (ts TemplateSpec) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TemplateSpec.
func (*TemplateSpec) UnmarshalJSON ¶
func (ts *TemplateSpec) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TemplateSpec struct.
type TemplateSpecExpandKind ¶
type TemplateSpecExpandKind string
TemplateSpecExpandKind enumerates the values for template spec expand kind.
const ( // Versions Includes version information with the Template Spec. Versions TemplateSpecExpandKind = "versions" )
func PossibleTemplateSpecExpandKindValues ¶
func PossibleTemplateSpecExpandKindValues() []TemplateSpecExpandKind
PossibleTemplateSpecExpandKindValues returns an array of possible values for the TemplateSpecExpandKind const type.
type UpdateModel ¶
type UpdateModel struct { // Tags - Resource tags. Tags map[string]*string `json:"tags"` // ID - READ-ONLY; String Id used to locate any resource on Azure. ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of this resource. Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of this resource. Type *string `json:"type,omitempty"` // SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData *SystemData `json:"systemData,omitempty"` }
UpdateModel template Spec properties to be updated (only tags are currently supported).
func (UpdateModel) MarshalJSON ¶
func (um UpdateModel) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateModel.
type VersionInfo ¶
type VersionInfo struct { // Description - READ-ONLY; Template Spec version description. Description *string `json:"description,omitempty"` // TimeCreated - READ-ONLY; The timestamp of when the version was created. TimeCreated *date.Time `json:"timeCreated,omitempty"` // TimeModified - READ-ONLY; The timestamp of when the version was last modified. TimeModified *date.Time `json:"timeModified,omitempty"` }
VersionInfo high-level information about a Template Spec version.
type VersionProperties ¶
type VersionProperties struct { // Artifacts - An array of Template Spec artifacts. Artifacts *[]BasicArtifact `json:"artifacts,omitempty"` // Description - Template Spec version description. Description *string `json:"description,omitempty"` // Template - The Azure Resource Manager template content. Template interface{} `json:"template,omitempty"` }
VersionProperties template Spec Version properties.
func (*VersionProperties) UnmarshalJSON ¶
func (vp *VersionProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VersionProperties struct.
type VersionTemplatespecs ¶
type VersionTemplatespecs struct { autorest.Response `json:"-"` // Location - The location of the Template Spec Version. It must match the location of the parent Template Spec. Location *string `json:"location,omitempty"` // VersionProperties - Template Spec Version properties. *VersionProperties `json:"properties,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` // ID - READ-ONLY; String Id used to locate any resource on Azure. ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of this resource. Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of this resource. Type *string `json:"type,omitempty"` // SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData *SystemData `json:"systemData,omitempty"` }
VersionTemplatespecs template Spec Version object.
func (VersionTemplatespecs) MarshalJSON ¶
func (vt VersionTemplatespecs) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VersionTemplatespecs.
func (*VersionTemplatespecs) UnmarshalJSON ¶
func (vt *VersionTemplatespecs) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VersionTemplatespecs struct.
type VersionUpdateModel ¶
type VersionUpdateModel struct { // Tags - Resource tags. Tags map[string]*string `json:"tags"` // ID - READ-ONLY; String Id used to locate any resource on Azure. ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of this resource. Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of this resource. Type *string `json:"type,omitempty"` // SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData *SystemData `json:"systemData,omitempty"` }
VersionUpdateModel template Spec Version properties to be updated (only tags are currently supported).
func (VersionUpdateModel) MarshalJSON ¶
func (vum VersionUpdateModel) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VersionUpdateModel.
type VersionsClient ¶
type VersionsClient struct {
BaseClient
}
VersionsClient is the the APIs listed in this specification can be used to manage Template Spec resources through the Azure Resource Manager.
func NewVersionsClient ¶
func NewVersionsClient(subscriptionID string) VersionsClient
NewVersionsClient creates an instance of the VersionsClient client.
func NewVersionsClientWithBaseURI ¶
func NewVersionsClientWithBaseURI(baseURI string, subscriptionID string) VersionsClient
NewVersionsClientWithBaseURI creates an instance of the VersionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (VersionsClient) CreateOrUpdate ¶
func (client VersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string, templateSpecVersionModel VersionTemplatespecs) (result VersionTemplatespecs, err error)
CreateOrUpdate creates or updates a Template Spec version. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec. templateSpecVersion - the version of the Template Spec. templateSpecVersionModel - template Spec Version supplied to the operation.
func (VersionsClient) CreateOrUpdatePreparer ¶
func (client VersionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string, templateSpecVersionModel VersionTemplatespecs) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (VersionsClient) CreateOrUpdateResponder ¶
func (client VersionsClient) CreateOrUpdateResponder(resp *http.Response) (result VersionTemplatespecs, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (VersionsClient) CreateOrUpdateSender ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (VersionsClient) Delete ¶
func (client VersionsClient) Delete(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string) (result autorest.Response, err error)
Delete deletes a specific version from a Template Spec. When operation completes, status code 200 returned without content. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec. templateSpecVersion - the version of the Template Spec.
func (VersionsClient) DeletePreparer ¶
func (client VersionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (VersionsClient) DeleteResponder ¶
func (client VersionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (VersionsClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (VersionsClient) Get ¶
func (client VersionsClient) Get(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string) (result VersionTemplatespecs, err error)
Get gets a Template Spec version from a specific Template Spec. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec. templateSpecVersion - the version of the Template Spec.
func (VersionsClient) GetPreparer ¶
func (client VersionsClient) GetPreparer(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string) (*http.Request, error)
GetPreparer prepares the Get request.
func (VersionsClient) GetResponder ¶
func (client VersionsClient) GetResponder(resp *http.Response) (result VersionTemplatespecs, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (VersionsClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (VersionsClient) List ¶
func (client VersionsClient) List(ctx context.Context, resourceGroupName string, templateSpecName string) (result VersionsListResultPage, err error)
List lists all the Template Spec versions in the specified Template Spec. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec.
func (VersionsClient) ListComplete ¶
func (client VersionsClient) ListComplete(ctx context.Context, resourceGroupName string, templateSpecName string) (result VersionsListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (VersionsClient) ListPreparer ¶
func (client VersionsClient) ListPreparer(ctx context.Context, resourceGroupName string, templateSpecName string) (*http.Request, error)
ListPreparer prepares the List request.
func (VersionsClient) ListResponder ¶
func (client VersionsClient) ListResponder(resp *http.Response) (result VersionsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (VersionsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (VersionsClient) Update ¶
func (client VersionsClient) Update(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string, templateSpecVersionUpdateModel *VersionUpdateModel) (result VersionTemplatespecs, err error)
Update updates Template Spec Version tags with specified values. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. templateSpecName - name of the Template Spec. templateSpecVersion - the version of the Template Spec. templateSpecVersionUpdateModel - template Spec Version resource with the tags to be updated.
func (VersionsClient) UpdatePreparer ¶
func (client VersionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, templateSpecName string, templateSpecVersion string, templateSpecVersionUpdateModel *VersionUpdateModel) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (VersionsClient) UpdateResponder ¶
func (client VersionsClient) UpdateResponder(resp *http.Response) (result VersionTemplatespecs, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (VersionsClient) UpdateSender ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type VersionsListResult ¶
type VersionsListResult struct { autorest.Response `json:"-"` // Value - An array of Template Spec versions. Value *[]VersionTemplatespecs `json:"value,omitempty"` // NextLink - READ-ONLY; The URL to use for getting the next set of results. NextLink *string `json:"nextLink,omitempty"` }
VersionsListResult list of Template Specs versions
func (VersionsListResult) IsEmpty ¶
func (vlr VersionsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (VersionsListResult) MarshalJSON ¶
func (vlr VersionsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VersionsListResult.
type VersionsListResultIterator ¶
type VersionsListResultIterator struct {
// contains filtered or unexported fields
}
VersionsListResultIterator provides access to a complete listing of VersionTemplatespecs values.
func NewVersionsListResultIterator ¶
func NewVersionsListResultIterator(page VersionsListResultPage) VersionsListResultIterator
Creates a new instance of the VersionsListResultIterator type.
func (*VersionsListResultIterator) Next ¶
func (iter *VersionsListResultIterator) 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 (*VersionsListResultIterator) NextWithContext ¶
func (iter *VersionsListResultIterator) 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 (VersionsListResultIterator) NotDone ¶
func (iter VersionsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (VersionsListResultIterator) Response ¶
func (iter VersionsListResultIterator) Response() VersionsListResult
Response returns the raw server response from the last page request.
func (VersionsListResultIterator) Value ¶
func (iter VersionsListResultIterator) Value() VersionTemplatespecs
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type VersionsListResultPage ¶
type VersionsListResultPage struct {
// contains filtered or unexported fields
}
VersionsListResultPage contains a page of VersionTemplatespecs values.
func NewVersionsListResultPage ¶
func NewVersionsListResultPage(cur VersionsListResult, getNextPage func(context.Context, VersionsListResult) (VersionsListResult, error)) VersionsListResultPage
Creates a new instance of the VersionsListResultPage type.
func (*VersionsListResultPage) Next ¶
func (page *VersionsListResultPage) 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 (*VersionsListResultPage) NextWithContext ¶
func (page *VersionsListResultPage) 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 (VersionsListResultPage) NotDone ¶
func (page VersionsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (VersionsListResultPage) Response ¶
func (page VersionsListResultPage) Response() VersionsListResult
Response returns the raw server response from the last page request.
func (VersionsListResultPage) Values ¶
func (page VersionsListResultPage) Values() []VersionTemplatespecs
Values returns the slice of values for the current page or nil if there are no values.