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/migrate/2020-07-07/hypervcluster
Documentation
The hypervcluster
SDK allows for interaction with the Azure Resource Manager Service migrate
(API Version 2020-07-07
).
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/migrate/2020-07-07/hypervcluster"
Client Initialization
client := hypervcluster.NewHyperVClusterClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: HyperVClusterClient.GetAllClustersInSite
ctx := context.TODO()
id := hypervcluster.NewHyperVSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hyperVSiteValue")
// alternatively `client.GetAllClustersInSite(ctx, id, hypervcluster.DefaultGetAllClustersInSiteOperationOptions())` can be used to do batched pagination
items, err := client.GetAllClustersInSiteComplete(ctx, id, hypervcluster.DefaultGetAllClustersInSiteOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: HyperVClusterClient.GetCluster
ctx := context.TODO()
id := hypervcluster.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hyperVSiteValue", "clusterValue")
read, err := client.GetCluster(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: HyperVClusterClient.PutCluster
ctx := context.TODO()
id := hypervcluster.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hyperVSiteValue", "clusterValue")
payload := hypervcluster.HyperVCluster{
// ...
}
read, err := client.PutCluster(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
NewClusterID returns a new ClusterId struct.
No description provided by the author
NewHyperVSiteID returns a new HyperVSiteId 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.
ParseHyperVSiteID parses 'input' into a HyperVSiteId.
ParseHyperVSiteIDInsensitively parses 'input' case-insensitively into a HyperVSiteId 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.
ValidateHyperVSiteID checks that 'input' can be parsed as a Hyper V Site 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
No description provided by the author
HyperVSiteId is a struct representing the Resource ID for a Hyper V Site.
No description provided by the author