networkmanageractiveconnectivityconfigurations

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2022-07-01/networkmanageractiveconnectivityconfigurations Documentation

The networkmanageractiveconnectivityconfigurations SDK allows for interaction with Azure Resource Manager network (API Version 2022-07-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/2022-07-01/networkmanageractiveconnectivityconfigurations"

Client Initialization

client := networkmanageractiveconnectivityconfigurations.NewNetworkManagerActiveConnectivityConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkManagerActiveConnectivityConfigurationsClient.ListActiveConnectivityConfigurations

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

payload := networkmanageractiveconnectivityconfigurations.ActiveConfigurationParameter{
	// ...
}


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

Documentation

Index

• func PossibleValuesForConnectivityTopology() []string
• func PossibleValuesForDeleteExistingPeering() []string
• func PossibleValuesForGroupConnectivity() []string
• func PossibleValuesForIsGlobal() []string
• func PossibleValuesForProvisioningState() []string
• func PossibleValuesForUseHubGateway() []string
• func ValidateNetworkManagerID(input interface{}, key string) (warnings []string, errors []error)
• type ActiveConfigurationParameter
• type ActiveConnectivityConfiguration
  • func (o *ActiveConnectivityConfiguration) GetCommitTimeAsTime() (*time.Time, error)
  • func (o *ActiveConnectivityConfiguration) SetCommitTimeAsTime(input time.Time)
• type ActiveConnectivityConfigurationsListResult
• type ConfigurationGroup
• type ConnectivityConfigurationProperties
• type ConnectivityGroupItem
• type ConnectivityTopology
  • func (s *ConnectivityTopology) UnmarshalJSON(bytes []byte) error
• type DeleteExistingPeering
  • func (s *DeleteExistingPeering) UnmarshalJSON(bytes []byte) error
• type GroupConnectivity
  • func (s *GroupConnectivity) UnmarshalJSON(bytes []byte) error
• type Hub
• type IsGlobal
  • func (s *IsGlobal) UnmarshalJSON(bytes []byte) error
• type ListActiveConnectivityConfigurationsOperationResponse
• type NetworkGroupProperties
• type NetworkManagerActiveConnectivityConfigurationsClient
  • func NewNetworkManagerActiveConnectivityConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagerActiveConnectivityConfigurationsClient, error)
  • func (c NetworkManagerActiveConnectivityConfigurationsClient) ListActiveConnectivityConfigurations(ctx context.Context, id NetworkManagerId, input ActiveConfigurationParameter) (result ListActiveConnectivityConfigurationsOperationResponse, err error)
• type NetworkManagerId
  • func NewNetworkManagerID(subscriptionId string, resourceGroupName string, networkManagerName string) NetworkManagerId
  • func ParseNetworkManagerID(input string) (*NetworkManagerId, error)
  • func ParseNetworkManagerIDInsensitively(input string) (*NetworkManagerId, error)
  • func (id *NetworkManagerId) FromParseResult(input resourceids.ParseResult) error
  • func (id NetworkManagerId) ID() string
  • func (id NetworkManagerId) Segments() []resourceids.Segment
  • func (id NetworkManagerId) String() string
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type UseHubGateway
  • func (s *UseHubGateway) UnmarshalJSON(bytes []byte) error

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

type ActiveConfigurationParameter struct {
	Regions   *[]string `json:"regions,omitempty"`
	SkipToken *string   `json:"skipToken,omitempty"`
}

type ActiveConnectivityConfiguration

type ActiveConnectivityConfiguration struct {
	CommitTime          *string                              `json:"commitTime,omitempty"`
	ConfigurationGroups *[]ConfigurationGroup                `json:"configurationGroups,omitempty"`
	Id                  *string                              `json:"id,omitempty"`
	Properties          *ConnectivityConfigurationProperties `json:"properties,omitempty"`
	Region              *string                              `json:"region,omitempty"`
}

func (*ActiveConnectivityConfiguration) GetCommitTimeAsTime

func (o *ActiveConnectivityConfiguration) GetCommitTimeAsTime() (*time.Time, error)

func (*ActiveConnectivityConfiguration) SetCommitTimeAsTime

func (o *ActiveConnectivityConfiguration) SetCommitTimeAsTime(input time.Time)

type ActiveConnectivityConfigurationsListResult

type ActiveConnectivityConfigurationsListResult struct {
	SkipToken *string                            `json:"skipToken,omitempty"`
	Value     *[]ActiveConnectivityConfiguration `json:"value,omitempty"`
}

type ConfigurationGroup

type ConfigurationGroup struct {
	Id         *string                 `json:"id,omitempty"`
	Properties *NetworkGroupProperties `json:"properties,omitempty"`
}

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"`
}

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 DeleteExistingPeering

type DeleteExistingPeering string

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

func (*DeleteExistingPeering) UnmarshalJSON

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

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 ListActiveConnectivityConfigurationsOperationResponse

type ListActiveConnectivityConfigurationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActiveConnectivityConfigurationsListResult
}

type NetworkGroupProperties

type NetworkGroupProperties struct {
	Description       *string            `json:"description,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type NetworkManagerActiveConnectivityConfigurationsClient

type NetworkManagerActiveConnectivityConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewNetworkManagerActiveConnectivityConfigurationsClientWithBaseURI

func NewNetworkManagerActiveConnectivityConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagerActiveConnectivityConfigurationsClient, error)

func (NetworkManagerActiveConnectivityConfigurationsClient) ListActiveConnectivityConfigurations

func (c NetworkManagerActiveConnectivityConfigurationsClient) ListActiveConnectivityConfigurations(ctx context.Context, id NetworkManagerId, input ActiveConfigurationParameter) (result ListActiveConnectivityConfigurationsOperationResponse, err error)

ListActiveConnectivityConfigurations ...

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