package
0.20240125.1100331
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# README
github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-08-01/offers
Documentation
The offers
SDK allows for interaction with the Azure Resource Manager Service azurestackhci
(API Version 2023-08-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/azurestackhci/2023-08-01/offers"
Client Initialization
client := offers.NewOffersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: OffersClient.Get
ctx := context.TODO()
id := offers.NewOfferID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "publisherValue", "offerValue")
read, err := client.Get(ctx, id, offers.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: OffersClient.ListByCluster
ctx := context.TODO()
id := offers.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")
// alternatively `client.ListByCluster(ctx, id, offers.DefaultListByClusterOperationOptions())` can be used to do batched pagination
items, err := client.ListByClusterComplete(ctx, id, offers.DefaultListByClusterOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: OffersClient.ListByPublisher
ctx := context.TODO()
id := offers.NewPublisherID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "publisherValue")
// alternatively `client.ListByPublisher(ctx, id, offers.DefaultListByPublisherOperationOptions())` can be used to do batched pagination
items, err := client.ListByPublisherComplete(ctx, id, offers.DefaultListByPublisherOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
NewClusterID returns a new ClusterId struct.
NewOfferID returns a new OfferId struct.
No description provided by the author
NewPublisherID returns a new PublisherId struct.
ParseClusterID parses 'input' into a ClusterId.
ParseClusterIDInsensitively parses 'input' case-insensitively into a ClusterId note: this method should only be used for API response data and not user input.
ParseOfferID parses 'input' into a OfferId.
ParseOfferIDInsensitively parses 'input' case-insensitively into a OfferId note: this method should only be used for API response data and not user input.
ParsePublisherID parses 'input' into a PublisherId.
ParsePublisherIDInsensitively parses 'input' case-insensitively into a PublisherId note: this method should only be used for API response data and not user input.
ValidateClusterID checks that 'input' can be parsed as a Cluster ID.
ValidateOfferID checks that 'input' can be parsed as a Offer ID.
ValidatePublisherID checks that 'input' can be parsed as a Publisher ID.
# Structs
ClusterId is a struct representing the Resource ID for a Cluster.
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
OfferId is a struct representing the Resource ID for a Offer.
No description provided by the author
No description provided by the author
No description provided by the author
PublisherId is a struct representing the Resource ID for a Publisher.
No description provided by the author