capabilityhost

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-10-01-preview/capabilityhost Documentation

The capabilityhost SDK allows for interaction with Azure Resource Manager machinelearningservices (API Version 2024-10-01-preview).

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-10-01-preview/capabilityhost"

Client Initialization

client := capabilityhost.NewCapabilityHostClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CapabilityHostClient.CreateOrUpdate

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

payload := capabilityhost.CapabilityHostResource{
	// ...
}


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

Example Usage: CapabilityHostClient.Delete

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

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

Example Usage: CapabilityHostClient.Get

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

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
}

Documentation

Index

• func PossibleValuesForCapabilityHostKind() []string
• func PossibleValuesForCapabilityHostProvisioningState() []string
• func ValidateCapabilityHostID(input interface{}, key string) (warnings []string, errors []error)
• type CapabilityHost
• type CapabilityHostClient
  • func NewCapabilityHostClientWithBaseURI(sdkApi sdkEnv.Api) (*CapabilityHostClient, error)
  • func (c CapabilityHostClient) CreateOrUpdate(ctx context.Context, id CapabilityHostId, input CapabilityHostResource) (result CreateOrUpdateOperationResponse, err error)
  • func (c CapabilityHostClient) CreateOrUpdateThenPoll(ctx context.Context, id CapabilityHostId, input CapabilityHostResource) error
  • func (c CapabilityHostClient) Delete(ctx context.Context, id CapabilityHostId) (result DeleteOperationResponse, err error)
  • func (c CapabilityHostClient) DeleteThenPoll(ctx context.Context, id CapabilityHostId) error
  • func (c CapabilityHostClient) Get(ctx context.Context, id CapabilityHostId) (result GetOperationResponse, err error)
• type CapabilityHostId
  • func NewCapabilityHostID(subscriptionId string, resourceGroupName string, workspaceName string, ...) CapabilityHostId
  • func ParseCapabilityHostID(input string) (*CapabilityHostId, error)
  • func ParseCapabilityHostIDInsensitively(input string) (*CapabilityHostId, error)
  • func (id *CapabilityHostId) FromParseResult(input resourceids.ParseResult) error
  • func (id CapabilityHostId) ID() string
  • func (id CapabilityHostId) Segments() []resourceids.Segment
  • func (id CapabilityHostId) String() string
• type CapabilityHostKind
  • func (s *CapabilityHostKind) UnmarshalJSON(bytes []byte) error
• type CapabilityHostProvisioningState
  • func (s *CapabilityHostProvisioningState) UnmarshalJSON(bytes []byte) error
• type CapabilityHostResource
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse

Functions

func PossibleValuesForCapabilityHostKind

func PossibleValuesForCapabilityHostKind() []string

func PossibleValuesForCapabilityHostProvisioningState

func PossibleValuesForCapabilityHostProvisioningState() []string

func ValidateCapabilityHostID

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

ValidateCapabilityHostID checks that 'input' can be parsed as a Capability Host ID

Types

type CapabilityHost

type CapabilityHost struct {
	AiServicesConnections  *[]string                        `json:"aiServicesConnections,omitempty"`
	CapabilityHostKind     *CapabilityHostKind              `json:"capabilityHostKind,omitempty"`
	CustomerSubnet         *string                          `json:"customerSubnet,omitempty"`
	Description            *string                          `json:"description,omitempty"`
	Properties             *map[string]string               `json:"properties,omitempty"`
	ProvisioningState      *CapabilityHostProvisioningState `json:"provisioningState,omitempty"`
	StorageConnections     *[]string                        `json:"storageConnections,omitempty"`
	Tags                   *map[string]string               `json:"tags,omitempty"`
	VectorStoreConnections *[]string                        `json:"vectorStoreConnections,omitempty"`
}

type CapabilityHostClient

type CapabilityHostClient struct {
	Client *resourcemanager.Client
}

func NewCapabilityHostClientWithBaseURI

func NewCapabilityHostClientWithBaseURI(sdkApi sdkEnv.Api) (*CapabilityHostClient, error)

func (CapabilityHostClient) CreateOrUpdate

func (c CapabilityHostClient) CreateOrUpdate(ctx context.Context, id CapabilityHostId, input CapabilityHostResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (CapabilityHostClient) CreateOrUpdateThenPoll

func (c CapabilityHostClient) CreateOrUpdateThenPoll(ctx context.Context, id CapabilityHostId, input CapabilityHostResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (CapabilityHostClient) Delete

func (c CapabilityHostClient) Delete(ctx context.Context, id CapabilityHostId) (result DeleteOperationResponse, err error)

Delete ...

func (CapabilityHostClient) DeleteThenPoll

func (c CapabilityHostClient) DeleteThenPoll(ctx context.Context, id CapabilityHostId) error

DeleteThenPoll performs Delete then polls until it's completed

func (CapabilityHostClient) Get

func (c CapabilityHostClient) Get(ctx context.Context, id CapabilityHostId) (result GetOperationResponse, err error)

Get ...

type CapabilityHostId

type CapabilityHostId struct {
	SubscriptionId     string
	ResourceGroupName  string
	WorkspaceName      string
	CapabilityHostName string
}

CapabilityHostId is a struct representing the Resource ID for a Capability Host

func NewCapabilityHostID

func NewCapabilityHostID(subscriptionId string, resourceGroupName string, workspaceName string, capabilityHostName string) CapabilityHostId

NewCapabilityHostID returns a new CapabilityHostId struct

func ParseCapabilityHostID

func ParseCapabilityHostID(input string) (*CapabilityHostId, error)

ParseCapabilityHostID parses 'input' into a CapabilityHostId

func ParseCapabilityHostIDInsensitively

func ParseCapabilityHostIDInsensitively(input string) (*CapabilityHostId, error)

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

func (*CapabilityHostId) FromParseResult

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

func (CapabilityHostId) ID

func (id CapabilityHostId) ID() string

ID returns the formatted Capability Host ID

func (CapabilityHostId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Capability Host ID

func (CapabilityHostId) String

func (id CapabilityHostId) String() string

String returns a human-readable description of this Capability Host ID

type CapabilityHostKind

type CapabilityHostKind string

const (
	CapabilityHostKindAgents CapabilityHostKind = "Agents"
)

func (*CapabilityHostKind) UnmarshalJSON

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

type CapabilityHostProvisioningState

type CapabilityHostProvisioningState string

const (
	CapabilityHostProvisioningStateCanceled  CapabilityHostProvisioningState = "Canceled"
	CapabilityHostProvisioningStateCreating  CapabilityHostProvisioningState = "Creating"
	CapabilityHostProvisioningStateDeleting  CapabilityHostProvisioningState = "Deleting"
	CapabilityHostProvisioningStateFailed    CapabilityHostProvisioningState = "Failed"
	CapabilityHostProvisioningStateSucceeded CapabilityHostProvisioningState = "Succeeded"
	CapabilityHostProvisioningStateUpdating  CapabilityHostProvisioningState = "Updating"
)

func (*CapabilityHostProvisioningState) UnmarshalJSON

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

type CapabilityHostResource

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

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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