package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# README
github.com/hashicorp/go-azure-sdk/resource-manager/resources/2022-02-01/templatespecs
Documentation
The templatespecs
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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2022-02-01/templatespecs"
Client Initialization
client := templatespecs.NewTemplateSpecsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: TemplateSpecsClient.CreateOrUpdate
ctx := context.TODO()
id := templatespecs.NewTemplateSpecID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue")
payload := templatespecs.TemplateSpec{
// ...
}
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: TemplateSpecsClient.Delete
ctx := context.TODO()
id := templatespecs.NewTemplateSpecID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue")
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: TemplateSpecsClient.Get
ctx := context.TODO()
id := templatespecs.NewTemplateSpecID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue")
read, err := client.Get(ctx, id, templatespecs.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TemplateSpecsClient.GetBuiltIn
ctx := context.TODO()
id := templatespecs.NewBuiltInTemplateSpecID("builtInTemplateSpecValue")
read, err := client.GetBuiltIn(ctx, id, templatespecs.DefaultGetBuiltInOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TemplateSpecsClient.ListBuiltIns
ctx := context.TODO()
// alternatively `client.ListBuiltIns(ctx, templatespecs.DefaultListBuiltInsOperationOptions())` can be used to do batched pagination
items, err := client.ListBuiltInsComplete(ctx, templatespecs.DefaultListBuiltInsOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: TemplateSpecsClient.ListByResourceGroup
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.ListByResourceGroup(ctx, id, templatespecs.DefaultListByResourceGroupOperationOptions())` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id, templatespecs.DefaultListByResourceGroupOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: TemplateSpecsClient.ListBySubscription
ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.ListBySubscription(ctx, id, templatespecs.DefaultListBySubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id, templatespecs.DefaultListBySubscriptionOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: TemplateSpecsClient.Update
ctx := context.TODO()
id := templatespecs.NewTemplateSpecID("12345678-1234-9876-4563-123456789012", "example-resource-group", "templateSpecValue")
payload := templatespecs.TemplateSpecUpdateModel{
// ...
}
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
}
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewBuiltInTemplateSpecID returns a new BuiltInTemplateSpecId struct.
NewTemplateSpecID returns a new TemplateSpecId struct.
No description provided by the author
ParseBuiltInTemplateSpecID parses 'input' into a BuiltInTemplateSpecId.
ParseBuiltInTemplateSpecIDInsensitively parses 'input' case-insensitively into a BuiltInTemplateSpecId note: this method should only be used for API response data and not user input.
ParseTemplateSpecID parses 'input' into a TemplateSpecId.
ParseTemplateSpecIDInsensitively parses 'input' case-insensitively into a TemplateSpecId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateBuiltInTemplateSpecID checks that 'input' can be parsed as a Built In Template Spec ID.
ValidateTemplateSpecID checks that 'input' can be parsed as a Template Spec ID.
# Constants
No description provided by the author
# Structs
BuiltInTemplateSpecId is a struct representing the Resource ID for a Built In Template Spec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TemplateSpecId is a struct representing the Resource ID for a Template Spec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author