v2workspaceconnectionresource

package
v0.20230427.1112058 Latest Latest
Warning

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

Go to latest
Published: Apr 27, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2023-04-01/v2workspaceconnectionresource Documentation

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

Client Initialization

client := v2workspaceconnectionresource.NewV2WorkspaceConnectionResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: V2WorkspaceConnectionResourceClient.WorkspaceConnectionsCreate

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

payload := v2workspaceconnectionresource.WorkspaceConnectionPropertiesV2BasicResource{
	// ...
}


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

Example Usage: V2WorkspaceConnectionResourceClient.WorkspaceConnectionsDelete

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

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

Example Usage: V2WorkspaceConnectionResourceClient.WorkspaceConnectionsGet

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

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

Example Usage: V2WorkspaceConnectionResourceClient.WorkspaceConnectionsList

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

// alternatively `client.WorkspaceConnectionsList(ctx, id, v2workspaceconnectionresource.DefaultWorkspaceConnectionsListOperationOptions())` can be used to do batched pagination
items, err := client.WorkspaceConnectionsListComplete(ctx, id, v2workspaceconnectionresource.DefaultWorkspaceConnectionsListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForConnectionAuthType

func PossibleValuesForConnectionAuthType() []string

func PossibleValuesForConnectionCategory

func PossibleValuesForConnectionCategory() []string

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 ConnectionAuthType

type ConnectionAuthType string
const (
	ConnectionAuthTypeManagedIdentity  ConnectionAuthType = "ManagedIdentity"
	ConnectionAuthTypeNone             ConnectionAuthType = "None"
	ConnectionAuthTypePAT              ConnectionAuthType = "PAT"
	ConnectionAuthTypeSAS              ConnectionAuthType = "SAS"
	ConnectionAuthTypeUsernamePassword ConnectionAuthType = "UsernamePassword"
)

type ConnectionCategory

type ConnectionCategory string
const (
	ConnectionCategoryContainerRegistry ConnectionCategory = "ContainerRegistry"
	ConnectionCategoryGit               ConnectionCategory = "Git"
	ConnectionCategoryPythonFeed        ConnectionCategory = "PythonFeed"
)

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 ManagedIdentityAuthTypeWorkspaceConnectionProperties

type ManagedIdentityAuthTypeWorkspaceConnectionProperties struct {
	Credentials *WorkspaceConnectionManagedIdentity `json:"credentials,omitempty"`

	// Fields inherited from WorkspaceConnectionPropertiesV2
	Category    *ConnectionCategory `json:"category,omitempty"`
	Target      *string             `json:"target,omitempty"`
	Value       *string             `json:"value,omitempty"`
	ValueFormat *ValueFormat        `json:"valueFormat,omitempty"`
}

func (ManagedIdentityAuthTypeWorkspaceConnectionProperties) MarshalJSON

type NoneAuthTypeWorkspaceConnectionProperties

type NoneAuthTypeWorkspaceConnectionProperties struct {

	// Fields inherited from WorkspaceConnectionPropertiesV2
	Category    *ConnectionCategory `json:"category,omitempty"`
	Target      *string             `json:"target,omitempty"`
	Value       *string             `json:"value,omitempty"`
	ValueFormat *ValueFormat        `json:"valueFormat,omitempty"`
}

func (NoneAuthTypeWorkspaceConnectionProperties) MarshalJSON

type PATAuthTypeWorkspaceConnectionProperties

type PATAuthTypeWorkspaceConnectionProperties struct {
	Credentials *WorkspaceConnectionPersonalAccessToken `json:"credentials,omitempty"`

	// Fields inherited from WorkspaceConnectionPropertiesV2
	Category    *ConnectionCategory `json:"category,omitempty"`
	Target      *string             `json:"target,omitempty"`
	Value       *string             `json:"value,omitempty"`
	ValueFormat *ValueFormat        `json:"valueFormat,omitempty"`
}

func (PATAuthTypeWorkspaceConnectionProperties) MarshalJSON

type SASAuthTypeWorkspaceConnectionProperties

type SASAuthTypeWorkspaceConnectionProperties struct {
	Credentials *WorkspaceConnectionSharedAccessSignature `json:"credentials,omitempty"`

	// Fields inherited from WorkspaceConnectionPropertiesV2
	Category    *ConnectionCategory `json:"category,omitempty"`
	Target      *string             `json:"target,omitempty"`
	Value       *string             `json:"value,omitempty"`
	ValueFormat *ValueFormat        `json:"valueFormat,omitempty"`
}

func (SASAuthTypeWorkspaceConnectionProperties) MarshalJSON

type UsernamePasswordAuthTypeWorkspaceConnectionProperties

type UsernamePasswordAuthTypeWorkspaceConnectionProperties struct {
	Credentials *WorkspaceConnectionUsernamePassword `json:"credentials,omitempty"`

	// Fields inherited from WorkspaceConnectionPropertiesV2
	Category    *ConnectionCategory `json:"category,omitempty"`
	Target      *string             `json:"target,omitempty"`
	Value       *string             `json:"value,omitempty"`
	ValueFormat *ValueFormat        `json:"valueFormat,omitempty"`
}

func (UsernamePasswordAuthTypeWorkspaceConnectionProperties) MarshalJSON

type V2WorkspaceConnectionResourceClient

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

func NewV2WorkspaceConnectionResourceClientWithBaseURI

func NewV2WorkspaceConnectionResourceClientWithBaseURI(endpoint string) V2WorkspaceConnectionResourceClient

func (V2WorkspaceConnectionResourceClient) WorkspaceConnectionsCreate

WorkspaceConnectionsCreate ...

func (V2WorkspaceConnectionResourceClient) WorkspaceConnectionsDelete

WorkspaceConnectionsDelete ...

func (V2WorkspaceConnectionResourceClient) WorkspaceConnectionsGet

WorkspaceConnectionsGet ...

func (V2WorkspaceConnectionResourceClient) WorkspaceConnectionsList

WorkspaceConnectionsList ...

func (V2WorkspaceConnectionResourceClient) WorkspaceConnectionsListComplete

WorkspaceConnectionsListComplete retrieves all of the results into a single object

func (V2WorkspaceConnectionResourceClient) WorkspaceConnectionsListCompleteMatchingPredicate

WorkspaceConnectionsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type ValueFormat

type ValueFormat string
const (
	ValueFormatJSON ValueFormat = "JSON"
)

type WorkspaceConnectionManagedIdentity

type WorkspaceConnectionManagedIdentity struct {
	ClientId   *string `json:"clientId,omitempty"`
	ResourceId *string `json:"resourceId,omitempty"`
}

type WorkspaceConnectionPersonalAccessToken

type WorkspaceConnectionPersonalAccessToken struct {
	Pat *string `json:"pat,omitempty"`
}

type WorkspaceConnectionPropertiesV2

type WorkspaceConnectionPropertiesV2 interface {
}

type WorkspaceConnectionPropertiesV2BasicResource

type WorkspaceConnectionPropertiesV2BasicResource struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties WorkspaceConnectionPropertiesV2 `json:"properties"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

func (*WorkspaceConnectionPropertiesV2BasicResource) UnmarshalJSON

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

type WorkspaceConnectionPropertiesV2BasicResourceOperationPredicate

type WorkspaceConnectionPropertiesV2BasicResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (WorkspaceConnectionPropertiesV2BasicResourceOperationPredicate) Matches

type WorkspaceConnectionSharedAccessSignature

type WorkspaceConnectionSharedAccessSignature struct {
	Sas *string `json:"sas,omitempty"`
}

type WorkspaceConnectionUsernamePassword

type WorkspaceConnectionUsernamePassword struct {
	Password *string `json:"password,omitempty"`
	Username *string `json:"username,omitempty"`
}

type WorkspaceConnectionsCreateOperationResponse

type WorkspaceConnectionsCreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkspaceConnectionPropertiesV2BasicResource
}

type WorkspaceConnectionsDeleteOperationResponse

type WorkspaceConnectionsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type WorkspaceConnectionsGetOperationResponse

type WorkspaceConnectionsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkspaceConnectionPropertiesV2BasicResource
}

type WorkspaceConnectionsListCompleteResult

type WorkspaceConnectionsListCompleteResult struct {
	Items []WorkspaceConnectionPropertiesV2BasicResource
}

type WorkspaceConnectionsListOperationOptions

type WorkspaceConnectionsListOperationOptions struct {
	Category *string
	Target   *string
}

func DefaultWorkspaceConnectionsListOperationOptions

func DefaultWorkspaceConnectionsListOperationOptions() WorkspaceConnectionsListOperationOptions

type WorkspaceConnectionsListOperationResponse

type WorkspaceConnectionsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]WorkspaceConnectionPropertiesV2BasicResource
	// contains filtered or unexported fields
}

func (WorkspaceConnectionsListOperationResponse) HasMore

func (WorkspaceConnectionsListOperationResponse) LoadMore

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL