onlineendpoint

package
v0.20231214.1140441 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2022-05-01/onlineendpoint Documentation

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

Client Initialization

client := onlineendpoint.NewOnlineEndpointClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OnlineEndpointClient.CreateOrUpdate

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

payload := onlineendpoint.OnlineEndpointTrackedResource{
	// ...
}


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

Example Usage: OnlineEndpointClient.Delete

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

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

Example Usage: OnlineEndpointClient.Get

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

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: OnlineEndpointClient.GetToken

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

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

Example Usage: OnlineEndpointClient.List

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

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

Example Usage: OnlineEndpointClient.ListKeys

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

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

Example Usage: OnlineEndpointClient.RegenerateKeys

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

payload := onlineendpoint.RegenerateEndpointKeysRequest{
	// ...
}


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

Example Usage: OnlineEndpointClient.Update

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

payload := onlineendpoint.PartialMinimalTrackedResourceWithIdentity{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEndpointAuthMode 

func PossibleValuesForEndpointAuthMode() []string

func PossibleValuesForEndpointComputeType 

func PossibleValuesForEndpointComputeType() []string

func PossibleValuesForEndpointProvisioningState 

func PossibleValuesForEndpointProvisioningState() []string

func PossibleValuesForKeyType 

func PossibleValuesForKeyType() []string

func PossibleValuesForManagedServiceIdentityType 

func PossibleValuesForManagedServiceIdentityType() []string

func PossibleValuesForOrderString 

func PossibleValuesForOrderString() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func ValidateOnlineEndpointID 

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

ValidateOnlineEndpointID checks that 'input' can be parsed as a Online Endpoint 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 CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type EndpointAuthKeys 

type EndpointAuthKeys struct {
	PrimaryKey   *string `json:"primaryKey,omitempty"`
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

type EndpointAuthMode 

type EndpointAuthMode string
const (
	EndpointAuthModeAADToken EndpointAuthMode = "AADToken"
	EndpointAuthModeAMLToken EndpointAuthMode = "AMLToken"
	EndpointAuthModeKey      EndpointAuthMode = "Key"
)

func (*EndpointAuthMode) UnmarshalJSON added in v0.20230713.1092427 

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

type EndpointAuthToken 

type EndpointAuthToken struct {
	AccessToken         *string `json:"accessToken,omitempty"`
	ExpiryTimeUtc       *int64  `json:"expiryTimeUtc,omitempty"`
	RefreshAfterTimeUtc *int64  `json:"refreshAfterTimeUtc,omitempty"`
	TokenType           *string `json:"tokenType,omitempty"`
}

type EndpointComputeType 

type EndpointComputeType string
const (
	EndpointComputeTypeAzureMLCompute EndpointComputeType = "AzureMLCompute"
	EndpointComputeTypeKubernetes     EndpointComputeType = "Kubernetes"
	EndpointComputeTypeManaged        EndpointComputeType = "Managed"
)

func (*EndpointComputeType) UnmarshalJSON added in v0.20230713.1092427 

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

type EndpointProvisioningState 

type EndpointProvisioningState string
const (
	EndpointProvisioningStateCanceled  EndpointProvisioningState = "Canceled"
	EndpointProvisioningStateCreating  EndpointProvisioningState = "Creating"
	EndpointProvisioningStateDeleting  EndpointProvisioningState = "Deleting"
	EndpointProvisioningStateFailed    EndpointProvisioningState = "Failed"
	EndpointProvisioningStateSucceeded EndpointProvisioningState = "Succeeded"
	EndpointProvisioningStateUpdating  EndpointProvisioningState = "Updating"
)

func (*EndpointProvisioningState) UnmarshalJSON added in v0.20230713.1092427 

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

type GetOperationResponse 

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

type GetTokenOperationResponse 

type GetTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EndpointAuthToken
}

type KeyType 

type KeyType string
const (
	KeyTypePrimary   KeyType = "Primary"
	KeyTypeSecondary KeyType = "Secondary"
)

func (*KeyType) UnmarshalJSON added in v0.20230713.1092427 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []OnlineEndpointTrackedResource
}

type ListKeysOperationResponse 

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EndpointAuthKeys
}

type ListOperationOptions 

type ListOperationOptions struct {
	ComputeType *EndpointComputeType
	Count       *int64
	Name        *string
	OrderBy     *OrderString
	Properties  *string
	Skip        *string
	Tags        *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230713.1092427 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230713.1092427 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230713.1092427 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]OnlineEndpointTrackedResource
}

type ManagedServiceIdentityType 

type ManagedServiceIdentityType string
const (
	ManagedServiceIdentityTypeNone                       ManagedServiceIdentityType = "None"
	ManagedServiceIdentityTypeSystemAssigned             ManagedServiceIdentityType = "SystemAssigned"
	ManagedServiceIdentityTypeSystemAssignedUserAssigned ManagedServiceIdentityType = "SystemAssigned,UserAssigned"
	ManagedServiceIdentityTypeUserAssigned               ManagedServiceIdentityType = "UserAssigned"
)

func (*ManagedServiceIdentityType) UnmarshalJSON added in v0.20230713.1092427 

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

type OnlineEndpoint 

type OnlineEndpoint struct {
	AuthMode          EndpointAuthMode           `json:"authMode"`
	Compute           *string                    `json:"compute,omitempty"`
	Description       *string                    `json:"description,omitempty"`
	Keys              *EndpointAuthKeys          `json:"keys,omitempty"`
	Properties        *map[string]string         `json:"properties,omitempty"`
	ProvisioningState *EndpointProvisioningState `json:"provisioningState,omitempty"`
	ScoringUri        *string                    `json:"scoringUri,omitempty"`
	SwaggerUri        *string                    `json:"swaggerUri,omitempty"`
	Traffic           *map[string]int64          `json:"traffic,omitempty"`
}

type OnlineEndpointClient 

type OnlineEndpointClient struct {
	Client *resourcemanager.Client
}

func NewOnlineEndpointClientWithBaseURI 

func NewOnlineEndpointClientWithBaseURI(sdkApi sdkEnv.Api) (*OnlineEndpointClient, error)

func (OnlineEndpointClient) CreateOrUpdate 

func (c OnlineEndpointClient) CreateOrUpdate(ctx context.Context, id OnlineEndpointId, input OnlineEndpointTrackedResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (OnlineEndpointClient) CreateOrUpdateThenPoll 

func (c OnlineEndpointClient) CreateOrUpdateThenPoll(ctx context.Context, id OnlineEndpointId, input OnlineEndpointTrackedResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (OnlineEndpointClient) Delete 

func (c OnlineEndpointClient) Delete(ctx context.Context, id OnlineEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (OnlineEndpointClient) DeleteThenPoll 

func (c OnlineEndpointClient) DeleteThenPoll(ctx context.Context, id OnlineEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (OnlineEndpointClient) Get 

func (c OnlineEndpointClient) Get(ctx context.Context, id OnlineEndpointId) (result GetOperationResponse, err error)

Get ...

func (OnlineEndpointClient) GetToken 

func (c OnlineEndpointClient) GetToken(ctx context.Context, id OnlineEndpointId) (result GetTokenOperationResponse, err error)

GetToken ...

func (OnlineEndpointClient) List 

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

List ...

func (OnlineEndpointClient) ListComplete 

func (c OnlineEndpointClient) ListComplete(ctx context.Context, id WorkspaceId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (OnlineEndpointClient) ListCompleteMatchingPredicate 

func (c OnlineEndpointClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate OnlineEndpointTrackedResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OnlineEndpointClient) ListKeys 

func (c OnlineEndpointClient) ListKeys(ctx context.Context, id OnlineEndpointId) (result ListKeysOperationResponse, err error)

ListKeys ...

func (OnlineEndpointClient) RegenerateKeys 

func (c OnlineEndpointClient) RegenerateKeys(ctx context.Context, id OnlineEndpointId, input RegenerateEndpointKeysRequest) (result RegenerateKeysOperationResponse, err error)

RegenerateKeys ...

func (OnlineEndpointClient) RegenerateKeysThenPoll 

func (c OnlineEndpointClient) RegenerateKeysThenPoll(ctx context.Context, id OnlineEndpointId, input RegenerateEndpointKeysRequest) error

RegenerateKeysThenPoll performs RegenerateKeys then polls until it's completed

func (OnlineEndpointClient) Update 

func (c OnlineEndpointClient) Update(ctx context.Context, id OnlineEndpointId, input PartialMinimalTrackedResourceWithIdentity) (result UpdateOperationResponse, err error)

Update ...

func (OnlineEndpointClient) UpdateThenPoll 

func (c OnlineEndpointClient) UpdateThenPoll(ctx context.Context, id OnlineEndpointId, input PartialMinimalTrackedResourceWithIdentity) error

UpdateThenPoll performs Update then polls until it's completed

type OnlineEndpointId 

type OnlineEndpointId struct {
	SubscriptionId     string
	ResourceGroupName  string
	WorkspaceName      string
	OnlineEndpointName string
}

OnlineEndpointId is a struct representing the Resource ID for a Online Endpoint

func NewOnlineEndpointID 

func NewOnlineEndpointID(subscriptionId string, resourceGroupName string, workspaceName string, onlineEndpointName string) OnlineEndpointId

NewOnlineEndpointID returns a new OnlineEndpointId struct

func ParseOnlineEndpointID 

func ParseOnlineEndpointID(input string) (*OnlineEndpointId, error)

ParseOnlineEndpointID parses 'input' into a OnlineEndpointId

func ParseOnlineEndpointIDInsensitively 

func ParseOnlineEndpointIDInsensitively(input string) (*OnlineEndpointId, error)

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

func (*OnlineEndpointId) FromParseResult added in v0.20231127.1171502 

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

func (OnlineEndpointId) ID 

func (id OnlineEndpointId) ID() string

ID returns the formatted Online Endpoint ID

func (OnlineEndpointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Online Endpoint ID

func (OnlineEndpointId) String 

func (id OnlineEndpointId) String() string

String returns a human-readable description of this Online Endpoint ID

type OnlineEndpointTrackedResource 

type OnlineEndpointTrackedResource struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Kind       *string                                  `json:"kind,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties OnlineEndpoint                           `json:"properties"`
	Sku        *Sku                                     `json:"sku,omitempty"`
	SystemData *systemdata.SystemData                   `json:"systemData,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type OnlineEndpointTrackedResourceOperationPredicate 

type OnlineEndpointTrackedResourceOperationPredicate struct {
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (OnlineEndpointTrackedResourceOperationPredicate) Matches 

func (p OnlineEndpointTrackedResourceOperationPredicate) Matches(input OnlineEndpointTrackedResource) bool

type OrderString 

type OrderString string
const (
	OrderStringCreatedAtAsc  OrderString = "CreatedAtAsc"
	OrderStringCreatedAtDesc OrderString = "CreatedAtDesc"
	OrderStringUpdatedAtAsc  OrderString = "UpdatedAtAsc"
	OrderStringUpdatedAtDesc OrderString = "UpdatedAtDesc"
)

func (*OrderString) UnmarshalJSON added in v0.20230713.1092427 

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

type PartialManagedServiceIdentity 

type PartialManagedServiceIdentity struct {
	Type                   *ManagedServiceIdentityType `json:"type,omitempty"`
	UserAssignedIdentities *map[string]interface{}     `json:"userAssignedIdentities,omitempty"`
}

type PartialMinimalTrackedResourceWithIdentity 

type PartialMinimalTrackedResourceWithIdentity struct {
	Identity *PartialManagedServiceIdentity `json:"identity,omitempty"`
	Tags     *map[string]string             `json:"tags,omitempty"`
}

type RegenerateEndpointKeysRequest 

type RegenerateEndpointKeysRequest struct {
	KeyType  KeyType `json:"keyType"`
	KeyValue *string `json:"keyValue,omitempty"`
}

type RegenerateKeysOperationResponse 

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

type Sku 

type Sku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Family   *string  `json:"family,omitempty"`
	Name     string   `json:"name"`
	Size     *string  `json:"size,omitempty"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type SkuTier 

type SkuTier string
const (
	SkuTierBasic    SkuTier = "Basic"
	SkuTierFree     SkuTier = "Free"
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON added in v0.20230713.1092427 

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

type UpdateOperationResponse 

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

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 added in v0.20231127.1171502 

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

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.