notebookworkspacesresource

package
v0.20240731.1212841 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/cosmosdb/2024-05-15/notebookworkspacesresource Documentation

The notebookworkspacesresource SDK allows for interaction with the Azure Resource Manager Service cosmosdb (API Version 2024-05-15).

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/cosmosdb/2024-05-15/notebookworkspacesresource"

Client Initialization

client := notebookworkspacesresource.NewNotebookWorkspacesResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NotebookWorkspacesResourceClient.NotebookWorkspacesCreateOrUpdate

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

payload := notebookworkspacesresource.ARMProxyResource{
	// ...
}


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

Example Usage: NotebookWorkspacesResourceClient.NotebookWorkspacesDelete

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

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

Example Usage: NotebookWorkspacesResourceClient.NotebookWorkspacesGet

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

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

Example Usage: NotebookWorkspacesResourceClient.NotebookWorkspacesListByDatabaseAccount

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

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

Example Usage: NotebookWorkspacesResourceClient.NotebookWorkspacesListConnectionInfo

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

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

Example Usage: NotebookWorkspacesResourceClient.NotebookWorkspacesRegenerateAuthToken

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

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

Example Usage: NotebookWorkspacesResourceClient.NotebookWorkspacesStart

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateDatabaseAccountID 

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

ValidateDatabaseAccountID checks that 'input' can be parsed as a Database Account ID

Types

type ARMProxyResource 

type ARMProxyResource struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type DatabaseAccountId 

type DatabaseAccountId struct {
	SubscriptionId      string
	ResourceGroupName   string
	DatabaseAccountName string
}

DatabaseAccountId is a struct representing the Resource ID for a Database Account

func NewDatabaseAccountID 

func NewDatabaseAccountID(subscriptionId string, resourceGroupName string, databaseAccountName string) DatabaseAccountId

NewDatabaseAccountID returns a new DatabaseAccountId struct

func ParseDatabaseAccountID 

func ParseDatabaseAccountID(input string) (*DatabaseAccountId, error)

ParseDatabaseAccountID parses 'input' into a DatabaseAccountId

func ParseDatabaseAccountIDInsensitively 

func ParseDatabaseAccountIDInsensitively(input string) (*DatabaseAccountId, error)

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

func (*DatabaseAccountId) FromParseResult 

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

func (DatabaseAccountId) ID 

func (id DatabaseAccountId) ID() string

ID returns the formatted Database Account ID

func (DatabaseAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Database Account ID

func (DatabaseAccountId) String 

func (id DatabaseAccountId) String() string

String returns a human-readable description of this Database Account ID

type NotebookWorkspace 

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

type NotebookWorkspaceConnectionInfoResult 

type NotebookWorkspaceConnectionInfoResult struct {
	AuthToken              *string `json:"authToken,omitempty"`
	NotebookServerEndpoint *string `json:"notebookServerEndpoint,omitempty"`
}

type NotebookWorkspaceListResult 

type NotebookWorkspaceListResult struct {
	Value *[]NotebookWorkspace `json:"value,omitempty"`
}

type NotebookWorkspaceProperties 

type NotebookWorkspaceProperties struct {
	NotebookServerEndpoint *string `json:"notebookServerEndpoint,omitempty"`
	Status                 *string `json:"status,omitempty"`
}

type NotebookWorkspacesCreateOrUpdateOperationResponse 

type NotebookWorkspacesCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NotebookWorkspace
}

type NotebookWorkspacesDeleteOperationResponse 

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

type NotebookWorkspacesGetOperationResponse 

type NotebookWorkspacesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NotebookWorkspace
}

type NotebookWorkspacesListByDatabaseAccountOperationResponse 

type NotebookWorkspacesListByDatabaseAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NotebookWorkspaceListResult
}

type NotebookWorkspacesListConnectionInfoOperationResponse 

type NotebookWorkspacesListConnectionInfoOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NotebookWorkspaceConnectionInfoResult
}

type NotebookWorkspacesRegenerateAuthTokenOperationResponse 

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

type NotebookWorkspacesResourceClient 

type NotebookWorkspacesResourceClient struct {
	Client *resourcemanager.Client
}

func NewNotebookWorkspacesResourceClientWithBaseURI 

func NewNotebookWorkspacesResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*NotebookWorkspacesResourceClient, error)

func (NotebookWorkspacesResourceClient) NotebookWorkspacesCreateOrUpdate 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesCreateOrUpdate(ctx context.Context, id DatabaseAccountId, input ARMProxyResource) (result NotebookWorkspacesCreateOrUpdateOperationResponse, err error)

NotebookWorkspacesCreateOrUpdate ...

func (NotebookWorkspacesResourceClient) NotebookWorkspacesCreateOrUpdateThenPoll 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesCreateOrUpdateThenPoll(ctx context.Context, id DatabaseAccountId, input ARMProxyResource) error

NotebookWorkspacesCreateOrUpdateThenPoll performs NotebookWorkspacesCreateOrUpdate then polls until it's completed

func (NotebookWorkspacesResourceClient) NotebookWorkspacesDelete 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesDelete(ctx context.Context, id DatabaseAccountId) (result NotebookWorkspacesDeleteOperationResponse, err error)

NotebookWorkspacesDelete ...

func (NotebookWorkspacesResourceClient) NotebookWorkspacesDeleteThenPoll 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesDeleteThenPoll(ctx context.Context, id DatabaseAccountId) error

NotebookWorkspacesDeleteThenPoll performs NotebookWorkspacesDelete then polls until it's completed

func (NotebookWorkspacesResourceClient) NotebookWorkspacesGet 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesGet(ctx context.Context, id DatabaseAccountId) (result NotebookWorkspacesGetOperationResponse, err error)

NotebookWorkspacesGet ...

func (NotebookWorkspacesResourceClient) NotebookWorkspacesListByDatabaseAccount 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesListByDatabaseAccount(ctx context.Context, id DatabaseAccountId) (result NotebookWorkspacesListByDatabaseAccountOperationResponse, err error)

NotebookWorkspacesListByDatabaseAccount ...

func (NotebookWorkspacesResourceClient) NotebookWorkspacesListConnectionInfo 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesListConnectionInfo(ctx context.Context, id DatabaseAccountId) (result NotebookWorkspacesListConnectionInfoOperationResponse, err error)

NotebookWorkspacesListConnectionInfo ...

func (NotebookWorkspacesResourceClient) NotebookWorkspacesRegenerateAuthToken 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesRegenerateAuthToken(ctx context.Context, id DatabaseAccountId) (result NotebookWorkspacesRegenerateAuthTokenOperationResponse, err error)

NotebookWorkspacesRegenerateAuthToken ...

func (NotebookWorkspacesResourceClient) NotebookWorkspacesRegenerateAuthTokenThenPoll 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesRegenerateAuthTokenThenPoll(ctx context.Context, id DatabaseAccountId) error

NotebookWorkspacesRegenerateAuthTokenThenPoll performs NotebookWorkspacesRegenerateAuthToken then polls until it's completed

func (NotebookWorkspacesResourceClient) NotebookWorkspacesStart 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesStart(ctx context.Context, id DatabaseAccountId) (result NotebookWorkspacesStartOperationResponse, err error)

NotebookWorkspacesStart ...

func (NotebookWorkspacesResourceClient) NotebookWorkspacesStartThenPoll 

func (c NotebookWorkspacesResourceClient) NotebookWorkspacesStartThenPoll(ctx context.Context, id DatabaseAccountId) error

NotebookWorkspacesStartThenPoll performs NotebookWorkspacesStart then polls until it's completed

type NotebookWorkspacesStartOperationResponse 

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

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.