templatespecversions

package
v0.20240117.1113630 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2022-02-01/templatespecversions Documentation

The templatespecversions SDK allows for interaction with the Azure Resource Manager Service resources (API Version 2022-02-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2022-02-01/templatespecversions"

Client Initialization

client := templatespecversions.NewTemplateSpecVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TemplateSpecVersionsClient.CreateOrUpdate

ctx := context.TODO()
id := templatespecversions.NewTemplateSpecVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue", "versionValue")

payload := templatespecversions.TemplateSpecVersion{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TemplateSpecVersionsClient.Delete

ctx := context.TODO()
id := templatespecversions.NewTemplateSpecVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue", "versionValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TemplateSpecVersionsClient.Get

ctx := context.TODO()
id := templatespecversions.NewTemplateSpecVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue", "versionValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TemplateSpecVersionsClient.GetBuiltIn

ctx := context.TODO()
id := templatespecversions.NewVersionID("builtInTemplateSpecValue", "versionValue")

read, err := client.GetBuiltIn(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TemplateSpecVersionsClient.List

ctx := context.TODO()
id := templatespecversions.NewTemplateSpecID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: TemplateSpecVersionsClient.ListBuiltIns

ctx := context.TODO()
id := templatespecversions.NewBuiltInTemplateSpecID("builtInTemplateSpecValue")

// alternatively `client.ListBuiltIns(ctx, id)` can be used to do batched pagination
items, err := client.ListBuiltInsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: TemplateSpecVersionsClient.Update

ctx := context.TODO()
id := templatespecversions.NewTemplateSpecVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue", "versionValue")

payload := templatespecversions.TemplateSpecVersionUpdateModel{
	// ...
}


read, err := client.Update(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateBuiltInTemplateSpecID 

func ValidateBuiltInTemplateSpecID(input interface{}, key string) (warnings []string, errors []error)

ValidateBuiltInTemplateSpecID checks that 'input' can be parsed as a Built In Template Spec ID

func ValidateTemplateSpecID 

func ValidateTemplateSpecID(input interface{}, key string) (warnings []string, errors []error)

ValidateTemplateSpecID checks that 'input' can be parsed as a Template Spec ID

func ValidateTemplateSpecVersionID 

func ValidateTemplateSpecVersionID(input interface{}, key string) (warnings []string, errors []error)

ValidateTemplateSpecVersionID checks that 'input' can be parsed as a Template Spec Version ID

func ValidateVersionID 

func ValidateVersionID(input interface{}, key string) (warnings []string, errors []error)

ValidateVersionID checks that 'input' can be parsed as a Version ID

Types

type BuiltInTemplateSpecId 

type BuiltInTemplateSpecId struct {
	BuiltInTemplateSpecName string
}

BuiltInTemplateSpecId is a struct representing the Resource ID for a Built In Template Spec

func NewBuiltInTemplateSpecID 

func NewBuiltInTemplateSpecID(builtInTemplateSpecName string) BuiltInTemplateSpecId

NewBuiltInTemplateSpecID returns a new BuiltInTemplateSpecId struct

func ParseBuiltInTemplateSpecID 

func ParseBuiltInTemplateSpecID(input string) (*BuiltInTemplateSpecId, error)

ParseBuiltInTemplateSpecID parses 'input' into a BuiltInTemplateSpecId

func ParseBuiltInTemplateSpecIDInsensitively 

func ParseBuiltInTemplateSpecIDInsensitively(input string) (*BuiltInTemplateSpecId, error)

ParseBuiltInTemplateSpecIDInsensitively parses 'input' case-insensitively into a BuiltInTemplateSpecId note: this method should only be used for API response data and not user input

func (*BuiltInTemplateSpecId) FromParseResult added in v0.20231127.1171502 

func (id *BuiltInTemplateSpecId) FromParseResult(input resourceids.ParseResult) error

func (BuiltInTemplateSpecId) ID 

func (id BuiltInTemplateSpecId) ID() string

ID returns the formatted Built In Template Spec ID

func (BuiltInTemplateSpecId) Segments 

func (id BuiltInTemplateSpecId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Built In Template Spec ID

func (BuiltInTemplateSpecId) String 

func (id BuiltInTemplateSpecId) String() string

String returns a human-readable description of this Built In Template Spec ID

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TemplateSpecVersion
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetBuiltInOperationResponse 

type GetBuiltInOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TemplateSpecVersion
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TemplateSpecVersion
}

type LinkedTemplateArtifact 

type LinkedTemplateArtifact struct {
	Path     string      `json:"path"`
	Template interface{} `json:"template"`
}

type ListBuiltInsCompleteResult 

type ListBuiltInsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TemplateSpecVersion
}

type ListBuiltInsOperationResponse 

type ListBuiltInsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TemplateSpecVersion
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TemplateSpecVersion
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TemplateSpecVersion
}

type TemplateSpecId 

type TemplateSpecId struct {
	SubscriptionId    string
	ResourceGroupName string
	TemplateSpecName  string
}

TemplateSpecId is a struct representing the Resource ID for a Template Spec

func NewTemplateSpecID 

func NewTemplateSpecID(subscriptionId string, resourceGroupName string, templateSpecName string) TemplateSpecId

NewTemplateSpecID returns a new TemplateSpecId struct

func ParseTemplateSpecID 

func ParseTemplateSpecID(input string) (*TemplateSpecId, error)

ParseTemplateSpecID parses 'input' into a TemplateSpecId

func ParseTemplateSpecIDInsensitively 

func ParseTemplateSpecIDInsensitively(input string) (*TemplateSpecId, error)

ParseTemplateSpecIDInsensitively parses 'input' case-insensitively into a TemplateSpecId note: this method should only be used for API response data and not user input

func (*TemplateSpecId) FromParseResult added in v0.20231127.1171502 

func (id *TemplateSpecId) FromParseResult(input resourceids.ParseResult) error

func (TemplateSpecId) ID 

func (id TemplateSpecId) ID() string

ID returns the formatted Template Spec ID

func (TemplateSpecId) Segments 

func (id TemplateSpecId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Template Spec ID

func (TemplateSpecId) String 

func (id TemplateSpecId) String() string

String returns a human-readable description of this Template Spec ID

type TemplateSpecVersion 

type TemplateSpecVersion struct {
	Id         *string                       `json:"id,omitempty"`
	Location   string                        `json:"location"`
	Name       *string                       `json:"name,omitempty"`
	Properties TemplateSpecVersionProperties `json:"properties"`
	SystemData *systemdata.SystemData        `json:"systemData,omitempty"`
	Tags       *map[string]string            `json:"tags,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type TemplateSpecVersionId 

type TemplateSpecVersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	TemplateSpecName  string
	VersionName       string
}

TemplateSpecVersionId is a struct representing the Resource ID for a Template Spec Version

func NewTemplateSpecVersionID 

func NewTemplateSpecVersionID(subscriptionId string, resourceGroupName string, templateSpecName string, versionName string) TemplateSpecVersionId

NewTemplateSpecVersionID returns a new TemplateSpecVersionId struct

func ParseTemplateSpecVersionID 

func ParseTemplateSpecVersionID(input string) (*TemplateSpecVersionId, error)

ParseTemplateSpecVersionID parses 'input' into a TemplateSpecVersionId

func ParseTemplateSpecVersionIDInsensitively 

func ParseTemplateSpecVersionIDInsensitively(input string) (*TemplateSpecVersionId, error)

ParseTemplateSpecVersionIDInsensitively parses 'input' case-insensitively into a TemplateSpecVersionId note: this method should only be used for API response data and not user input

func (*TemplateSpecVersionId) FromParseResult added in v0.20231127.1171502 

func (id *TemplateSpecVersionId) FromParseResult(input resourceids.ParseResult) error

func (TemplateSpecVersionId) ID 

func (id TemplateSpecVersionId) ID() string

ID returns the formatted Template Spec Version ID

func (TemplateSpecVersionId) Segments 

func (id TemplateSpecVersionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Template Spec Version ID

func (TemplateSpecVersionId) String 

func (id TemplateSpecVersionId) String() string

String returns a human-readable description of this Template Spec Version ID

type TemplateSpecVersionOperationPredicate 

type TemplateSpecVersionOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (TemplateSpecVersionOperationPredicate) Matches 

func (p TemplateSpecVersionOperationPredicate) Matches(input TemplateSpecVersion) bool

type TemplateSpecVersionProperties 

type TemplateSpecVersionProperties struct {
	Description      *string                   `json:"description,omitempty"`
	LinkedTemplates  *[]LinkedTemplateArtifact `json:"linkedTemplates,omitempty"`
	MainTemplate     *interface{}              `json:"mainTemplate,omitempty"`
	Metadata         *interface{}              `json:"metadata,omitempty"`
	UiFormDefinition *interface{}              `json:"uiFormDefinition,omitempty"`
}

type TemplateSpecVersionUpdateModel 

type TemplateSpecVersionUpdateModel struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type TemplateSpecVersionsClient 

type TemplateSpecVersionsClient struct {
	Client *resourcemanager.Client
}

func NewTemplateSpecVersionsClientWithBaseURI 

func NewTemplateSpecVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*TemplateSpecVersionsClient, error)

func (TemplateSpecVersionsClient) CreateOrUpdate 

func (c TemplateSpecVersionsClient) CreateOrUpdate(ctx context.Context, id TemplateSpecVersionId, input TemplateSpecVersion) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TemplateSpecVersionsClient) Delete 

func (c TemplateSpecVersionsClient) Delete(ctx context.Context, id TemplateSpecVersionId) (result DeleteOperationResponse, err error)

Delete ...

func (TemplateSpecVersionsClient) Get 

func (c TemplateSpecVersionsClient) Get(ctx context.Context, id TemplateSpecVersionId) (result GetOperationResponse, err error)

Get ...

func (TemplateSpecVersionsClient) GetBuiltIn 

func (c TemplateSpecVersionsClient) GetBuiltIn(ctx context.Context, id VersionId) (result GetBuiltInOperationResponse, err error)

GetBuiltIn ...

func (TemplateSpecVersionsClient) List 

func (c TemplateSpecVersionsClient) List(ctx context.Context, id TemplateSpecId) (result ListOperationResponse, err error)

List ...

func (TemplateSpecVersionsClient) ListBuiltIns 

func (c TemplateSpecVersionsClient) ListBuiltIns(ctx context.Context, id BuiltInTemplateSpecId) (result ListBuiltInsOperationResponse, err error)

ListBuiltIns ...

func (TemplateSpecVersionsClient) ListBuiltInsComplete 

func (c TemplateSpecVersionsClient) ListBuiltInsComplete(ctx context.Context, id BuiltInTemplateSpecId) (ListBuiltInsCompleteResult, error)

ListBuiltInsComplete retrieves all the results into a single object

func (TemplateSpecVersionsClient) ListBuiltInsCompleteMatchingPredicate 

func (c TemplateSpecVersionsClient) ListBuiltInsCompleteMatchingPredicate(ctx context.Context, id BuiltInTemplateSpecId, predicate TemplateSpecVersionOperationPredicate) (result ListBuiltInsCompleteResult, err error)

ListBuiltInsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TemplateSpecVersionsClient) ListComplete 

func (c TemplateSpecVersionsClient) ListComplete(ctx context.Context, id TemplateSpecId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (TemplateSpecVersionsClient) ListCompleteMatchingPredicate 

func (c TemplateSpecVersionsClient) ListCompleteMatchingPredicate(ctx context.Context, id TemplateSpecId, predicate TemplateSpecVersionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TemplateSpecVersionsClient) Update 

func (c TemplateSpecVersionsClient) Update(ctx context.Context, id TemplateSpecVersionId, input TemplateSpecVersionUpdateModel) (result UpdateOperationResponse, err error)

Update ...

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TemplateSpecVersion
}

type VersionId 

type VersionId struct {
	BuiltInTemplateSpecName string
	VersionName             string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID 

func NewVersionID(builtInTemplateSpecName string, versionName string) VersionId

NewVersionID returns a new VersionId struct

func ParseVersionID 

func ParseVersionID(input string) (*VersionId, error)

ParseVersionID parses 'input' into a VersionId

func ParseVersionIDInsensitively 

func ParseVersionIDInsensitively(input string) (*VersionId, error)

ParseVersionIDInsensitively parses 'input' case-insensitively into a VersionId note: this method should only be used for API response data and not user input

func (*VersionId) FromParseResult added in v0.20231127.1171502 

func (id *VersionId) FromParseResult(input resourceids.ParseResult) error

func (VersionId) ID 

func (id VersionId) ID() string

ID returns the formatted Version ID

func (VersionId) Segments 

func (id VersionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Version ID

func (VersionId) String 

func (id VersionId) String() string

String returns a human-readable description of this Version ID

Source Files

View all Source files

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.