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/vmware/2023-09-01/globalreachconnections
Documentation
The globalreachconnections
SDK allows for interaction with the Azure Resource Manager Service vmware
(API Version 2023-09-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/vmware/2023-09-01/globalreachconnections"
Client Initialization
client := globalreachconnections.NewGlobalReachConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: GlobalReachConnectionsClient.CreateOrUpdate
ctx := context.TODO()
id := globalreachconnections.NewGlobalReachConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "globalReachConnectionValue")
payload := globalreachconnections.GlobalReachConnection{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: GlobalReachConnectionsClient.Delete
ctx := context.TODO()
id := globalreachconnections.NewGlobalReachConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "globalReachConnectionValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: GlobalReachConnectionsClient.Get
ctx := context.TODO()
id := globalreachconnections.NewGlobalReachConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "globalReachConnectionValue")
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: GlobalReachConnectionsClient.List
ctx := context.TODO()
id := globalreachconnections.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")
// 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
}
# Functions
NewGlobalReachConnectionID returns a new GlobalReachConnectionId struct.
No description provided by the author
NewPrivateCloudID returns a new PrivateCloudId struct.
ParseGlobalReachConnectionID parses 'input' into a GlobalReachConnectionId.
ParseGlobalReachConnectionIDInsensitively parses 'input' case-insensitively into a GlobalReachConnectionId note: this method should only be used for API response data and not user input.
ParsePrivateCloudID parses 'input' into a PrivateCloudId.
ParsePrivateCloudIDInsensitively parses 'input' case-insensitively into a PrivateCloudId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
ValidateGlobalReachConnectionID checks that 'input' can be parsed as a Global Reach Connection ID.
ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID.
# Constants
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
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GlobalReachConnectionId is a struct representing the Resource ID for a Global Reach Connection.
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
PrivateCloudId is a struct representing the Resource ID for a Private Cloud.
# Type aliases
No description provided by the author
No description provided by the author