globalreachconnections

package
v0.20221025.1104718 Latest Latest
Warning

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

Go to latest
Published: Oct 25, 2022 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2021-12-01/globalreachconnections Documentation

The globalreachconnections SDK allows for interaction with the Azure Resource Manager Service vmware (API Version 2021-12-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/2021-12-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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForGlobalReachConnectionProvisioningState

func PossibleValuesForGlobalReachConnectionProvisioningState() []string

func PossibleValuesForGlobalReachConnectionStatus

func PossibleValuesForGlobalReachConnectionStatus() []string

func ValidateGlobalReachConnectionID

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

ValidateGlobalReachConnectionID checks that 'input' can be parsed as a Global Reach Connection 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 CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *GlobalReachConnection
}

type GlobalReachConnection

type GlobalReachConnection struct {
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *GlobalReachConnectionProperties `json:"properties,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type GlobalReachConnectionId

type GlobalReachConnectionId struct {
	SubscriptionId            string
	ResourceGroupName         string
	PrivateCloudName          string
	GlobalReachConnectionName string
}

GlobalReachConnectionId is a struct representing the Resource ID for a Global Reach Connection

func NewGlobalReachConnectionID

func NewGlobalReachConnectionID(subscriptionId string, resourceGroupName string, privateCloudName string, globalReachConnectionName string) GlobalReachConnectionId

NewGlobalReachConnectionID returns a new GlobalReachConnectionId struct

func ParseGlobalReachConnectionID

func ParseGlobalReachConnectionID(input string) (*GlobalReachConnectionId, error)

ParseGlobalReachConnectionID parses 'input' into a GlobalReachConnectionId

func ParseGlobalReachConnectionIDInsensitively

func ParseGlobalReachConnectionIDInsensitively(input string) (*GlobalReachConnectionId, error)

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

func (GlobalReachConnectionId) ID

ID returns the formatted Global Reach Connection ID

func (GlobalReachConnectionId) Segments

Segments returns a slice of Resource ID Segments which comprise this Global Reach Connection ID

func (GlobalReachConnectionId) String

func (id GlobalReachConnectionId) String() string

String returns a human-readable description of this Global Reach Connection ID

type GlobalReachConnectionOperationPredicate

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

func (GlobalReachConnectionOperationPredicate) Matches

type GlobalReachConnectionProperties

type GlobalReachConnectionProperties struct {
	AddressPrefix           *string                                 `json:"addressPrefix,omitempty"`
	AuthorizationKey        *string                                 `json:"authorizationKey,omitempty"`
	CircuitConnectionStatus *GlobalReachConnectionStatus            `json:"circuitConnectionStatus,omitempty"`
	ExpressRouteId          *string                                 `json:"expressRouteId,omitempty"`
	PeerExpressRouteCircuit *string                                 `json:"peerExpressRouteCircuit,omitempty"`
	ProvisioningState       *GlobalReachConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type GlobalReachConnectionProvisioningState

type GlobalReachConnectionProvisioningState string
const (
	GlobalReachConnectionProvisioningStateFailed    GlobalReachConnectionProvisioningState = "Failed"
	GlobalReachConnectionProvisioningStateSucceeded GlobalReachConnectionProvisioningState = "Succeeded"
	GlobalReachConnectionProvisioningStateUpdating  GlobalReachConnectionProvisioningState = "Updating"
)

type GlobalReachConnectionStatus

type GlobalReachConnectionStatus string
const (
	GlobalReachConnectionStatusConnected    GlobalReachConnectionStatus = "Connected"
	GlobalReachConnectionStatusConnecting   GlobalReachConnectionStatus = "Connecting"
	GlobalReachConnectionStatusDisconnected GlobalReachConnectionStatus = "Disconnected"
)

type GlobalReachConnectionsClient

type GlobalReachConnectionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewGlobalReachConnectionsClientWithBaseURI

func NewGlobalReachConnectionsClientWithBaseURI(endpoint string) GlobalReachConnectionsClient

func (GlobalReachConnectionsClient) CreateOrUpdate

CreateOrUpdate ...

func (GlobalReachConnectionsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (GlobalReachConnectionsClient) Delete

Delete ...

func (GlobalReachConnectionsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (GlobalReachConnectionsClient) Get

Get ...

func (GlobalReachConnectionsClient) List

List ...

func (GlobalReachConnectionsClient) ListComplete

ListComplete retrieves all of the results into a single object

func (GlobalReachConnectionsClient) ListCompleteMatchingPredicate

func (c GlobalReachConnectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate GlobalReachConnectionOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type ListCompleteResult

type ListCompleteResult struct {
	Items []GlobalReachConnection
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]GlobalReachConnection
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

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) 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

Jump to

Keyboard shortcuts

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