networkconnections

package
v0.20240510.1003452 Latest Latest
Warning

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

 Go to latest Published: May 10, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2023-04-01/networkconnections Documentation

The networkconnections SDK allows for interaction with the Azure Resource Manager Service devcenter (API Version 2023-04-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2023-04-01/networkconnections"

Client Initialization

client := networkconnections.NewNetworkConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkConnectionsClient.CreateOrUpdate

ctx := context.TODO()
id := networkconnections.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

payload := networkconnections.NetworkConnection{
	// ...
}


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

Example Usage: NetworkConnectionsClient.Delete

ctx := context.TODO()
id := networkconnections.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

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

Example Usage: NetworkConnectionsClient.Get

ctx := context.TODO()
id := networkconnections.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

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: NetworkConnectionsClient.GetHealthDetails

ctx := context.TODO()
id := networkconnections.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

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

Example Usage: NetworkConnectionsClient.ListByResourceGroup

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

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

Example Usage: NetworkConnectionsClient.ListBySubscription

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

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

Example Usage: NetworkConnectionsClient.ListHealthDetails

ctx := context.TODO()
id := networkconnections.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

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

Example Usage: NetworkConnectionsClient.Update

ctx := context.TODO()
id := networkconnections.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

payload := networkconnections.NetworkConnectionUpdate{
	// ...
}


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

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 ValidateNetworkConnectionID 

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

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

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkConnection
}

type DeleteOperationResponse 

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

type DomainJoinType 

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

func (*DomainJoinType) UnmarshalJSON 

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

type GetHealthDetailsOperationResponse 

type GetHealthDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HealthCheckStatusDetails
}

type GetOperationResponse 

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

type HealthCheck 

type HealthCheck struct {
	AdditionalDetails *string            `json:"additionalDetails,omitempty"`
	DisplayName       *string            `json:"displayName,omitempty"`
	EndDateTime       *string            `json:"endDateTime,omitempty"`
	ErrorType         *string            `json:"errorType,omitempty"`
	RecommendedAction *string            `json:"recommendedAction,omitempty"`
	StartDateTime     *string            `json:"startDateTime,omitempty"`
	Status            *HealthCheckStatus `json:"status,omitempty"`
}

func (*HealthCheck) GetEndDateTimeAsTime 

func (o *HealthCheck) GetEndDateTimeAsTime() (*time.Time, error)

func (*HealthCheck) GetStartDateTimeAsTime 

func (o *HealthCheck) GetStartDateTimeAsTime() (*time.Time, error)

func (*HealthCheck) SetEndDateTimeAsTime 

func (o *HealthCheck) SetEndDateTimeAsTime(input time.Time)

func (*HealthCheck) SetStartDateTimeAsTime 

func (o *HealthCheck) SetStartDateTimeAsTime(input time.Time)

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 HealthCheckStatusDetails 

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

type HealthCheckStatusDetailsOperationPredicate 

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

func (HealthCheckStatusDetailsOperationPredicate) Matches 

func (p HealthCheckStatusDetailsOperationPredicate) Matches(input HealthCheckStatusDetails) bool

type HealthCheckStatusDetailsProperties 

type HealthCheckStatusDetailsProperties struct {
	EndDateTime   *string        `json:"endDateTime,omitempty"`
	HealthChecks  *[]HealthCheck `json:"healthChecks,omitempty"`
	StartDateTime *string        `json:"startDateTime,omitempty"`
}

func (*HealthCheckStatusDetailsProperties) GetEndDateTimeAsTime 

func (o *HealthCheckStatusDetailsProperties) GetEndDateTimeAsTime() (*time.Time, error)

func (*HealthCheckStatusDetailsProperties) GetStartDateTimeAsTime 

func (o *HealthCheckStatusDetailsProperties) GetStartDateTimeAsTime() (*time.Time, error)

func (*HealthCheckStatusDetailsProperties) SetEndDateTimeAsTime 

func (o *HealthCheckStatusDetailsProperties) SetEndDateTimeAsTime(input time.Time)

func (*HealthCheckStatusDetailsProperties) SetStartDateTimeAsTime 

func (o *HealthCheckStatusDetailsProperties) SetStartDateTimeAsTime(input time.Time)

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetworkConnection
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetworkConnection
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetworkConnection
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetworkConnection
}

type ListHealthDetailsCompleteResult 

type ListHealthDetailsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []HealthCheckStatusDetails
}

type ListHealthDetailsOperationResponse 

type ListHealthDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HealthCheckStatusDetails
}

type NetworkConnection 

type NetworkConnection struct {
	Id         *string                `json:"id,omitempty"`
	Location   string                 `json:"location"`
	Name       *string                `json:"name,omitempty"`
	Properties *NetworkProperties     `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type NetworkConnectionId 

type NetworkConnectionId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NetworkConnectionName string
}

NetworkConnectionId is a struct representing the Resource ID for a Network Connection

func NewNetworkConnectionID 

func NewNetworkConnectionID(subscriptionId string, resourceGroupName string, networkConnectionName string) NetworkConnectionId

NewNetworkConnectionID returns a new NetworkConnectionId struct

func ParseNetworkConnectionID 

func ParseNetworkConnectionID(input string) (*NetworkConnectionId, error)

ParseNetworkConnectionID parses 'input' into a NetworkConnectionId

func ParseNetworkConnectionIDInsensitively 

func ParseNetworkConnectionIDInsensitively(input string) (*NetworkConnectionId, error)

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

func (*NetworkConnectionId) FromParseResult 

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

func (NetworkConnectionId) ID 

func (id NetworkConnectionId) ID() string

ID returns the formatted Network Connection ID

func (NetworkConnectionId) Segments 

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

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

func (NetworkConnectionId) String 

func (id NetworkConnectionId) String() string

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

type NetworkConnectionOperationPredicate 

type NetworkConnectionOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (NetworkConnectionOperationPredicate) Matches 

func (p NetworkConnectionOperationPredicate) Matches(input NetworkConnection) bool

type NetworkConnectionUpdate 

type NetworkConnectionUpdate struct {
	Location   *string                            `json:"location,omitempty"`
	Properties *NetworkConnectionUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type NetworkConnectionUpdateProperties 

type NetworkConnectionUpdateProperties struct {
	DomainName       *string `json:"domainName,omitempty"`
	DomainPassword   *string `json:"domainPassword,omitempty"`
	DomainUsername   *string `json:"domainUsername,omitempty"`
	OrganizationUnit *string `json:"organizationUnit,omitempty"`
	SubnetId         *string `json:"subnetId,omitempty"`
}

type NetworkConnectionsClient 

type NetworkConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewNetworkConnectionsClientWithBaseURI 

func NewNetworkConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkConnectionsClient, error)

func (NetworkConnectionsClient) CreateOrUpdate 

func (c NetworkConnectionsClient) CreateOrUpdate(ctx context.Context, id NetworkConnectionId, input NetworkConnection) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NetworkConnectionsClient) CreateOrUpdateThenPoll 

func (c NetworkConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id NetworkConnectionId, input NetworkConnection) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (NetworkConnectionsClient) Delete 

func (c NetworkConnectionsClient) Delete(ctx context.Context, id NetworkConnectionId) (result DeleteOperationResponse, err error)

Delete ...

func (NetworkConnectionsClient) DeleteThenPoll 

func (c NetworkConnectionsClient) DeleteThenPoll(ctx context.Context, id NetworkConnectionId) error

DeleteThenPoll performs Delete then polls until it's completed

func (NetworkConnectionsClient) Get 

func (c NetworkConnectionsClient) Get(ctx context.Context, id NetworkConnectionId) (result GetOperationResponse, err error)

Get ...

func (NetworkConnectionsClient) GetHealthDetails 

func (c NetworkConnectionsClient) GetHealthDetails(ctx context.Context, id NetworkConnectionId) (result GetHealthDetailsOperationResponse, err error)

GetHealthDetails ...

func (NetworkConnectionsClient) ListByResourceGroup 

func (c NetworkConnectionsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (NetworkConnectionsClient) ListByResourceGroupComplete 

func (c NetworkConnectionsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (NetworkConnectionsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c NetworkConnectionsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate NetworkConnectionOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkConnectionsClient) ListBySubscription 

func (c NetworkConnectionsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (NetworkConnectionsClient) ListBySubscriptionComplete 

func (c NetworkConnectionsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (NetworkConnectionsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c NetworkConnectionsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate NetworkConnectionOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkConnectionsClient) ListHealthDetails 

func (c NetworkConnectionsClient) ListHealthDetails(ctx context.Context, id NetworkConnectionId) (result ListHealthDetailsOperationResponse, err error)

ListHealthDetails ...

func (NetworkConnectionsClient) ListHealthDetailsComplete 

func (c NetworkConnectionsClient) ListHealthDetailsComplete(ctx context.Context, id NetworkConnectionId) (ListHealthDetailsCompleteResult, error)

ListHealthDetailsComplete retrieves all the results into a single object

func (NetworkConnectionsClient) ListHealthDetailsCompleteMatchingPredicate 

func (c NetworkConnectionsClient) ListHealthDetailsCompleteMatchingPredicate(ctx context.Context, id NetworkConnectionId, predicate HealthCheckStatusDetailsOperationPredicate) (result ListHealthDetailsCompleteResult, err error)

ListHealthDetailsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkConnectionsClient) Update 

func (c NetworkConnectionsClient) Update(ctx context.Context, id NetworkConnectionId, input NetworkConnectionUpdate) (result UpdateOperationResponse, err error)

Update ...

func (NetworkConnectionsClient) UpdateThenPoll 

func (c NetworkConnectionsClient) UpdateThenPoll(ctx context.Context, id NetworkConnectionId, input NetworkConnectionUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type NetworkProperties 

type NetworkProperties struct {
	DomainJoinType              DomainJoinType     `json:"domainJoinType"`
	DomainName                  *string            `json:"domainName,omitempty"`
	DomainPassword              *string            `json:"domainPassword,omitempty"`
	DomainUsername              *string            `json:"domainUsername,omitempty"`
	HealthCheckStatus           *HealthCheckStatus `json:"healthCheckStatus,omitempty"`
	NetworkingResourceGroupName *string            `json:"networkingResourceGroupName,omitempty"`
	OrganizationUnit            *string            `json:"organizationUnit,omitempty"`
	ProvisioningState           *ProvisioningState `json:"provisioningState,omitempty"`
	SubnetId                    *string            `json:"subnetId,omitempty"`
}

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkConnection
}

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.