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/web/2016-06-01/connectiongateways
Documentation
The connectiongateways
SDK allows for interaction with the Azure Resource Manager Service web
(API Version 2016-06-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/web/2016-06-01/connectiongateways"
Client Initialization
client := connectiongateways.NewConnectionGatewaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ConnectionGatewaysClient.ConnectionGatewayInstallationsGet
ctx := context.TODO()
id := connectiongateways.NewConnectionGatewayInstallationID("12345678-1234-9876-4563-123456789012", "locationValue", "gatewayIdValue")
read, err := client.ConnectionGatewayInstallationsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionGatewaysClient.ConnectionGatewayInstallationsList
ctx := context.TODO()
id := connectiongateways.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")
read, err := client.ConnectionGatewayInstallationsList(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionGatewaysClient.ConnectionGatewaysCreateOrUpdate
ctx := context.TODO()
id := connectiongateways.NewConnectionGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectionGatewayValue")
payload := connectiongateways.ConnectionGatewayDefinition{
// ...
}
read, err := client.ConnectionGatewaysCreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionGatewaysClient.ConnectionGatewaysDelete
ctx := context.TODO()
id := connectiongateways.NewConnectionGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectionGatewayValue")
read, err := client.ConnectionGatewaysDelete(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionGatewaysClient.ConnectionGatewaysGet
ctx := context.TODO()
id := connectiongateways.NewConnectionGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectionGatewayValue")
read, err := client.ConnectionGatewaysGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionGatewaysClient.ConnectionGatewaysList
ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
read, err := client.ConnectionGatewaysList(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionGatewaysClient.ConnectionGatewaysListByResourceGroup
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
read, err := client.ConnectionGatewaysListByResourceGroup(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionGatewaysClient.ConnectionGatewaysUpdate
ctx := context.TODO()
id := connectiongateways.NewConnectionGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectionGatewayValue")
payload := connectiongateways.ConnectionGatewayDefinition{
// ...
}
read, err := client.ConnectionGatewaysUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
# Functions
NewConnectionGatewayID returns a new ConnectionGatewayId struct.
NewConnectionGatewayInstallationID returns a new ConnectionGatewayInstallationId struct.
No description provided by the author
NewLocationID returns a new LocationId struct.
ParseConnectionGatewayID parses 'input' into a ConnectionGatewayId.
ParseConnectionGatewayIDInsensitively parses 'input' case-insensitively into a ConnectionGatewayId note: this method should only be used for API response data and not user input.
ParseConnectionGatewayInstallationID parses 'input' into a ConnectionGatewayInstallationId.
ParseConnectionGatewayInstallationIDInsensitively parses 'input' case-insensitively into a ConnectionGatewayInstallationId note: this method should only be used for API response data and not user input.
ParseLocationID parses 'input' into a LocationId.
ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input.
ValidateConnectionGatewayID checks that 'input' can be parsed as a Connection Gateway ID.
ValidateConnectionGatewayInstallationID checks that 'input' can be parsed as a Connection Gateway Installation ID.
ValidateLocationID checks that 'input' can be parsed as a Location ID.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
ConnectionGatewayId is a struct representing the Resource ID for a Connection Gateway.
No description provided by the author
No description provided by the author
No description provided by the author
ConnectionGatewayInstallationId is a struct representing the Resource ID for a Connection Gateway Installation.
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
LocationId is a struct representing the Resource ID for a Location.