vnetpeering

package
v0.20241203.1090052 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/databricks/2024-05-01/vnetpeering Documentation

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

Client Initialization

client := vnetpeering.NewVNetPeeringClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VNetPeeringClient.CreateOrUpdate

ctx := context.TODO()
id := vnetpeering.NewVirtualNetworkPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "virtualNetworkPeeringName")

payload := vnetpeering.VirtualNetworkPeering{
	// ...
}


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

Example Usage: VNetPeeringClient.Delete

ctx := context.TODO()
id := vnetpeering.NewVirtualNetworkPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "virtualNetworkPeeringName")

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

Example Usage: VNetPeeringClient.Get

ctx := context.TODO()
id := vnetpeering.NewVirtualNetworkPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "virtualNetworkPeeringName")

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: VNetPeeringClient.ListByWorkspace

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

// alternatively `client.ListByWorkspace(ctx, id)` can be used to do batched pagination
items, err := client.ListByWorkspaceComplete(ctx, id)
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 PossibleValuesForPeeringProvisioningState 

func PossibleValuesForPeeringProvisioningState() []string

func PossibleValuesForPeeringState 

func PossibleValuesForPeeringState() []string

func ValidateVirtualNetworkPeeringID 

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

ValidateVirtualNetworkPeeringID checks that 'input' can be parsed as a Virtual Network Peering ID

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type AddressSpace 

type AddressSpace struct {
	AddressPrefixes *[]string `json:"addressPrefixes,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByWorkspaceCompleteResult 

type ListByWorkspaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VirtualNetworkPeering
}

type ListByWorkspaceCustomPager added in v0.20240628.1153531 

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

type ListByWorkspaceOperationResponse 

type ListByWorkspaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VirtualNetworkPeering
}

type PeeringProvisioningState 

type PeeringProvisioningState string
const (
	PeeringProvisioningStateDeleting  PeeringProvisioningState = "Deleting"
	PeeringProvisioningStateFailed    PeeringProvisioningState = "Failed"
	PeeringProvisioningStateSucceeded PeeringProvisioningState = "Succeeded"
	PeeringProvisioningStateUpdating  PeeringProvisioningState = "Updating"
)

func (*PeeringProvisioningState) UnmarshalJSON 

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

type PeeringState 

type PeeringState string
const (
	PeeringStateConnected    PeeringState = "Connected"
	PeeringStateDisconnected PeeringState = "Disconnected"
	PeeringStateInitiated    PeeringState = "Initiated"
)

func (*PeeringState) UnmarshalJSON 

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

type VNetPeeringClient 

type VNetPeeringClient struct {
	Client *resourcemanager.Client
}

func NewVNetPeeringClientWithBaseURI 

func NewVNetPeeringClientWithBaseURI(sdkApi sdkEnv.Api) (*VNetPeeringClient, error)

func (VNetPeeringClient) CreateOrUpdate 

func (c VNetPeeringClient) CreateOrUpdate(ctx context.Context, id VirtualNetworkPeeringId, input VirtualNetworkPeering) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (VNetPeeringClient) CreateOrUpdateThenPoll 

func (c VNetPeeringClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualNetworkPeeringId, input VirtualNetworkPeering) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VNetPeeringClient) Delete 

func (c VNetPeeringClient) Delete(ctx context.Context, id VirtualNetworkPeeringId) (result DeleteOperationResponse, err error)

Delete ...

func (VNetPeeringClient) DeleteThenPoll 

func (c VNetPeeringClient) DeleteThenPoll(ctx context.Context, id VirtualNetworkPeeringId) error

DeleteThenPoll performs Delete then polls until it's completed

func (VNetPeeringClient) Get 

func (c VNetPeeringClient) Get(ctx context.Context, id VirtualNetworkPeeringId) (result GetOperationResponse, err error)

Get ...

func (VNetPeeringClient) ListByWorkspace 

func (c VNetPeeringClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (result ListByWorkspaceOperationResponse, err error)

ListByWorkspace ...

func (VNetPeeringClient) ListByWorkspaceComplete 

func (c VNetPeeringClient) ListByWorkspaceComplete(ctx context.Context, id WorkspaceId) (ListByWorkspaceCompleteResult, error)

ListByWorkspaceComplete retrieves all the results into a single object

func (VNetPeeringClient) ListByWorkspaceCompleteMatchingPredicate 

func (c VNetPeeringClient) ListByWorkspaceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate VirtualNetworkPeeringOperationPredicate) (result ListByWorkspaceCompleteResult, err error)

ListByWorkspaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type VirtualNetworkPeering 

type VirtualNetworkPeering struct {
	Id         *string                               `json:"id,omitempty"`
	Name       *string                               `json:"name,omitempty"`
	Properties VirtualNetworkPeeringPropertiesFormat `json:"properties"`
	Type       *string                               `json:"type,omitempty"`
}

type VirtualNetworkPeeringId 

type VirtualNetworkPeeringId struct {
	SubscriptionId            string
	ResourceGroupName         string
	WorkspaceName             string
	VirtualNetworkPeeringName string
}

VirtualNetworkPeeringId is a struct representing the Resource ID for a Virtual Network Peering

func NewVirtualNetworkPeeringID 

func NewVirtualNetworkPeeringID(subscriptionId string, resourceGroupName string, workspaceName string, virtualNetworkPeeringName string) VirtualNetworkPeeringId

NewVirtualNetworkPeeringID returns a new VirtualNetworkPeeringId struct

func ParseVirtualNetworkPeeringID 

func ParseVirtualNetworkPeeringID(input string) (*VirtualNetworkPeeringId, error)

ParseVirtualNetworkPeeringID parses 'input' into a VirtualNetworkPeeringId

func ParseVirtualNetworkPeeringIDInsensitively 

func ParseVirtualNetworkPeeringIDInsensitively(input string) (*VirtualNetworkPeeringId, error)

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

func (*VirtualNetworkPeeringId) FromParseResult 

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

func (VirtualNetworkPeeringId) ID 

func (id VirtualNetworkPeeringId) ID() string

ID returns the formatted Virtual Network Peering ID

func (VirtualNetworkPeeringId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Virtual Network Peering ID

func (VirtualNetworkPeeringId) String 

func (id VirtualNetworkPeeringId) String() string

String returns a human-readable description of this Virtual Network Peering ID

type VirtualNetworkPeeringOperationPredicate 

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

func (VirtualNetworkPeeringOperationPredicate) Matches 

func (p VirtualNetworkPeeringOperationPredicate) Matches(input VirtualNetworkPeering) bool

type VirtualNetworkPeeringPropertiesFormat 

type VirtualNetworkPeeringPropertiesFormat struct {
	AllowForwardedTraffic     *bool                                                          `json:"allowForwardedTraffic,omitempty"`
	AllowGatewayTransit       *bool                                                          `json:"allowGatewayTransit,omitempty"`
	AllowVirtualNetworkAccess *bool                                                          `json:"allowVirtualNetworkAccess,omitempty"`
	DatabricksAddressSpace    *AddressSpace                                                  `json:"databricksAddressSpace,omitempty"`
	DatabricksVirtualNetwork  *VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork `json:"databricksVirtualNetwork,omitempty"`
	PeeringState              *PeeringState                                                  `json:"peeringState,omitempty"`
	ProvisioningState         *PeeringProvisioningState                                      `json:"provisioningState,omitempty"`
	RemoteAddressSpace        *AddressSpace                                                  `json:"remoteAddressSpace,omitempty"`
	RemoteVirtualNetwork      VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork      `json:"remoteVirtualNetwork"`
	UseRemoteGateways         *bool                                                          `json:"useRemoteGateways,omitempty"`
}

type VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork 

type VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork struct {
	Id *string `json:"id,omitempty"`
}

type VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork 

type VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork struct {
	Id *string `json:"id,omitempty"`
}

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

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

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

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.