workspaces

package
v0.20240527.1094340 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/databricks/2023-02-01/workspaces Documentation

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

Client Initialization

client := workspaces.NewWorkspacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkspacesClient.CreateOrUpdate

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

payload := workspaces.Workspace{
	// ...
}


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

Example Usage: WorkspacesClient.Delete

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

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

Example Usage: WorkspacesClient.Get

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

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

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

payload := workspaces.WorkspaceUpdate{
	// ...
}


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 PossibleValuesForCustomParameterType 

func PossibleValuesForCustomParameterType() []string

func PossibleValuesForEncryptionKeySource 

func PossibleValuesForEncryptionKeySource() []string

func PossibleValuesForKeySource 

func PossibleValuesForKeySource() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState 

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateLinkServiceConnectionStatus 

func PossibleValuesForPrivateLinkServiceConnectionStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForRequiredNsgRules 

func PossibleValuesForRequiredNsgRules() []string

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 CreateOrUpdateOperationResponse 

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

type CreatedBy 

type CreatedBy struct {
	ApplicationId *string `json:"applicationId,omitempty"`
	Oid           *string `json:"oid,omitempty"`
	Puid          *string `json:"puid,omitempty"`
}

type CustomParameterType 

type CustomParameterType string
const (
	CustomParameterTypeBool   CustomParameterType = "Bool"
	CustomParameterTypeObject CustomParameterType = "Object"
	CustomParameterTypeString CustomParameterType = "String"
)

func (*CustomParameterType) UnmarshalJSON 

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

type DeleteOperationResponse 

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

type Encryption 

type Encryption struct {
	KeyName     *string    `json:"KeyName,omitempty"`
	KeySource   *KeySource `json:"keySource,omitempty"`
	Keyvaulturi *string    `json:"keyvaulturi,omitempty"`
	Keyversion  *string    `json:"keyversion,omitempty"`
}

type EncryptionEntitiesDefinition 

type EncryptionEntitiesDefinition struct {
	ManagedDisk     *ManagedDiskEncryption `json:"managedDisk,omitempty"`
	ManagedServices *EncryptionV2          `json:"managedServices,omitempty"`
}

type EncryptionKeySource 

type EncryptionKeySource string
const (
	EncryptionKeySourceMicrosoftPointKeyvault EncryptionKeySource = "Microsoft.Keyvault"
)

func (*EncryptionKeySource) UnmarshalJSON 

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

type EncryptionV2 

type EncryptionV2 struct {
	KeySource          EncryptionKeySource             `json:"keySource"`
	KeyVaultProperties *EncryptionV2KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

type EncryptionV2KeyVaultProperties 

type EncryptionV2KeyVaultProperties struct {
	KeyName     string `json:"keyName"`
	KeyVaultUri string `json:"keyVaultUri"`
	KeyVersion  string `json:"keyVersion"`
}

type GetOperationResponse 

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

type KeySource 

type KeySource string
const (
	KeySourceDefault                KeySource = "Default"
	KeySourceMicrosoftPointKeyvault KeySource = "Microsoft.Keyvault"
)

func (*KeySource) UnmarshalJSON 

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

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionOperationResponse 

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

type ManagedDiskEncryption 

type ManagedDiskEncryption struct {
	KeySource                         EncryptionKeySource                     `json:"keySource"`
	KeyVaultProperties                ManagedDiskEncryptionKeyVaultProperties `json:"keyVaultProperties"`
	RotationToLatestKeyVersionEnabled *bool                                   `json:"rotationToLatestKeyVersionEnabled,omitempty"`
}

type ManagedDiskEncryptionKeyVaultProperties 

type ManagedDiskEncryptionKeyVaultProperties struct {
	KeyName     string `json:"keyName"`
	KeyVaultUri string `json:"keyVaultUri"`
	KeyVersion  string `json:"keyVersion"`
}

type ManagedIdentityConfiguration 

type ManagedIdentityConfiguration struct {
	PrincipalId *string `json:"principalId,omitempty"`
	TenantId    *string `json:"tenantId,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type PrivateEndpoint 

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

type PrivateEndpointConnection 

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

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                   `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
	PrivateEndpointConnectionProvisioningStateUpdating  PrivateEndpointConnectionProvisioningState = "Updating"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON 

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

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                            `json:"actionsRequired,omitempty"`
	Description     *string                            `json:"description,omitempty"`
	Status          PrivateLinkServiceConnectionStatus `json:"status"`
}

type PrivateLinkServiceConnectionStatus 

type PrivateLinkServiceConnectionStatus string
const (
	PrivateLinkServiceConnectionStatusApproved     PrivateLinkServiceConnectionStatus = "Approved"
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	PrivateLinkServiceConnectionStatusPending      PrivateLinkServiceConnectionStatus = "Pending"
	PrivateLinkServiceConnectionStatusRejected     PrivateLinkServiceConnectionStatus = "Rejected"
)

func (*PrivateLinkServiceConnectionStatus) UnmarshalJSON 

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

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"
	ProvisioningStateReady     ProvisioningState = "Ready"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON 

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

type RequiredNsgRules 

type RequiredNsgRules string
const (
	RequiredNsgRulesAllRules               RequiredNsgRules = "AllRules"
	RequiredNsgRulesNoAzureDatabricksRules RequiredNsgRules = "NoAzureDatabricksRules"
	RequiredNsgRulesNoAzureServiceRules    RequiredNsgRules = "NoAzureServiceRules"
)

func (*RequiredNsgRules) UnmarshalJSON 

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

type Sku 

type Sku struct {
	Name string  `json:"name"`
	Tier *string `json:"tier,omitempty"`
}

type UpdateOperationResponse 

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

type Workspace 

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

type WorkspaceCustomBooleanParameter 

type WorkspaceCustomBooleanParameter struct {
	Type  *CustomParameterType `json:"type,omitempty"`
	Value bool                 `json:"value"`
}

type WorkspaceCustomObjectParameter 

type WorkspaceCustomObjectParameter struct {
	Type  *CustomParameterType `json:"type,omitempty"`
	Value interface{}          `json:"value"`
}

type WorkspaceCustomParameters 

type WorkspaceCustomParameters struct {
	AmlWorkspaceId                  *WorkspaceCustomStringParameter  `json:"amlWorkspaceId,omitempty"`
	CustomPrivateSubnetName         *WorkspaceCustomStringParameter  `json:"customPrivateSubnetName,omitempty"`
	CustomPublicSubnetName          *WorkspaceCustomStringParameter  `json:"customPublicSubnetName,omitempty"`
	CustomVirtualNetworkId          *WorkspaceCustomStringParameter  `json:"customVirtualNetworkId,omitempty"`
	EnableNoPublicIP                *WorkspaceCustomBooleanParameter `json:"enableNoPublicIp,omitempty"`
	Encryption                      *WorkspaceEncryptionParameter    `json:"encryption,omitempty"`
	LoadBalancerBackendPoolName     *WorkspaceCustomStringParameter  `json:"loadBalancerBackendPoolName,omitempty"`
	LoadBalancerId                  *WorkspaceCustomStringParameter  `json:"loadBalancerId,omitempty"`
	NatGatewayName                  *WorkspaceCustomStringParameter  `json:"natGatewayName,omitempty"`
	PrepareEncryption               *WorkspaceCustomBooleanParameter `json:"prepareEncryption,omitempty"`
	PublicIPName                    *WorkspaceCustomStringParameter  `json:"publicIpName,omitempty"`
	RequireInfrastructureEncryption *WorkspaceCustomBooleanParameter `json:"requireInfrastructureEncryption,omitempty"`
	ResourceTags                    *WorkspaceCustomObjectParameter  `json:"resourceTags,omitempty"`
	StorageAccountName              *WorkspaceCustomStringParameter  `json:"storageAccountName,omitempty"`
	StorageAccountSkuName           *WorkspaceCustomStringParameter  `json:"storageAccountSkuName,omitempty"`
	VnetAddressPrefix               *WorkspaceCustomStringParameter  `json:"vnetAddressPrefix,omitempty"`
}

type WorkspaceCustomStringParameter 

type WorkspaceCustomStringParameter struct {
	Type  *CustomParameterType `json:"type,omitempty"`
	Value string               `json:"value"`
}

type WorkspaceEncryptionParameter 

type WorkspaceEncryptionParameter struct {
	Type  *CustomParameterType `json:"type,omitempty"`
	Value *Encryption          `json:"value,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

type WorkspaceOperationPredicate 

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

func (WorkspaceOperationPredicate) Matches 

func (p WorkspaceOperationPredicate) Matches(input Workspace) bool

type WorkspaceProperties 

type WorkspaceProperties struct {
	Authorizations             *[]WorkspaceProviderAuthorization `json:"authorizations,omitempty"`
	CreatedBy                  *CreatedBy                        `json:"createdBy,omitempty"`
	CreatedDateTime            *string                           `json:"createdDateTime,omitempty"`
	DiskEncryptionSetId        *string                           `json:"diskEncryptionSetId,omitempty"`
	Encryption                 *WorkspacePropertiesEncryption    `json:"encryption,omitempty"`
	ManagedDiskIdentity        *ManagedIdentityConfiguration     `json:"managedDiskIdentity,omitempty"`
	ManagedResourceGroupId     string                            `json:"managedResourceGroupId"`
	Parameters                 *WorkspaceCustomParameters        `json:"parameters,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection      `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *ProvisioningState                `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess              `json:"publicNetworkAccess,omitempty"`
	RequiredNsgRules           *RequiredNsgRules                 `json:"requiredNsgRules,omitempty"`
	StorageAccountIdentity     *ManagedIdentityConfiguration     `json:"storageAccountIdentity,omitempty"`
	UiDefinitionUri            *string                           `json:"uiDefinitionUri,omitempty"`
	UpdatedBy                  *CreatedBy                        `json:"updatedBy,omitempty"`
	WorkspaceId                *string                           `json:"workspaceId,omitempty"`
	WorkspaceUrl               *string                           `json:"workspaceUrl,omitempty"`
}

func (*WorkspaceProperties) GetCreatedDateTimeAsTime 

func (o *WorkspaceProperties) GetCreatedDateTimeAsTime() (*time.Time, error)

func (*WorkspaceProperties) SetCreatedDateTimeAsTime 

func (o *WorkspaceProperties) SetCreatedDateTimeAsTime(input time.Time)

type WorkspacePropertiesEncryption 

type WorkspacePropertiesEncryption struct {
	Entities EncryptionEntitiesDefinition `json:"entities"`
}

type WorkspaceProviderAuthorization 

type WorkspaceProviderAuthorization struct {
	PrincipalId      string `json:"principalId"`
	RoleDefinitionId string `json:"roleDefinitionId"`
}

type WorkspaceUpdate 

type WorkspaceUpdate struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type WorkspacesClient 

type WorkspacesClient struct {
	Client *resourcemanager.Client
}

func NewWorkspacesClientWithBaseURI 

func NewWorkspacesClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspacesClient, error)

func (WorkspacesClient) CreateOrUpdate 

func (c WorkspacesClient) CreateOrUpdate(ctx context.Context, id WorkspaceId, input Workspace) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (WorkspacesClient) CreateOrUpdateThenPoll 

func (c WorkspacesClient) CreateOrUpdateThenPoll(ctx context.Context, id WorkspaceId, input Workspace) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (WorkspacesClient) Delete 

func (c WorkspacesClient) Delete(ctx context.Context, id WorkspaceId) (result DeleteOperationResponse, err error)

Delete ...

func (WorkspacesClient) DeleteThenPoll 

func (c WorkspacesClient) DeleteThenPoll(ctx context.Context, id WorkspaceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (WorkspacesClient) Get 

func (c WorkspacesClient) Get(ctx context.Context, id WorkspaceId) (result GetOperationResponse, err error)

Get ...

func (WorkspacesClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (WorkspacesClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (WorkspacesClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WorkspacesClient) ListBySubscription 

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

ListBySubscription ...

func (WorkspacesClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (WorkspacesClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WorkspacesClient) Update 

func (c WorkspacesClient) Update(ctx context.Context, id WorkspaceId, input WorkspaceUpdate) (result UpdateOperationResponse, err error)

Update ...

func (WorkspacesClient) UpdateThenPoll 

func (c WorkspacesClient) UpdateThenPoll(ctx context.Context, id WorkspaceId, input WorkspaceUpdate) error

UpdateThenPoll performs Update then polls until it's completed

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.