networkmanagereffectiveconnectivityconfiguration

README

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

The networkmanagereffectiveconnectivityconfiguration SDK allows for interaction with Azure Resource Manager network (API Version 2024-01-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-01-01/networkmanagereffectiveconnectivityconfiguration"

Client Initialization

client := networkmanagereffectiveconnectivityconfiguration.NewNetworkManagerEffectiveConnectivityConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkManagerEffectiveConnectivityConfigurationClient.ListNetworkManagerEffectiveConnectivityConfigurations

ctx := context.TODO()
id := commonids.NewVirtualNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualNetworkName")

payload := networkmanagereffectiveconnectivityconfiguration.QueryRequestOptions{
	// ...
}


read, err := client.ListNetworkManagerEffectiveConnectivityConfigurations(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
• 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 EffectiveConnectivityConfiguration
• type GroupConnectivity
  • func (s *GroupConnectivity) UnmarshalJSON(bytes []byte) error
• type Hub
• type IsGlobal
  • func (s *IsGlobal) UnmarshalJSON(bytes []byte) error
• type ListNetworkManagerEffectiveConnectivityConfigurationsOperationResponse
• type NetworkGroupProperties
• type NetworkManagerEffectiveConnectivityConfigurationClient
  • func NewNetworkManagerEffectiveConnectivityConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagerEffectiveConnectivityConfigurationClient, error)
  • func (c NetworkManagerEffectiveConnectivityConfigurationClient) ListNetworkManagerEffectiveConnectivityConfigurations(ctx context.Context, id commonids.VirtualNetworkId, input QueryRequestOptions) (result ListNetworkManagerEffectiveConnectivityConfigurationsOperationResponse, ...)
• type NetworkManagerEffectiveConnectivityConfigurationListResult
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type QueryRequestOptions
• 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

Types

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"`
	ResourceGuid          *string                 `json:"resourceGuid,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 EffectiveConnectivityConfiguration

type EffectiveConnectivityConfiguration struct {
	ConfigurationGroups *[]ConfigurationGroup                `json:"configurationGroups,omitempty"`
	Id                  *string                              `json:"id,omitempty"`
	Properties          *ConnectivityConfigurationProperties `json:"properties,omitempty"`
}

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 ListNetworkManagerEffectiveConnectivityConfigurationsOperationResponse

type ListNetworkManagerEffectiveConnectivityConfigurationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerEffectiveConnectivityConfigurationListResult
}

type NetworkGroupProperties

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

type NetworkManagerEffectiveConnectivityConfigurationClient

type NetworkManagerEffectiveConnectivityConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewNetworkManagerEffectiveConnectivityConfigurationClientWithBaseURI

func NewNetworkManagerEffectiveConnectivityConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagerEffectiveConnectivityConfigurationClient, error)

func (NetworkManagerEffectiveConnectivityConfigurationClient) ListNetworkManagerEffectiveConnectivityConfigurations

func (c NetworkManagerEffectiveConnectivityConfigurationClient) ListNetworkManagerEffectiveConnectivityConfigurations(ctx context.Context, id commonids.VirtualNetworkId, input QueryRequestOptions) (result ListNetworkManagerEffectiveConnectivityConfigurationsOperationResponse, err error)

ListNetworkManagerEffectiveConnectivityConfigurations ...

type NetworkManagerEffectiveConnectivityConfigurationListResult

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

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 QueryRequestOptions

type QueryRequestOptions struct {
	SkipToken *string `json:"skipToken,omitempty"`
}

type UseHubGateway

type UseHubGateway string

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

func (*UseHubGateway) UnmarshalJSON

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