networkmanagerconnections

package
v0.20240117.1145521 Latest Latest
Warning

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

Go to latest
Published: Jan 17, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/networkmanagerconnections Documentation

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

Client Initialization

client := networkmanagerconnections.NewNetworkManagerConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkManagerConnectionsClient.ManagementGroupNetworkManagerConnectionsCreateOrUpdate

ctx := context.TODO()
id := networkmanagerconnections.NewProviders2NetworkManagerConnectionID("managementGroupIdValue", "networkManagerConnectionValue")

payload := networkmanagerconnections.NetworkManagerConnection{
	// ...
}


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

Example Usage: NetworkManagerConnectionsClient.ManagementGroupNetworkManagerConnectionsDelete

ctx := context.TODO()
id := networkmanagerconnections.NewProviders2NetworkManagerConnectionID("managementGroupIdValue", "networkManagerConnectionValue")

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

Example Usage: NetworkManagerConnectionsClient.ManagementGroupNetworkManagerConnectionsGet

ctx := context.TODO()
id := networkmanagerconnections.NewProviders2NetworkManagerConnectionID("managementGroupIdValue", "networkManagerConnectionValue")

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

Example Usage: NetworkManagerConnectionsClient.ManagementGroupNetworkManagerConnectionsList

ctx := context.TODO()
id := networkmanagerconnections.NewManagementGroupID("groupIdValue")

// alternatively `client.ManagementGroupNetworkManagerConnectionsList(ctx, id, networkmanagerconnections.DefaultManagementGroupNetworkManagerConnectionsListOperationOptions())` can be used to do batched pagination
items, err := client.ManagementGroupNetworkManagerConnectionsListComplete(ctx, id, networkmanagerconnections.DefaultManagementGroupNetworkManagerConnectionsListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: NetworkManagerConnectionsClient.SubscriptionNetworkManagerConnectionsCreateOrUpdate

ctx := context.TODO()
id := networkmanagerconnections.NewNetworkManagerConnectionID("12345678-1234-9876-4563-123456789012", "networkManagerConnectionValue")

payload := networkmanagerconnections.NetworkManagerConnection{
	// ...
}


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

Example Usage: NetworkManagerConnectionsClient.SubscriptionNetworkManagerConnectionsDelete

ctx := context.TODO()
id := networkmanagerconnections.NewNetworkManagerConnectionID("12345678-1234-9876-4563-123456789012", "networkManagerConnectionValue")

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

Example Usage: NetworkManagerConnectionsClient.SubscriptionNetworkManagerConnectionsGet

ctx := context.TODO()
id := networkmanagerconnections.NewNetworkManagerConnectionID("12345678-1234-9876-4563-123456789012", "networkManagerConnectionValue")

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

Example Usage: NetworkManagerConnectionsClient.SubscriptionNetworkManagerConnectionsList

ctx := context.TODO()
id := networkmanagerconnections.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.SubscriptionNetworkManagerConnectionsList(ctx, id, networkmanagerconnections.DefaultSubscriptionNetworkManagerConnectionsListOperationOptions())` can be used to do batched pagination
items, err := client.SubscriptionNetworkManagerConnectionsListComplete(ctx, id, networkmanagerconnections.DefaultSubscriptionNetworkManagerConnectionsListOperationOptions())
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 PossibleValuesForScopeConnectionState

func PossibleValuesForScopeConnectionState() []string

func ValidateNetworkManagerConnectionID

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

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

func ValidateProviders2NetworkManagerConnectionID

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

ValidateProviders2NetworkManagerConnectionID checks that 'input' can be parsed as a Providers 2 Network Manager Connection ID

Types

type ManagementGroupNetworkManagerConnectionsCreateOrUpdateOperationResponse

type ManagementGroupNetworkManagerConnectionsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerConnection
}

type ManagementGroupNetworkManagerConnectionsDeleteOperationResponse

type ManagementGroupNetworkManagerConnectionsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ManagementGroupNetworkManagerConnectionsGetOperationResponse

type ManagementGroupNetworkManagerConnectionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerConnection
}

type ManagementGroupNetworkManagerConnectionsListCompleteResult

type ManagementGroupNetworkManagerConnectionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetworkManagerConnection
}

type ManagementGroupNetworkManagerConnectionsListOperationOptions

type ManagementGroupNetworkManagerConnectionsListOperationOptions struct {
	Top *int64
}

func (ManagementGroupNetworkManagerConnectionsListOperationOptions) ToHeaders

func (ManagementGroupNetworkManagerConnectionsListOperationOptions) ToOData

func (ManagementGroupNetworkManagerConnectionsListOperationOptions) ToQuery

type ManagementGroupNetworkManagerConnectionsListOperationResponse

type ManagementGroupNetworkManagerConnectionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetworkManagerConnection
}

type NetworkManagerConnection

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

type NetworkManagerConnectionId

type NetworkManagerConnectionId struct {
	SubscriptionId               string
	NetworkManagerConnectionName string
}

NetworkManagerConnectionId is a struct representing the Resource ID for a Network Manager Connection

func NewNetworkManagerConnectionID

func NewNetworkManagerConnectionID(subscriptionId string, networkManagerConnectionName string) NetworkManagerConnectionId

NewNetworkManagerConnectionID returns a new NetworkManagerConnectionId struct

func ParseNetworkManagerConnectionID

func ParseNetworkManagerConnectionID(input string) (*NetworkManagerConnectionId, error)

ParseNetworkManagerConnectionID parses 'input' into a NetworkManagerConnectionId

func ParseNetworkManagerConnectionIDInsensitively

func ParseNetworkManagerConnectionIDInsensitively(input string) (*NetworkManagerConnectionId, error)

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

func (*NetworkManagerConnectionId) FromParseResult added in v0.20231127.1171502

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

func (NetworkManagerConnectionId) ID

ID returns the formatted Network Manager Connection ID

func (NetworkManagerConnectionId) Segments

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

func (NetworkManagerConnectionId) String

func (id NetworkManagerConnectionId) String() string

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

type NetworkManagerConnectionOperationPredicate

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

func (NetworkManagerConnectionOperationPredicate) Matches

type NetworkManagerConnectionProperties

type NetworkManagerConnectionProperties struct {
	ConnectionState  *ScopeConnectionState `json:"connectionState,omitempty"`
	Description      *string               `json:"description,omitempty"`
	NetworkManagerId *string               `json:"networkManagerId,omitempty"`
}

type NetworkManagerConnectionsClient

type NetworkManagerConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewNetworkManagerConnectionsClientWithBaseURI

func NewNetworkManagerConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagerConnectionsClient, error)

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsCreateOrUpdate

ManagementGroupNetworkManagerConnectionsCreateOrUpdate ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsDelete

ManagementGroupNetworkManagerConnectionsDelete ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsGet

ManagementGroupNetworkManagerConnectionsGet ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsList

ManagementGroupNetworkManagerConnectionsList ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsListComplete

ManagementGroupNetworkManagerConnectionsListComplete retrieves all the results into a single object

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsListCompleteMatchingPredicate

ManagementGroupNetworkManagerConnectionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsCreateOrUpdate

SubscriptionNetworkManagerConnectionsCreateOrUpdate ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsDelete

SubscriptionNetworkManagerConnectionsDelete ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsGet

SubscriptionNetworkManagerConnectionsGet ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsList

SubscriptionNetworkManagerConnectionsList ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsListComplete

SubscriptionNetworkManagerConnectionsListComplete retrieves all the results into a single object

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsListCompleteMatchingPredicate

SubscriptionNetworkManagerConnectionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type Providers2NetworkManagerConnectionId

type Providers2NetworkManagerConnectionId struct {
	ManagementGroupId            string
	NetworkManagerConnectionName string
}

Providers2NetworkManagerConnectionId is a struct representing the Resource ID for a Providers 2 Network Manager Connection

func NewProviders2NetworkManagerConnectionID

func NewProviders2NetworkManagerConnectionID(managementGroupId string, networkManagerConnectionName string) Providers2NetworkManagerConnectionId

NewProviders2NetworkManagerConnectionID returns a new Providers2NetworkManagerConnectionId struct

func ParseProviders2NetworkManagerConnectionID

func ParseProviders2NetworkManagerConnectionID(input string) (*Providers2NetworkManagerConnectionId, error)

ParseProviders2NetworkManagerConnectionID parses 'input' into a Providers2NetworkManagerConnectionId

func ParseProviders2NetworkManagerConnectionIDInsensitively

func ParseProviders2NetworkManagerConnectionIDInsensitively(input string) (*Providers2NetworkManagerConnectionId, error)

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

func (*Providers2NetworkManagerConnectionId) FromParseResult added in v0.20231127.1171502

func (Providers2NetworkManagerConnectionId) ID

ID returns the formatted Providers 2 Network Manager Connection ID

func (Providers2NetworkManagerConnectionId) Segments

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

func (Providers2NetworkManagerConnectionId) String

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

type ScopeConnectionState

type ScopeConnectionState string
const (
	ScopeConnectionStateConflict  ScopeConnectionState = "Conflict"
	ScopeConnectionStateConnected ScopeConnectionState = "Connected"
	ScopeConnectionStatePending   ScopeConnectionState = "Pending"
	ScopeConnectionStateRejected  ScopeConnectionState = "Rejected"
	ScopeConnectionStateRevoked   ScopeConnectionState = "Revoked"
)

func (*ScopeConnectionState) UnmarshalJSON

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

type SubscriptionNetworkManagerConnectionsCreateOrUpdateOperationResponse

type SubscriptionNetworkManagerConnectionsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerConnection
}

type SubscriptionNetworkManagerConnectionsDeleteOperationResponse

type SubscriptionNetworkManagerConnectionsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type SubscriptionNetworkManagerConnectionsGetOperationResponse

type SubscriptionNetworkManagerConnectionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerConnection
}

type SubscriptionNetworkManagerConnectionsListCompleteResult

type SubscriptionNetworkManagerConnectionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetworkManagerConnection
}

type SubscriptionNetworkManagerConnectionsListOperationOptions

type SubscriptionNetworkManagerConnectionsListOperationOptions struct {
	Top *int64
}

func (SubscriptionNetworkManagerConnectionsListOperationOptions) ToHeaders

func (SubscriptionNetworkManagerConnectionsListOperationOptions) ToOData

func (SubscriptionNetworkManagerConnectionsListOperationOptions) ToQuery

type SubscriptionNetworkManagerConnectionsListOperationResponse

type SubscriptionNetworkManagerConnectionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetworkManagerConnection
}

Jump to

Keyboard shortcuts

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