attachednetworkconnections

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2024-02-01/attachednetworkconnections Documentation

The attachednetworkconnections SDK allows for interaction with Azure Resource Manager devcenter (API Version 2024-02-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/devcenter/2024-02-01/attachednetworkconnections"

Client Initialization

client := attachednetworkconnections.NewAttachedNetworkConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AttachedNetworkConnectionsClient.AttachedNetworksCreateOrUpdate

ctx := context.TODO()
id := attachednetworkconnections.NewDevCenterAttachedNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterName", "attachedNetworkName")

payload := attachednetworkconnections.AttachedNetworkConnection{
	// ...
}


if err := client.AttachedNetworksCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: AttachedNetworkConnectionsClient.AttachedNetworksDelete

ctx := context.TODO()
id := attachednetworkconnections.NewDevCenterAttachedNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterName", "attachedNetworkName")

if err := client.AttachedNetworksDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: AttachedNetworkConnectionsClient.AttachedNetworksGetByDevCenter

ctx := context.TODO()
id := attachednetworkconnections.NewDevCenterAttachedNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterName", "attachedNetworkName")

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

Example Usage: AttachedNetworkConnectionsClient.AttachedNetworksGetByProject

ctx := context.TODO()
id := attachednetworkconnections.NewAttachedNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectName", "attachedNetworkName")

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

Example Usage: AttachedNetworkConnectionsClient.AttachedNetworksListByDevCenter

ctx := context.TODO()
id := attachednetworkconnections.NewDevCenterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterName")

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

Example Usage: AttachedNetworkConnectionsClient.AttachedNetworksListByProject

ctx := context.TODO()
id := attachednetworkconnections.NewProjectID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectName")

// alternatively `client.AttachedNetworksListByProject(ctx, id, attachednetworkconnections.DefaultAttachedNetworksListByProjectOperationOptions())` can be used to do batched pagination
items, err := client.AttachedNetworksListByProjectComplete(ctx, id, attachednetworkconnections.DefaultAttachedNetworksListByProjectOperationOptions())
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 PossibleValuesForDomainJoinType 

func PossibleValuesForDomainJoinType() []string

func PossibleValuesForHealthCheckStatus 

func PossibleValuesForHealthCheckStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateAttachedNetworkID added in v0.20241009.1142232 

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

ValidateAttachedNetworkID checks that 'input' can be parsed as a Attached Network ID

func ValidateDevCenterAttachedNetworkID added in v0.20241009.1142232 

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

ValidateDevCenterAttachedNetworkID checks that 'input' can be parsed as a Dev Center Attached Network ID

func ValidateDevCenterID 

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

ValidateDevCenterID checks that 'input' can be parsed as a Dev Center ID

func ValidateProjectID 

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

ValidateProjectID checks that 'input' can be parsed as a Project ID

Types

type AttachedNetworkConnection 

type AttachedNetworkConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *AttachedNetworkConnectionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type AttachedNetworkConnectionOperationPredicate 

type AttachedNetworkConnectionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (AttachedNetworkConnectionOperationPredicate) Matches 

func (p AttachedNetworkConnectionOperationPredicate) Matches(input AttachedNetworkConnection) bool

type AttachedNetworkConnectionProperties 

type AttachedNetworkConnectionProperties struct {
	DomainJoinType            *DomainJoinType    `json:"domainJoinType,omitempty"`
	HealthCheckStatus         *HealthCheckStatus `json:"healthCheckStatus,omitempty"`
	NetworkConnectionId       string             `json:"networkConnectionId"`
	NetworkConnectionLocation *string            `json:"networkConnectionLocation,omitempty"`
	ProvisioningState         *ProvisioningState `json:"provisioningState,omitempty"`
}

type AttachedNetworkConnectionsClient 

type AttachedNetworkConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewAttachedNetworkConnectionsClientWithBaseURI 

func NewAttachedNetworkConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*AttachedNetworkConnectionsClient, error)

func (AttachedNetworkConnectionsClient) AttachedNetworksCreateOrUpdate added in v0.20241009.1142232 

func (c AttachedNetworkConnectionsClient) AttachedNetworksCreateOrUpdate(ctx context.Context, id DevCenterAttachedNetworkId, input AttachedNetworkConnection) (result AttachedNetworksCreateOrUpdateOperationResponse, err error)

AttachedNetworksCreateOrUpdate ...

func (AttachedNetworkConnectionsClient) AttachedNetworksCreateOrUpdateThenPoll added in v0.20241009.1142232 

func (c AttachedNetworkConnectionsClient) AttachedNetworksCreateOrUpdateThenPoll(ctx context.Context, id DevCenterAttachedNetworkId, input AttachedNetworkConnection) error

AttachedNetworksCreateOrUpdateThenPoll performs AttachedNetworksCreateOrUpdate then polls until it's completed

func (AttachedNetworkConnectionsClient) AttachedNetworksDelete added in v0.20241009.1142232 

func (c AttachedNetworkConnectionsClient) AttachedNetworksDelete(ctx context.Context, id DevCenterAttachedNetworkId) (result AttachedNetworksDeleteOperationResponse, err error)

AttachedNetworksDelete ...

func (AttachedNetworkConnectionsClient) AttachedNetworksDeleteThenPoll added in v0.20241009.1142232 

func (c AttachedNetworkConnectionsClient) AttachedNetworksDeleteThenPoll(ctx context.Context, id DevCenterAttachedNetworkId) error

AttachedNetworksDeleteThenPoll performs AttachedNetworksDelete then polls until it's completed

func (AttachedNetworkConnectionsClient) AttachedNetworksGetByDevCenter added in v0.20241009.1142232 

func (c AttachedNetworkConnectionsClient) AttachedNetworksGetByDevCenter(ctx context.Context, id DevCenterAttachedNetworkId) (result AttachedNetworksGetByDevCenterOperationResponse, err error)

AttachedNetworksGetByDevCenter ...

func (AttachedNetworkConnectionsClient) AttachedNetworksGetByProject added in v0.20241009.1142232 

func (c AttachedNetworkConnectionsClient) AttachedNetworksGetByProject(ctx context.Context, id AttachedNetworkId) (result AttachedNetworksGetByProjectOperationResponse, err error)

AttachedNetworksGetByProject ...

func (AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenter 

func (c AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenter(ctx context.Context, id DevCenterId, options AttachedNetworksListByDevCenterOperationOptions) (result AttachedNetworksListByDevCenterOperationResponse, err error)

AttachedNetworksListByDevCenter ...

func (AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenterComplete 

func (c AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenterComplete(ctx context.Context, id DevCenterId, options AttachedNetworksListByDevCenterOperationOptions) (AttachedNetworksListByDevCenterCompleteResult, error)

AttachedNetworksListByDevCenterComplete retrieves all the results into a single object

func (AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenterCompleteMatchingPredicate 

func (c AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenterCompleteMatchingPredicate(ctx context.Context, id DevCenterId, options AttachedNetworksListByDevCenterOperationOptions, predicate AttachedNetworkConnectionOperationPredicate) (result AttachedNetworksListByDevCenterCompleteResult, err error)

AttachedNetworksListByDevCenterCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AttachedNetworkConnectionsClient) AttachedNetworksListByProject 

func (c AttachedNetworkConnectionsClient) AttachedNetworksListByProject(ctx context.Context, id ProjectId, options AttachedNetworksListByProjectOperationOptions) (result AttachedNetworksListByProjectOperationResponse, err error)

AttachedNetworksListByProject ...

func (AttachedNetworkConnectionsClient) AttachedNetworksListByProjectComplete 

func (c AttachedNetworkConnectionsClient) AttachedNetworksListByProjectComplete(ctx context.Context, id ProjectId, options AttachedNetworksListByProjectOperationOptions) (AttachedNetworksListByProjectCompleteResult, error)

AttachedNetworksListByProjectComplete retrieves all the results into a single object

func (AttachedNetworkConnectionsClient) AttachedNetworksListByProjectCompleteMatchingPredicate 

func (c AttachedNetworkConnectionsClient) AttachedNetworksListByProjectCompleteMatchingPredicate(ctx context.Context, id ProjectId, options AttachedNetworksListByProjectOperationOptions, predicate AttachedNetworkConnectionOperationPredicate) (result AttachedNetworksListByProjectCompleteResult, err error)

AttachedNetworksListByProjectCompleteMatchingPredicate retrieves all the results and then applies the predicate

type AttachedNetworkId added in v0.20241009.1142232 

type AttachedNetworkId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ProjectName         string
	AttachedNetworkName string
}

AttachedNetworkId is a struct representing the Resource ID for a Attached Network

func NewAttachedNetworkID added in v0.20241009.1142232 

func NewAttachedNetworkID(subscriptionId string, resourceGroupName string, projectName string, attachedNetworkName string) AttachedNetworkId

NewAttachedNetworkID returns a new AttachedNetworkId struct

func ParseAttachedNetworkID added in v0.20241009.1142232 

func ParseAttachedNetworkID(input string) (*AttachedNetworkId, error)

ParseAttachedNetworkID parses 'input' into a AttachedNetworkId

func ParseAttachedNetworkIDInsensitively added in v0.20241009.1142232 

func ParseAttachedNetworkIDInsensitively(input string) (*AttachedNetworkId, error)

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

func (*AttachedNetworkId) FromParseResult added in v0.20241009.1142232 

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

func (AttachedNetworkId) ID added in v0.20241009.1142232 

func (id AttachedNetworkId) ID() string

ID returns the formatted Attached Network ID

func (AttachedNetworkId) Segments added in v0.20241009.1142232 

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

Segments returns a slice of Resource ID Segments which comprise this Attached Network ID

func (AttachedNetworkId) String added in v0.20241009.1142232 

func (id AttachedNetworkId) String() string

String returns a human-readable description of this Attached Network ID

type AttachedNetworksCreateOrUpdateOperationResponse added in v0.20241009.1142232 

type AttachedNetworksCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AttachedNetworkConnection
}

type AttachedNetworksDeleteOperationResponse added in v0.20241009.1142232 

type AttachedNetworksDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AttachedNetworksGetByDevCenterOperationResponse added in v0.20241009.1142232 

type AttachedNetworksGetByDevCenterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AttachedNetworkConnection
}

type AttachedNetworksGetByProjectOperationResponse added in v0.20241009.1142232 

type AttachedNetworksGetByProjectOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AttachedNetworkConnection
}

type AttachedNetworksListByDevCenterCompleteResult 

type AttachedNetworksListByDevCenterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AttachedNetworkConnection
}

type AttachedNetworksListByDevCenterCustomPager added in v0.20240628.1153531 

type AttachedNetworksListByDevCenterCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *AttachedNetworksListByDevCenterCustomPager) NextPageLink() *odata.Link

type AttachedNetworksListByDevCenterOperationOptions 

type AttachedNetworksListByDevCenterOperationOptions struct {
	Top *int64
}

func DefaultAttachedNetworksListByDevCenterOperationOptions 

func DefaultAttachedNetworksListByDevCenterOperationOptions() AttachedNetworksListByDevCenterOperationOptions

func (AttachedNetworksListByDevCenterOperationOptions) ToHeaders 

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

func (AttachedNetworksListByDevCenterOperationOptions) ToOData 

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

func (AttachedNetworksListByDevCenterOperationOptions) ToQuery 

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

type AttachedNetworksListByDevCenterOperationResponse 

type AttachedNetworksListByDevCenterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AttachedNetworkConnection
}

type AttachedNetworksListByProjectCompleteResult 

type AttachedNetworksListByProjectCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AttachedNetworkConnection
}

type AttachedNetworksListByProjectCustomPager added in v0.20240628.1153531 

type AttachedNetworksListByProjectCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *AttachedNetworksListByProjectCustomPager) NextPageLink() *odata.Link

type AttachedNetworksListByProjectOperationOptions 

type AttachedNetworksListByProjectOperationOptions struct {
	Top *int64
}

func DefaultAttachedNetworksListByProjectOperationOptions 

func DefaultAttachedNetworksListByProjectOperationOptions() AttachedNetworksListByProjectOperationOptions

func (AttachedNetworksListByProjectOperationOptions) ToHeaders 

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

func (AttachedNetworksListByProjectOperationOptions) ToOData 

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

func (AttachedNetworksListByProjectOperationOptions) ToQuery 

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

type AttachedNetworksListByProjectOperationResponse 

type AttachedNetworksListByProjectOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AttachedNetworkConnection
}

type DevCenterAttachedNetworkId added in v0.20241009.1142232 

type DevCenterAttachedNetworkId struct {
	SubscriptionId      string
	ResourceGroupName   string
	DevCenterName       string
	AttachedNetworkName string
}

DevCenterAttachedNetworkId is a struct representing the Resource ID for a Dev Center Attached Network

func NewDevCenterAttachedNetworkID added in v0.20241009.1142232 

func NewDevCenterAttachedNetworkID(subscriptionId string, resourceGroupName string, devCenterName string, attachedNetworkName string) DevCenterAttachedNetworkId

NewDevCenterAttachedNetworkID returns a new DevCenterAttachedNetworkId struct

func ParseDevCenterAttachedNetworkID added in v0.20241009.1142232 

func ParseDevCenterAttachedNetworkID(input string) (*DevCenterAttachedNetworkId, error)

ParseDevCenterAttachedNetworkID parses 'input' into a DevCenterAttachedNetworkId

func ParseDevCenterAttachedNetworkIDInsensitively added in v0.20241009.1142232 

func ParseDevCenterAttachedNetworkIDInsensitively(input string) (*DevCenterAttachedNetworkId, error)

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

func (*DevCenterAttachedNetworkId) FromParseResult added in v0.20241009.1142232 

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

func (DevCenterAttachedNetworkId) ID added in v0.20241009.1142232 

func (id DevCenterAttachedNetworkId) ID() string

ID returns the formatted Dev Center Attached Network ID

func (DevCenterAttachedNetworkId) Segments added in v0.20241009.1142232 

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

Segments returns a slice of Resource ID Segments which comprise this Dev Center Attached Network ID

func (DevCenterAttachedNetworkId) String added in v0.20241009.1142232 

func (id DevCenterAttachedNetworkId) String() string

String returns a human-readable description of this Dev Center Attached Network ID

type DevCenterId 

type DevCenterId struct {
	SubscriptionId    string
	ResourceGroupName string
	DevCenterName     string
}

DevCenterId is a struct representing the Resource ID for a Dev Center

func NewDevCenterID 

func NewDevCenterID(subscriptionId string, resourceGroupName string, devCenterName string) DevCenterId

NewDevCenterID returns a new DevCenterId struct

func ParseDevCenterID 

func ParseDevCenterID(input string) (*DevCenterId, error)

ParseDevCenterID parses 'input' into a DevCenterId

func ParseDevCenterIDInsensitively 

func ParseDevCenterIDInsensitively(input string) (*DevCenterId, error)

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

func (*DevCenterId) FromParseResult 

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

func (DevCenterId) ID 

func (id DevCenterId) ID() string

ID returns the formatted Dev Center ID

func (DevCenterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Dev Center ID

func (DevCenterId) String 

func (id DevCenterId) String() string

String returns a human-readable description of this Dev Center ID

type DomainJoinType 

type DomainJoinType string
const (
	DomainJoinTypeAzureADJoin       DomainJoinType = "AzureADJoin"
	DomainJoinTypeHybridAzureADJoin DomainJoinType = "HybridAzureADJoin"
)

func (*DomainJoinType) UnmarshalJSON 

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

type HealthCheckStatus 

type HealthCheckStatus string
const (
	HealthCheckStatusFailed  HealthCheckStatus = "Failed"
	HealthCheckStatusPassed  HealthCheckStatus = "Passed"
	HealthCheckStatusPending HealthCheckStatus = "Pending"
	HealthCheckStatusRunning HealthCheckStatus = "Running"
	HealthCheckStatusUnknown HealthCheckStatus = "Unknown"
	HealthCheckStatusWarning HealthCheckStatus = "Warning"
)

func (*HealthCheckStatus) UnmarshalJSON 

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

type ProjectId 

type ProjectId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProjectName       string
}

ProjectId is a struct representing the Resource ID for a Project

func NewProjectID 

func NewProjectID(subscriptionId string, resourceGroupName string, projectName string) ProjectId

NewProjectID returns a new ProjectId struct

func ParseProjectID 

func ParseProjectID(input string) (*ProjectId, error)

ParseProjectID parses 'input' into a ProjectId

func ParseProjectIDInsensitively 

func ParseProjectIDInsensitively(input string) (*ProjectId, error)

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

func (*ProjectId) FromParseResult 

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

func (ProjectId) ID 

func (id ProjectId) ID() string

ID returns the formatted Project ID

func (ProjectId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Project ID

func (ProjectId) String 

func (id ProjectId) String() string

String returns a human-readable description of this Project ID

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted                  ProvisioningState = "Accepted"
	ProvisioningStateCanceled                  ProvisioningState = "Canceled"
	ProvisioningStateCreated                   ProvisioningState = "Created"
	ProvisioningStateCreating                  ProvisioningState = "Creating"
	ProvisioningStateDeleted                   ProvisioningState = "Deleted"
	ProvisioningStateDeleting                  ProvisioningState = "Deleting"
	ProvisioningStateFailed                    ProvisioningState = "Failed"
	ProvisioningStateMovingResources           ProvisioningState = "MovingResources"
	ProvisioningStateNotSpecified              ProvisioningState = "NotSpecified"
	ProvisioningStateRolloutInProgress         ProvisioningState = "RolloutInProgress"
	ProvisioningStateRunning                   ProvisioningState = "Running"
	ProvisioningStateStorageProvisioningFailed ProvisioningState = "StorageProvisioningFailed"
	ProvisioningStateSucceeded                 ProvisioningState = "Succeeded"
	ProvisioningStateTransientFailure          ProvisioningState = "TransientFailure"
	ProvisioningStateUpdated                   ProvisioningState = "Updated"
	ProvisioningStateUpdating                  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

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.