connectivityconfigurations

package
v0.20240425.1122754 Latest Latest
Warning

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

Go to latest
Published: Apr 25, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/connectivityconfigurations Documentation

The connectivityconfigurations SDK allows for interaction with the Azure Resource Manager Service network (API Version 2023-04-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/network/2023-04-01/connectivityconfigurations"

Client Initialization

client := connectivityconfigurations.NewConnectivityConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectivityConfigurationsClient.CreateOrUpdate

ctx := context.TODO()
id := connectivityconfigurations.NewConnectivityConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "connectivityConfigurationValue")

payload := connectivityconfigurations.ConnectivityConfiguration{
	// ...
}


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

Example Usage: ConnectivityConfigurationsClient.Delete

ctx := context.TODO()
id := connectivityconfigurations.NewConnectivityConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "connectivityConfigurationValue")

if err := client.DeleteThenPoll(ctx, id, connectivityconfigurations.DefaultDeleteOperationOptions()); err != nil {
	// handle the error
}

Example Usage: ConnectivityConfigurationsClient.Get

ctx := context.TODO()
id := connectivityconfigurations.NewConnectivityConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "connectivityConfigurationValue")

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: ConnectivityConfigurationsClient.List

ctx := context.TODO()
id := connectivityconfigurations.NewNetworkManagerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue")

// alternatively `client.List(ctx, id, connectivityconfigurations.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, connectivityconfigurations.DefaultListOperationOptions())
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 PossibleValuesForConnectivityTopology

func PossibleValuesForConnectivityTopology() []string

func PossibleValuesForDeleteExistingPeering

func PossibleValuesForDeleteExistingPeering() []string

func PossibleValuesForGroupConnectivity

func PossibleValuesForGroupConnectivity() []string

func PossibleValuesForIsGlobal

func PossibleValuesForIsGlobal() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForUseHubGateway

func PossibleValuesForUseHubGateway() []string

func ValidateConnectivityConfigurationID

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

ValidateConnectivityConfigurationID checks that 'input' can be parsed as a Connectivity Configuration ID

func ValidateNetworkManagerID

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

ValidateNetworkManagerID checks that 'input' can be parsed as a Network Manager ID

Types

type ConnectivityConfiguration

type ConnectivityConfiguration struct {
	Etag       *string                              `json:"etag,omitempty"`
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *ConnectivityConfigurationProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type ConnectivityConfigurationId

type ConnectivityConfigurationId struct {
	SubscriptionId                string
	ResourceGroupName             string
	NetworkManagerName            string
	ConnectivityConfigurationName string
}

ConnectivityConfigurationId is a struct representing the Resource ID for a Connectivity Configuration

func NewConnectivityConfigurationID

func NewConnectivityConfigurationID(subscriptionId string, resourceGroupName string, networkManagerName string, connectivityConfigurationName string) ConnectivityConfigurationId

NewConnectivityConfigurationID returns a new ConnectivityConfigurationId struct

func ParseConnectivityConfigurationID

func ParseConnectivityConfigurationID(input string) (*ConnectivityConfigurationId, error)

ParseConnectivityConfigurationID parses 'input' into a ConnectivityConfigurationId

func ParseConnectivityConfigurationIDInsensitively

func ParseConnectivityConfigurationIDInsensitively(input string) (*ConnectivityConfigurationId, error)

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

func (*ConnectivityConfigurationId) FromParseResult

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

func (ConnectivityConfigurationId) ID

ID returns the formatted Connectivity Configuration ID

func (ConnectivityConfigurationId) Segments

Segments returns a slice of Resource ID Segments which comprise this Connectivity Configuration ID

func (ConnectivityConfigurationId) String

func (id ConnectivityConfigurationId) String() string

String returns a human-readable description of this Connectivity Configuration ID

type ConnectivityConfigurationOperationPredicate

type ConnectivityConfigurationOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (ConnectivityConfigurationOperationPredicate) Matches

type ConnectivityConfigurationProperties

type ConnectivityConfigurationProperties struct {
	AppliesToGroups       []ConnectivityGroupItem `json:"appliesToGroups"`
	ConnectivityTopology  ConnectivityTopology    `json:"connectivityTopology"`
	DeleteExistingPeering *DeleteExistingPeering  `json:"deleteExistingPeering,omitempty"`
	Description           *string                 `json:"description,omitempty"`
	Hubs                  *[]Hub                  `json:"hubs,omitempty"`
	IsGlobal              *IsGlobal               `json:"isGlobal,omitempty"`
	ProvisioningState     *ProvisioningState      `json:"provisioningState,omitempty"`
	ResourceGuid          *string                 `json:"resourceGuid,omitempty"`
}

type ConnectivityConfigurationsClient

type ConnectivityConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewConnectivityConfigurationsClientWithBaseURI

func NewConnectivityConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectivityConfigurationsClient, error)

func (ConnectivityConfigurationsClient) CreateOrUpdate

CreateOrUpdate ...

func (ConnectivityConfigurationsClient) Delete

Delete ...

func (ConnectivityConfigurationsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ConnectivityConfigurationsClient) Get

Get ...

func (ConnectivityConfigurationsClient) List

List ...

func (ConnectivityConfigurationsClient) ListComplete

ListComplete retrieves all the results into a single object

func (ConnectivityConfigurationsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ConnectivityGroupItem

type ConnectivityGroupItem struct {
	GroupConnectivity GroupConnectivity `json:"groupConnectivity"`
	IsGlobal          *IsGlobal         `json:"isGlobal,omitempty"`
	NetworkGroupId    string            `json:"networkGroupId"`
	UseHubGateway     *UseHubGateway    `json:"useHubGateway,omitempty"`
}

type ConnectivityTopology

type ConnectivityTopology string
const (
	ConnectivityTopologyHubAndSpoke ConnectivityTopology = "HubAndSpoke"
	ConnectivityTopologyMesh        ConnectivityTopology = "Mesh"
)

func (*ConnectivityTopology) UnmarshalJSON

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

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectivityConfiguration
}

type DeleteExistingPeering

type DeleteExistingPeering string
const (
	DeleteExistingPeeringFalse DeleteExistingPeering = "False"
	DeleteExistingPeeringTrue  DeleteExistingPeering = "True"
)

func (*DeleteExistingPeering) UnmarshalJSON

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

type DeleteOperationOptions

type DeleteOperationOptions struct {
	Force *bool
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectivityConfiguration
}

type GroupConnectivity

type GroupConnectivity string
const (
	GroupConnectivityDirectlyConnected GroupConnectivity = "DirectlyConnected"
	GroupConnectivityNone              GroupConnectivity = "None"
)

func (*GroupConnectivity) UnmarshalJSON

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

type Hub

type Hub struct {
	ResourceId   *string `json:"resourceId,omitempty"`
	ResourceType *string `json:"resourceType,omitempty"`
}

type IsGlobal

type IsGlobal string
const (
	IsGlobalFalse IsGlobal = "False"
	IsGlobalTrue  IsGlobal = "True"
)

func (*IsGlobal) UnmarshalJSON

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ConnectivityConfiguration
}

type ListOperationOptions

type ListOperationOptions struct {
	Top *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConnectivityConfiguration
}

type NetworkManagerId

type NetworkManagerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetworkManagerName string
}

NetworkManagerId is a struct representing the Resource ID for a Network Manager

func NewNetworkManagerID

func NewNetworkManagerID(subscriptionId string, resourceGroupName string, networkManagerName string) NetworkManagerId

NewNetworkManagerID returns a new NetworkManagerId struct

func ParseNetworkManagerID

func ParseNetworkManagerID(input string) (*NetworkManagerId, error)

ParseNetworkManagerID parses 'input' into a NetworkManagerId

func ParseNetworkManagerIDInsensitively

func ParseNetworkManagerIDInsensitively(input string) (*NetworkManagerId, error)

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

func (*NetworkManagerId) FromParseResult

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

func (NetworkManagerId) ID

func (id NetworkManagerId) ID() string

ID returns the formatted Network Manager ID

func (NetworkManagerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Network Manager ID

func (NetworkManagerId) String

func (id NetworkManagerId) String() string

String returns a human-readable description of this Network Manager ID

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

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

type UseHubGateway

type UseHubGateway string
const (
	UseHubGatewayFalse UseHubGateway = "False"
	UseHubGatewayTrue  UseHubGateway = "True"
)

func (*UseHubGateway) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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