workspaceconnections

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2021-07-01/workspaceconnections Documentation

The workspaceconnections SDK allows for interaction with the Azure Resource Manager Service machinelearningservices (API Version 2021-07-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/2021-07-01/workspaceconnections"

Client Initialization

client := workspaceconnections.NewWorkspaceConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkspaceConnectionsClient.Create

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

payload := workspaceconnections.WorkspaceConnection{
	// ...
}


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

Example Usage: WorkspaceConnectionsClient.Delete

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

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

Example Usage: WorkspaceConnectionsClient.Get

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

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: WorkspaceConnectionsClient.List

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

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

Documentation

Index

• func PossibleValuesForValueFormat() []string
• func ValidateConnectionID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
• type ConnectionId
  • func NewConnectionID(subscriptionId string, resourceGroupName string, workspaceName string, ...) ConnectionId
  • func ParseConnectionID(input string) (*ConnectionId, error)
  • func ParseConnectionIDInsensitively(input string) (*ConnectionId, error)
  • func (id ConnectionId) ID() string
  • func (id ConnectionId) Segments() []resourceids.Segment
  • func (id ConnectionId) String() string
• type CreateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
• type ListOperationResponse
• type PaginatedWorkspaceConnectionsList
• type ValueFormat
• type WorkspaceConnection
• type WorkspaceConnectionProps
• type WorkspaceConnectionsClient
  • func NewWorkspaceConnectionsClientWithBaseURI(endpoint string) WorkspaceConnectionsClient
  • func (c WorkspaceConnectionsClient) Create(ctx context.Context, id ConnectionId, input WorkspaceConnection) (result CreateOperationResponse, err error)
  • func (c WorkspaceConnectionsClient) Delete(ctx context.Context, id ConnectionId) (result DeleteOperationResponse, err error)
  • func (c WorkspaceConnectionsClient) Get(ctx context.Context, id ConnectionId) (result GetOperationResponse, err error)
  • func (c WorkspaceConnectionsClient) List(ctx context.Context, id WorkspaceId, options ListOperationOptions) (result ListOperationResponse, err 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) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string

Functions

func PossibleValuesForValueFormat

func PossibleValuesForValueFormat() []string

func ValidateConnectionID

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

ValidateConnectionID checks that 'input' can be parsed as a Connection ID

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 ConnectionId

type ConnectionId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	ConnectionName    string
}

ConnectionId is a struct representing the Resource ID for a Connection

func NewConnectionID

func NewConnectionID(subscriptionId string, resourceGroupName string, workspaceName string, connectionName string) ConnectionId

NewConnectionID returns a new ConnectionId struct

func ParseConnectionID

func ParseConnectionID(input string) (*ConnectionId, error)

ParseConnectionID parses 'input' into a ConnectionId

func ParseConnectionIDInsensitively

func ParseConnectionIDInsensitively(input string) (*ConnectionId, error)

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

func (ConnectionId) ID

func (id ConnectionId) ID() string

ID returns the formatted Connection ID

func (ConnectionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Connection ID

func (ConnectionId) String

func (id ConnectionId) String() string

String returns a human-readable description of this Connection ID

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkspaceConnection
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkspaceConnection
}

type ListOperationOptions

type ListOperationOptions struct {
	Category *string
	Target   *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *PaginatedWorkspaceConnectionsList
}

type PaginatedWorkspaceConnectionsList

type PaginatedWorkspaceConnectionsList struct {
	NextLink *string                `json:"nextLink,omitempty"`
	Value    *[]WorkspaceConnection `json:"value,omitempty"`
}

type ValueFormat

type ValueFormat string

const (
	ValueFormatJSON ValueFormat = "JSON"
)

type WorkspaceConnection

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

type WorkspaceConnectionProps

type WorkspaceConnectionProps struct {
	AuthType    *string      `json:"authType,omitempty"`
	Category    *string      `json:"category,omitempty"`
	Target      *string      `json:"target,omitempty"`
	Value       *string      `json:"value,omitempty"`
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

type WorkspaceConnectionsClient

type WorkspaceConnectionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewWorkspaceConnectionsClientWithBaseURI

func NewWorkspaceConnectionsClientWithBaseURI(endpoint string) WorkspaceConnectionsClient

func (WorkspaceConnectionsClient) Create

func (c WorkspaceConnectionsClient) Create(ctx context.Context, id ConnectionId, input WorkspaceConnection) (result CreateOperationResponse, err error)

Create ...

func (WorkspaceConnectionsClient) Delete

func (c WorkspaceConnectionsClient) Delete(ctx context.Context, id ConnectionId) (result DeleteOperationResponse, err error)

Delete ...

func (WorkspaceConnectionsClient) Get

func (c WorkspaceConnectionsClient) Get(ctx context.Context, id ConnectionId) (result GetOperationResponse, err error)

Get ...

func (WorkspaceConnectionsClient) List

func (c WorkspaceConnectionsClient) List(ctx context.Context, id WorkspaceId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

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) 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