README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/databricks/2022-04-01-preview/vnetpeering
Documentation
The vnetpeering
SDK allows for interaction with the Azure Resource Manager Service databricks
(API Version 2022-04-01-preview
).
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/2022-04-01-preview/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", "workspaceValue", "virtualNetworkPeeringValue")
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", "workspaceValue", "virtualNetworkPeeringValue")
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", "workspaceValue", "virtualNetworkPeeringValue")
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", "workspaceValue")
// 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 ¶
- func PossibleValuesForPeeringProvisioningState() []string
- func PossibleValuesForPeeringState() []string
- func ValidateVirtualNetworkPeeringID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
- type AddressSpace
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByWorkspaceCompleteResult
- type ListByWorkspaceOperationResponse
- type PeeringProvisioningState
- type PeeringState
- type VNetPeeringClient
- func (c VNetPeeringClient) CreateOrUpdate(ctx context.Context, id VirtualNetworkPeeringId, input VirtualNetworkPeering) (result CreateOrUpdateOperationResponse, err error)
- func (c VNetPeeringClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualNetworkPeeringId, input VirtualNetworkPeering) error
- func (c VNetPeeringClient) Delete(ctx context.Context, id VirtualNetworkPeeringId) (result DeleteOperationResponse, err error)
- func (c VNetPeeringClient) DeleteThenPoll(ctx context.Context, id VirtualNetworkPeeringId) error
- func (c VNetPeeringClient) Get(ctx context.Context, id VirtualNetworkPeeringId) (result GetOperationResponse, err error)
- func (c VNetPeeringClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (resp ListByWorkspaceOperationResponse, err error)
- func (c VNetPeeringClient) ListByWorkspaceComplete(ctx context.Context, id WorkspaceId) (ListByWorkspaceCompleteResult, error)
- func (c VNetPeeringClient) ListByWorkspaceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, ...) (resp ListByWorkspaceCompleteResult, err error)
- type VirtualNetworkPeering
- type VirtualNetworkPeeringId
- func NewVirtualNetworkPeeringID(subscriptionId string, resourceGroupName string, workspaceName string, ...) VirtualNetworkPeeringId
- func ParseVirtualNetworkPeeringID(input string) (*VirtualNetworkPeeringId, error)
- func ParseVirtualNetworkPeeringIDInsensitively(input string) (*VirtualNetworkPeeringId, error)
- type VirtualNetworkPeeringOperationPredicate
- type VirtualNetworkPeeringPropertiesFormat
- type VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork
- type VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork
- type WorkspaceId
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 ¶
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 polling.LongRunningPoller HttpResponse *http.Response }
type DeleteOperationResponse ¶
type DeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *VirtualNetworkPeering }
type ListByWorkspaceCompleteResult ¶
type ListByWorkspaceCompleteResult struct {
Items []VirtualNetworkPeering
}
type ListByWorkspaceOperationResponse ¶
type ListByWorkspaceOperationResponse struct { HttpResponse *http.Response Model *[]VirtualNetworkPeering // contains filtered or unexported fields }
func (ListByWorkspaceOperationResponse) HasMore ¶
func (r ListByWorkspaceOperationResponse) HasMore() bool
func (ListByWorkspaceOperationResponse) LoadMore ¶
func (r ListByWorkspaceOperationResponse) LoadMore(ctx context.Context) (resp ListByWorkspaceOperationResponse, err error)
type PeeringProvisioningState ¶
type PeeringProvisioningState string
const ( PeeringProvisioningStateDeleting PeeringProvisioningState = "Deleting" PeeringProvisioningStateFailed PeeringProvisioningState = "Failed" PeeringProvisioningStateSucceeded PeeringProvisioningState = "Succeeded" PeeringProvisioningStateUpdating PeeringProvisioningState = "Updating" )
type PeeringState ¶
type PeeringState string
const ( PeeringStateConnected PeeringState = "Connected" PeeringStateDisconnected PeeringState = "Disconnected" PeeringStateInitiated PeeringState = "Initiated" )
type VNetPeeringClient ¶
func NewVNetPeeringClientWithBaseURI ¶
func NewVNetPeeringClientWithBaseURI(endpoint string) VNetPeeringClient
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) (resp ListByWorkspaceOperationResponse, err error)
ListByWorkspace ...
func (VNetPeeringClient) ListByWorkspaceComplete ¶
func (c VNetPeeringClient) ListByWorkspaceComplete(ctx context.Context, id WorkspaceId) (ListByWorkspaceCompleteResult, error)
ListByWorkspaceComplete retrieves all of the results into a single object
func (VNetPeeringClient) ListByWorkspaceCompleteMatchingPredicate ¶
func (c VNetPeeringClient) ListByWorkspaceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate VirtualNetworkPeeringOperationPredicate) (resp ListByWorkspaceCompleteResult, err error)
ListByWorkspaceCompleteMatchingPredicate retrieves all of the results and then applied 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) 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 ¶
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 ¶
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) 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 ¶
- client.go
- constants.go
- id_virtualnetworkpeering.go
- id_workspace.go
- method_createorupdate_autorest.go
- method_delete_autorest.go
- method_get_autorest.go
- method_listbyworkspace_autorest.go
- model_addressspace.go
- model_virtualnetworkpeering.go
- model_virtualnetworkpeeringpropertiesformat.go
- model_virtualnetworkpeeringpropertiesformatdatabricksvirtualnetwork.go
- model_virtualnetworkpeeringpropertiesformatremotevirtualnetwork.go
- predicates.go
- version.go