attachednetworkconnections

package
v0.20240715.1100358 Latest Latest
Warning

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

Go to latest
Published: Jul 15, 2024 License: MPL-2.0 Imports: 12 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 the Azure Resource Manager Service 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.AttachedNetworksListByDevCenter

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

// 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", "projectValue")

// 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 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

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

AttachedNetworksListByDevCenter ...

func (AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenterComplete

AttachedNetworksListByDevCenterComplete retrieves all the results into a single object

func (AttachedNetworkConnectionsClient) AttachedNetworksListByDevCenterCompleteMatchingPredicate

AttachedNetworksListByDevCenterCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AttachedNetworkConnectionsClient) AttachedNetworksListByProject

AttachedNetworksListByProject ...

func (AttachedNetworkConnectionsClient) AttachedNetworksListByProjectComplete

AttachedNetworksListByProjectComplete retrieves all the results into a single object

func (AttachedNetworkConnectionsClient) AttachedNetworksListByProjectCompleteMatchingPredicate

AttachedNetworksListByProjectCompleteMatchingPredicate retrieves all the results and then applies the predicate

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"`
}

type AttachedNetworksListByDevCenterOperationOptions

type AttachedNetworksListByDevCenterOperationOptions struct {
	Top *int64
}

func DefaultAttachedNetworksListByDevCenterOperationOptions

func DefaultAttachedNetworksListByDevCenterOperationOptions() AttachedNetworksListByDevCenterOperationOptions

func (AttachedNetworksListByDevCenterOperationOptions) ToHeaders

func (AttachedNetworksListByDevCenterOperationOptions) ToOData

func (AttachedNetworksListByDevCenterOperationOptions) ToQuery

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"`
}

type AttachedNetworksListByProjectOperationOptions

type AttachedNetworksListByProjectOperationOptions struct {
	Top *int64
}

func DefaultAttachedNetworksListByProjectOperationOptions

func DefaultAttachedNetworksListByProjectOperationOptions() AttachedNetworksListByProjectOperationOptions

func (AttachedNetworksListByProjectOperationOptions) ToHeaders

func (AttachedNetworksListByProjectOperationOptions) ToOData

func (AttachedNetworksListByProjectOperationOptions) ToQuery

type AttachedNetworksListByProjectOperationResponse

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

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

Jump to

Keyboard shortcuts

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