accessconnector

package
v0.20240610.1112704 Latest Latest
Warning

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

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

README

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

The accessconnector SDK allows for interaction with the Azure Resource Manager Service 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/databricks/2024-05-01/accessconnector"

Client Initialization

client := accessconnector.NewAccessConnectorClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AccessConnectorClient.CreateOrUpdate

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

payload := accessconnector.AccessConnector{
	// ...
}


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

Example Usage: AccessConnectorClient.Delete

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

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

Example Usage: AccessConnectorClient.Get

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

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: AccessConnectorClient.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: AccessConnectorClient.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: AccessConnectorClient.Update

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

payload := accessconnector.AccessConnectorUpdate{
	// ...
}


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 PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateAccessConnectorID 

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

ValidateAccessConnectorID checks that 'input' can be parsed as a Access Connector ID

Types

type AccessConnector 

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

type AccessConnectorClient 

type AccessConnectorClient struct {
	Client *resourcemanager.Client
}

func NewAccessConnectorClientWithBaseURI 

func NewAccessConnectorClientWithBaseURI(sdkApi sdkEnv.Api) (*AccessConnectorClient, error)

func (AccessConnectorClient) CreateOrUpdate 

func (c AccessConnectorClient) CreateOrUpdate(ctx context.Context, id AccessConnectorId, input AccessConnector) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AccessConnectorClient) CreateOrUpdateThenPoll 

func (c AccessConnectorClient) CreateOrUpdateThenPoll(ctx context.Context, id AccessConnectorId, input AccessConnector) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AccessConnectorClient) Delete 

func (c AccessConnectorClient) Delete(ctx context.Context, id AccessConnectorId) (result DeleteOperationResponse, err error)

Delete ...

func (AccessConnectorClient) DeleteThenPoll 

func (c AccessConnectorClient) DeleteThenPoll(ctx context.Context, id AccessConnectorId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AccessConnectorClient) Get 

func (c AccessConnectorClient) Get(ctx context.Context, id AccessConnectorId) (result GetOperationResponse, err error)

Get ...

func (AccessConnectorClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (AccessConnectorClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (AccessConnectorClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AccessConnectorClient) ListBySubscription 

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

ListBySubscription ...

func (AccessConnectorClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (AccessConnectorClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AccessConnectorClient) Update 

func (c AccessConnectorClient) Update(ctx context.Context, id AccessConnectorId, input AccessConnectorUpdate) (result UpdateOperationResponse, err error)

Update ...

func (AccessConnectorClient) UpdateThenPoll 

func (c AccessConnectorClient) UpdateThenPoll(ctx context.Context, id AccessConnectorId, input AccessConnectorUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type AccessConnectorId 

type AccessConnectorId struct {
	SubscriptionId      string
	ResourceGroupName   string
	AccessConnectorName string
}

AccessConnectorId is a struct representing the Resource ID for a Access Connector

func NewAccessConnectorID 

func NewAccessConnectorID(subscriptionId string, resourceGroupName string, accessConnectorName string) AccessConnectorId

NewAccessConnectorID returns a new AccessConnectorId struct

func ParseAccessConnectorID 

func ParseAccessConnectorID(input string) (*AccessConnectorId, error)

ParseAccessConnectorID parses 'input' into a AccessConnectorId

func ParseAccessConnectorIDInsensitively 

func ParseAccessConnectorIDInsensitively(input string) (*AccessConnectorId, error)

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

func (*AccessConnectorId) FromParseResult 

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

func (AccessConnectorId) ID 

func (id AccessConnectorId) ID() string

ID returns the formatted Access Connector ID

func (AccessConnectorId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Access Connector ID

func (AccessConnectorId) String 

func (id AccessConnectorId) String() string

String returns a human-readable description of this Access Connector ID

type AccessConnectorOperationPredicate 

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

func (AccessConnectorOperationPredicate) Matches 

func (p AccessConnectorOperationPredicate) Matches(input AccessConnector) bool

type AccessConnectorProperties 

type AccessConnectorProperties struct {
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	ReferedBy         *[]string          `json:"referedBy,omitempty"`
}

type AccessConnectorUpdate 

type AccessConnectorUpdate struct {
	Identity *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Tags     *map[string]string                       `json:"tags,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

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        *AccessConnector
}

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionOperationResponse 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateDeleted   ProvisioningState = "Deleted"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

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        *AccessConnector
}

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.