workloadnetworkgateways

package
v0.20241209.1115630 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 9, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-09-01/workloadnetworkgateways Documentation

The workloadnetworkgateways SDK allows for interaction with Azure Resource Manager 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/workloadnetworkgateways"

Client Initialization

client := workloadnetworkgateways.NewWorkloadNetworkGatewaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkloadNetworkGatewaysClient.WorkloadNetworksGetGateway

ctx := context.TODO()
id := workloadnetworkgateways.NewGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "gatewayId")

read, err := client.WorkloadNetworksGetGateway(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: WorkloadNetworkGatewaysClient.WorkloadNetworksListGateways

ctx := context.TODO()
id := workloadnetworkgateways.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName")

// alternatively `client.WorkloadNetworksListGateways(ctx, id)` can be used to do batched pagination
items, err := client.WorkloadNetworksListGatewaysComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForWorkloadNetworkProvisioningState

func PossibleValuesForWorkloadNetworkProvisioningState() []string

func ValidateGatewayID

func ValidateGatewayID(input interface{}, key string) (warnings []string, errors []error)

ValidateGatewayID checks that 'input' can be parsed as a Gateway ID

func ValidatePrivateCloudID

func ValidatePrivateCloudID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID

Types

type GatewayId

type GatewayId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
	GatewayId         string
}

GatewayId is a struct representing the Resource ID for a Gateway

func NewGatewayID

func NewGatewayID(subscriptionId string, resourceGroupName string, privateCloudName string, gatewayId string) GatewayId

NewGatewayID returns a new GatewayId struct

func ParseGatewayID

func ParseGatewayID(input string) (*GatewayId, error)

ParseGatewayID parses 'input' into a GatewayId

func ParseGatewayIDInsensitively

func ParseGatewayIDInsensitively(input string) (*GatewayId, error)

ParseGatewayIDInsensitively parses 'input' case-insensitively into a GatewayId note: this method should only be used for API response data and not user input

func (*GatewayId) FromParseResult

func (id *GatewayId) FromParseResult(input resourceids.ParseResult) error

func (GatewayId) ID

func (id GatewayId) ID() string

ID returns the formatted Gateway ID

func (GatewayId) Segments

func (id GatewayId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Gateway ID

func (GatewayId) String

func (id GatewayId) String() string

String returns a human-readable description of this Gateway ID

type PrivateCloudId

type PrivateCloudId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
}

PrivateCloudId is a struct representing the Resource ID for a Private Cloud

func NewPrivateCloudID

func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId

NewPrivateCloudID returns a new PrivateCloudId struct

func ParsePrivateCloudID

func ParsePrivateCloudID(input string) (*PrivateCloudId, error)

ParsePrivateCloudID parses 'input' into a PrivateCloudId

func ParsePrivateCloudIDInsensitively

func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)

ParsePrivateCloudIDInsensitively parses 'input' case-insensitively into a PrivateCloudId note: this method should only be used for API response data and not user input

func (*PrivateCloudId) FromParseResult

func (id *PrivateCloudId) FromParseResult(input resourceids.ParseResult) error

func (PrivateCloudId) ID

func (id PrivateCloudId) ID() string

ID returns the formatted Private Cloud ID

func (PrivateCloudId) Segments

func (id PrivateCloudId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Cloud ID

func (PrivateCloudId) String

func (id PrivateCloudId) String() string

String returns a human-readable description of this Private Cloud ID

type WorkloadNetworkGateway

type WorkloadNetworkGateway struct {
	Id         *string                           `json:"id,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *WorkloadNetworkGatewayProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData            `json:"systemData,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type WorkloadNetworkGatewayOperationPredicate

type WorkloadNetworkGatewayOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (WorkloadNetworkGatewayOperationPredicate) Matches

type WorkloadNetworkGatewayProperties

type WorkloadNetworkGatewayProperties struct {
	DisplayName       *string                           `json:"displayName,omitempty"`
	Path              *string                           `json:"path,omitempty"`
	ProvisioningState *WorkloadNetworkProvisioningState `json:"provisioningState,omitempty"`
}

type WorkloadNetworkGatewaysClient

type WorkloadNetworkGatewaysClient struct {
	Client *resourcemanager.Client
}

func NewWorkloadNetworkGatewaysClientWithBaseURI

func NewWorkloadNetworkGatewaysClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkloadNetworkGatewaysClient, error)

func (WorkloadNetworkGatewaysClient) WorkloadNetworksGetGateway

WorkloadNetworksGetGateway ...

func (WorkloadNetworkGatewaysClient) WorkloadNetworksListGateways

WorkloadNetworksListGateways ...

func (WorkloadNetworkGatewaysClient) WorkloadNetworksListGatewaysComplete

WorkloadNetworksListGatewaysComplete retrieves all the results into a single object

func (WorkloadNetworkGatewaysClient) WorkloadNetworksListGatewaysCompleteMatchingPredicate

func (c WorkloadNetworkGatewaysClient) WorkloadNetworksListGatewaysCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate WorkloadNetworkGatewayOperationPredicate) (result WorkloadNetworksListGatewaysCompleteResult, err error)

WorkloadNetworksListGatewaysCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkloadNetworkProvisioningState

type WorkloadNetworkProvisioningState string
const (
	WorkloadNetworkProvisioningStateBuilding  WorkloadNetworkProvisioningState = "Building"
	WorkloadNetworkProvisioningStateCanceled  WorkloadNetworkProvisioningState = "Canceled"
	WorkloadNetworkProvisioningStateDeleting  WorkloadNetworkProvisioningState = "Deleting"
	WorkloadNetworkProvisioningStateFailed    WorkloadNetworkProvisioningState = "Failed"
	WorkloadNetworkProvisioningStateSucceeded WorkloadNetworkProvisioningState = "Succeeded"
	WorkloadNetworkProvisioningStateUpdating  WorkloadNetworkProvisioningState = "Updating"
)

func (*WorkloadNetworkProvisioningState) UnmarshalJSON

func (s *WorkloadNetworkProvisioningState) UnmarshalJSON(bytes []byte) error

type WorkloadNetworksGetGatewayOperationResponse

type WorkloadNetworksGetGatewayOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkloadNetworkGateway
}

type WorkloadNetworksListGatewaysCompleteResult

type WorkloadNetworksListGatewaysCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WorkloadNetworkGateway
}

type WorkloadNetworksListGatewaysCustomPager added in v0.20240628.1153531

type WorkloadNetworksListGatewaysCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

type WorkloadNetworksListGatewaysOperationResponse

type WorkloadNetworksListGatewaysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WorkloadNetworkGateway
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL