proxyoperations

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-04-01/proxyoperations Documentation

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

Client Initialization

client := proxyoperations.NewProxyOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProxyOperationsClient.WorkspacesListNotebookKeys

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

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

Example Usage: ProxyOperationsClient.WorkspacesListStorageAccountKeys

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

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

Example Usage: ProxyOperationsClient.WorkspacesPrepareNotebook

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

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

Documentation

Index

• func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
• type ListNotebookKeysResult
• type ListStorageAccountKeysResult
• type NotebookPreparationError
• type NotebookResourceInfo
• type ProxyOperationsClient
  • func NewProxyOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ProxyOperationsClient, error)
  • func (c ProxyOperationsClient) WorkspacesListNotebookKeys(ctx context.Context, id WorkspaceId) (result WorkspacesListNotebookKeysOperationResponse, err error)
  • func (c ProxyOperationsClient) WorkspacesListStorageAccountKeys(ctx context.Context, id WorkspaceId) (result WorkspacesListStorageAccountKeysOperationResponse, err error)
  • func (c ProxyOperationsClient) WorkspacesPrepareNotebook(ctx context.Context, id WorkspaceId) (result WorkspacesPrepareNotebookOperationResponse, err error)
  • func (c ProxyOperationsClient) WorkspacesPrepareNotebookThenPoll(ctx context.Context, id WorkspaceId) error
• type WorkspaceId
  • func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
  • func ParseWorkspaceID(input string) (*WorkspaceId, error)
  • func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
  • func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error
  • func (id WorkspaceId) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string
• type WorkspacesListNotebookKeysOperationResponse
• type WorkspacesListStorageAccountKeysOperationResponse
• type WorkspacesPrepareNotebookOperationResponse

Functions

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 ListNotebookKeysResult

type ListNotebookKeysResult struct {
	PrimaryAccessKey   *string `json:"primaryAccessKey,omitempty"`
	SecondaryAccessKey *string `json:"secondaryAccessKey,omitempty"`
}

type ListStorageAccountKeysResult

type ListStorageAccountKeysResult struct {
	UserStorageKey *string `json:"userStorageKey,omitempty"`
}

type NotebookPreparationError

type NotebookPreparationError struct {
	ErrorMessage *string `json:"errorMessage,omitempty"`
	StatusCode   *int64  `json:"statusCode,omitempty"`
}

type NotebookResourceInfo

type NotebookResourceInfo struct {
	Fqdn                     *string                   `json:"fqdn,omitempty"`
	NotebookPreparationError *NotebookPreparationError `json:"notebookPreparationError,omitempty"`
	ResourceId               *string                   `json:"resourceId,omitempty"`
}

type ProxyOperationsClient

type ProxyOperationsClient struct {
	Client *resourcemanager.Client
}

func NewProxyOperationsClientWithBaseURI

func NewProxyOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ProxyOperationsClient, error)

func (ProxyOperationsClient) WorkspacesListNotebookKeys

func (c ProxyOperationsClient) WorkspacesListNotebookKeys(ctx context.Context, id WorkspaceId) (result WorkspacesListNotebookKeysOperationResponse, err error)

WorkspacesListNotebookKeys ...

func (ProxyOperationsClient) WorkspacesListStorageAccountKeys

func (c ProxyOperationsClient) WorkspacesListStorageAccountKeys(ctx context.Context, id WorkspaceId) (result WorkspacesListStorageAccountKeysOperationResponse, err error)

WorkspacesListStorageAccountKeys ...

func (ProxyOperationsClient) WorkspacesPrepareNotebook

func (c ProxyOperationsClient) WorkspacesPrepareNotebook(ctx context.Context, id WorkspaceId) (result WorkspacesPrepareNotebookOperationResponse, err error)

WorkspacesPrepareNotebook ...

func (ProxyOperationsClient) WorkspacesPrepareNotebookThenPoll

func (c ProxyOperationsClient) WorkspacesPrepareNotebookThenPoll(ctx context.Context, id WorkspaceId) error

WorkspacesPrepareNotebookThenPoll performs WorkspacesPrepareNotebook then polls until it's completed

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 WorkspacesListNotebookKeysOperationResponse

type WorkspacesListNotebookKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListNotebookKeysResult
}

type WorkspacesListStorageAccountKeysOperationResponse

type WorkspacesListStorageAccountKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListStorageAccountKeysResult
}

type WorkspacesPrepareNotebookOperationResponse

type WorkspacesPrepareNotebookOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NotebookResourceInfo
}