networkmanagerconnections

package
v0.20230626.1153114 Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2022-11-01/networkmanagerconnections Documentation

The networkmanagerconnections SDK allows for interaction with the Azure Resource Manager Service network (API Version 2022-11-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-11-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 {
	Items []NetworkManagerConnection
}

type ManagementGroupNetworkManagerConnectionsListOperationOptions 

type ManagementGroupNetworkManagerConnectionsListOperationOptions struct {
	Top *int64
}

func DefaultManagementGroupNetworkManagerConnectionsListOperationOptions 

func DefaultManagementGroupNetworkManagerConnectionsListOperationOptions() ManagementGroupNetworkManagerConnectionsListOperationOptions

func (ManagementGroupNetworkManagerConnectionsListOperationOptions) ToHeaders 

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

func (ManagementGroupNetworkManagerConnectionsListOperationOptions) ToOData 

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

func (ManagementGroupNetworkManagerConnectionsListOperationOptions) ToQuery 

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

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) ID 

func (id NetworkManagerConnectionId) ID() string

ID returns the formatted Network Manager Connection ID

func (NetworkManagerConnectionId) Segments 

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

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 

func (p NetworkManagerConnectionOperationPredicate) Matches(input NetworkManagerConnection) bool

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(api environments.Api) (*NetworkManagerConnectionsClient, error)

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsCreateOrUpdate 

func (c NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsCreateOrUpdate(ctx context.Context, id Providers2NetworkManagerConnectionId, input NetworkManagerConnection) (result ManagementGroupNetworkManagerConnectionsCreateOrUpdateOperationResponse, err error)

ManagementGroupNetworkManagerConnectionsCreateOrUpdate ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsDelete 

func (c NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsDelete(ctx context.Context, id Providers2NetworkManagerConnectionId) (result ManagementGroupNetworkManagerConnectionsDeleteOperationResponse, err error)

ManagementGroupNetworkManagerConnectionsDelete ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsGet 

func (c NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsGet(ctx context.Context, id Providers2NetworkManagerConnectionId) (result ManagementGroupNetworkManagerConnectionsGetOperationResponse, err error)

ManagementGroupNetworkManagerConnectionsGet ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsList 

func (c NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsList(ctx context.Context, id commonids.ManagementGroupId, options ManagementGroupNetworkManagerConnectionsListOperationOptions) (result ManagementGroupNetworkManagerConnectionsListOperationResponse, err error)

ManagementGroupNetworkManagerConnectionsList ...

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsListComplete 

func (c NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsListComplete(ctx context.Context, id commonids.ManagementGroupId, options ManagementGroupNetworkManagerConnectionsListOperationOptions) (ManagementGroupNetworkManagerConnectionsListCompleteResult, error)

ManagementGroupNetworkManagerConnectionsListComplete retrieves all the results into a single object

func (NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsListCompleteMatchingPredicate 

func (c NetworkManagerConnectionsClient) ManagementGroupNetworkManagerConnectionsListCompleteMatchingPredicate(ctx context.Context, id commonids.ManagementGroupId, options ManagementGroupNetworkManagerConnectionsListOperationOptions, predicate NetworkManagerConnectionOperationPredicate) (result ManagementGroupNetworkManagerConnectionsListCompleteResult, err error)

ManagementGroupNetworkManagerConnectionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsCreateOrUpdate 

func (c NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsCreateOrUpdate(ctx context.Context, id NetworkManagerConnectionId, input NetworkManagerConnection) (result SubscriptionNetworkManagerConnectionsCreateOrUpdateOperationResponse, err error)

SubscriptionNetworkManagerConnectionsCreateOrUpdate ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsDelete 

func (c NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsDelete(ctx context.Context, id NetworkManagerConnectionId) (result SubscriptionNetworkManagerConnectionsDeleteOperationResponse, err error)

SubscriptionNetworkManagerConnectionsDelete ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsGet 

func (c NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsGet(ctx context.Context, id NetworkManagerConnectionId) (result SubscriptionNetworkManagerConnectionsGetOperationResponse, err error)

SubscriptionNetworkManagerConnectionsGet ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsList 

func (c NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsList(ctx context.Context, id commonids.SubscriptionId, options SubscriptionNetworkManagerConnectionsListOperationOptions) (result SubscriptionNetworkManagerConnectionsListOperationResponse, err error)

SubscriptionNetworkManagerConnectionsList ...

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsListComplete 

func (c NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsListComplete(ctx context.Context, id commonids.SubscriptionId, options SubscriptionNetworkManagerConnectionsListOperationOptions) (SubscriptionNetworkManagerConnectionsListCompleteResult, error)

SubscriptionNetworkManagerConnectionsListComplete retrieves all the results into a single object

func (NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsListCompleteMatchingPredicate 

func (c NetworkManagerConnectionsClient) SubscriptionNetworkManagerConnectionsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options SubscriptionNetworkManagerConnectionsListOperationOptions, predicate NetworkManagerConnectionOperationPredicate) (result SubscriptionNetworkManagerConnectionsListCompleteResult, err error)

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) ID 

func (id Providers2NetworkManagerConnectionId) ID() string

ID returns the formatted Providers 2 Network Manager Connection ID

func (Providers2NetworkManagerConnectionId) Segments 

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

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

func (Providers2NetworkManagerConnectionId) String 

func (id Providers2NetworkManagerConnectionId) String() 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 {
	Items []NetworkManagerConnection
}

type SubscriptionNetworkManagerConnectionsListOperationOptions 

type SubscriptionNetworkManagerConnectionsListOperationOptions struct {
	Top *int64
}

func DefaultSubscriptionNetworkManagerConnectionsListOperationOptions 

func DefaultSubscriptionNetworkManagerConnectionsListOperationOptions() SubscriptionNetworkManagerConnectionsListOperationOptions

func (SubscriptionNetworkManagerConnectionsListOperationOptions) ToHeaders 

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

func (SubscriptionNetworkManagerConnectionsListOperationOptions) ToOData 

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

func (SubscriptionNetworkManagerConnectionsListOperationOptions) ToQuery 

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

type SubscriptionNetworkManagerConnectionsListOperationResponse 

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

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.