scopeconnections

package
v0.20241118.1115603 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-09-01/scopeconnections Documentation

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

Client Initialization

client := scopeconnections.NewScopeConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ScopeConnectionsClient.CreateOrUpdate

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

payload := scopeconnections.ScopeConnection{
	// ...
}


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: ScopeConnectionsClient.Delete

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

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

Example Usage: ScopeConnectionsClient.Get

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

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: ScopeConnectionsClient.List

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

// alternatively `client.List(ctx, id, scopeconnections.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, scopeconnections.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 PossibleValuesForScopeConnectionState 

func PossibleValuesForScopeConnectionState() []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

func ValidateScopeConnectionID 

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

ValidateScopeConnectionID checks that 'input' can be parsed as a Scope Connection ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ScopeConnection
}

type DeleteOperationResponse 

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

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ScopeConnection
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ScopeConnection
}

type ListCustomPager added in v0.20240628.1153531 

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        *[]ScopeConnection
}

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 ScopeConnection 

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

type ScopeConnectionId 

type ScopeConnectionId struct {
	SubscriptionId      string
	ResourceGroupName   string
	NetworkManagerName  string
	ScopeConnectionName string
}

ScopeConnectionId is a struct representing the Resource ID for a Scope Connection

func NewScopeConnectionID 

func NewScopeConnectionID(subscriptionId string, resourceGroupName string, networkManagerName string, scopeConnectionName string) ScopeConnectionId

NewScopeConnectionID returns a new ScopeConnectionId struct

func ParseScopeConnectionID 

func ParseScopeConnectionID(input string) (*ScopeConnectionId, error)

ParseScopeConnectionID parses 'input' into a ScopeConnectionId

func ParseScopeConnectionIDInsensitively 

func ParseScopeConnectionIDInsensitively(input string) (*ScopeConnectionId, error)

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

func (*ScopeConnectionId) FromParseResult 

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

func (ScopeConnectionId) ID 

func (id ScopeConnectionId) ID() string

ID returns the formatted Scope Connection ID

func (ScopeConnectionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Scope Connection ID

func (ScopeConnectionId) String 

func (id ScopeConnectionId) String() string

String returns a human-readable description of this Scope Connection ID

type ScopeConnectionOperationPredicate 

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

func (ScopeConnectionOperationPredicate) Matches 

func (p ScopeConnectionOperationPredicate) Matches(input ScopeConnection) bool

type ScopeConnectionProperties 

type ScopeConnectionProperties struct {
	ConnectionState *ScopeConnectionState `json:"connectionState,omitempty"`
	Description     *string               `json:"description,omitempty"`
	ResourceId      *string               `json:"resourceId,omitempty"`
	TenantId        *string               `json:"tenantId,omitempty"`
}

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 ScopeConnectionsClient 

type ScopeConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewScopeConnectionsClientWithBaseURI 

func NewScopeConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ScopeConnectionsClient, error)

func (ScopeConnectionsClient) CreateOrUpdate 

func (c ScopeConnectionsClient) CreateOrUpdate(ctx context.Context, id ScopeConnectionId, input ScopeConnection) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ScopeConnectionsClient) Delete 

func (c ScopeConnectionsClient) Delete(ctx context.Context, id ScopeConnectionId) (result DeleteOperationResponse, err error)

Delete ...

func (ScopeConnectionsClient) Get 

func (c ScopeConnectionsClient) Get(ctx context.Context, id ScopeConnectionId) (result GetOperationResponse, err error)

Get ...

func (ScopeConnectionsClient) List 

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

List ...

func (ScopeConnectionsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ScopeConnectionsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.