connectivityconfigurations

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: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-03-01/connectivityconfigurations Documentation

The connectivityconfigurations SDK allows for interaction with Azure Resource Manager network (API Version 2024-03-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/2024-03-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", "networkManagerName", "connectivityConfigurationName")

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", "networkManagerName", "connectivityConfigurationName")

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", "networkManagerName", "connectivityConfigurationName")

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", "networkManagerName")

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

func (id ConnectivityConfigurationId) ID() string

ID returns the formatted Connectivity Configuration ID

func (ConnectivityConfigurationId) Segments 

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

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 

func (p ConnectivityConfigurationOperationPredicate) Matches(input ConnectivityConfiguration) bool

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 

func (c ConnectivityConfigurationsClient) CreateOrUpdate(ctx context.Context, id ConnectivityConfigurationId, input ConnectivityConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ConnectivityConfigurationsClient) Delete 

func (c ConnectivityConfigurationsClient) Delete(ctx context.Context, id ConnectivityConfigurationId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (ConnectivityConfigurationsClient) DeleteThenPoll 

func (c ConnectivityConfigurationsClient) DeleteThenPoll(ctx context.Context, id ConnectivityConfigurationId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (ConnectivityConfigurationsClient) Get 

func (c ConnectivityConfigurationsClient) Get(ctx context.Context, id ConnectivityConfigurationId) (result GetOperationResponse, err error)

Get ...

func (ConnectivityConfigurationsClient) List 

func (c ConnectivityConfigurationsClient) List(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (ConnectivityConfigurationsClient) ListComplete 

func (c ConnectivityConfigurationsClient) ListComplete(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ConnectivityConfigurationsClient) ListCompleteMatchingPredicate 

func (c ConnectivityConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkManagerId, options ListOperationOptions, predicate ConnectivityConfigurationOperationPredicate) (result ListCompleteResult, err error)

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 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

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 ListCustomPager 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

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 

func (o ListOperationOptions) ToQuery() *client.QueryParams

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.