batchendpoint

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

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

The batchendpoint 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/batchendpoint"

Client Initialization

client := batchendpoint.NewBatchEndpointClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BatchEndpointClient.CreateOrUpdate

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

payload := batchendpoint.BatchEndpointTrackedResource{
	// ...
}


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

Example Usage: BatchEndpointClient.Delete

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

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

Example Usage: BatchEndpointClient.Get

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

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

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

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

Example Usage: BatchEndpointClient.ListKeys

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

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: BatchEndpointClient.Update

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

payload := batchendpoint.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 PossibleValuesForEndpointProvisioningState 

func PossibleValuesForEndpointProvisioningState() []string

func PossibleValuesForManagedServiceIdentityType 

func PossibleValuesForManagedServiceIdentityType() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func ValidateBatchEndpointID 

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

ValidateBatchEndpointID checks that 'input' can be parsed as a Batch 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 BatchEndpoint 

type BatchEndpoint struct {
	AuthMode          EndpointAuthMode           `json:"authMode"`
	Defaults          *BatchEndpointDefaults     `json:"defaults,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"`
}

type BatchEndpointClient 

type BatchEndpointClient struct {
	Client *resourcemanager.Client
}

func NewBatchEndpointClientWithBaseURI 

func NewBatchEndpointClientWithBaseURI(sdkApi sdkEnv.Api) (*BatchEndpointClient, error)

func (BatchEndpointClient) CreateOrUpdate 

func (c BatchEndpointClient) CreateOrUpdate(ctx context.Context, id BatchEndpointId, input BatchEndpointTrackedResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (BatchEndpointClient) CreateOrUpdateThenPoll 

func (c BatchEndpointClient) CreateOrUpdateThenPoll(ctx context.Context, id BatchEndpointId, input BatchEndpointTrackedResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (BatchEndpointClient) Delete 

func (c BatchEndpointClient) Delete(ctx context.Context, id BatchEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (BatchEndpointClient) DeleteThenPoll 

func (c BatchEndpointClient) DeleteThenPoll(ctx context.Context, id BatchEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (BatchEndpointClient) Get 

func (c BatchEndpointClient) Get(ctx context.Context, id BatchEndpointId) (result GetOperationResponse, err error)

Get ...

func (BatchEndpointClient) List 

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

List ...

func (BatchEndpointClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (BatchEndpointClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BatchEndpointClient) ListKeys 

func (c BatchEndpointClient) ListKeys(ctx context.Context, id BatchEndpointId) (result ListKeysOperationResponse, err error)

ListKeys ...

func (BatchEndpointClient) Update 

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

Update ...

func (BatchEndpointClient) UpdateThenPoll 

func (c BatchEndpointClient) UpdateThenPoll(ctx context.Context, id BatchEndpointId, input PartialMinimalTrackedResourceWithIdentity) error

UpdateThenPoll performs Update then polls until it's completed

type BatchEndpointDefaults 

type BatchEndpointDefaults struct {
	DeploymentName *string `json:"deploymentName,omitempty"`
}

type BatchEndpointId 

type BatchEndpointId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	BatchEndpointName string
}

BatchEndpointId is a struct representing the Resource ID for a Batch Endpoint

func NewBatchEndpointID 

func NewBatchEndpointID(subscriptionId string, resourceGroupName string, workspaceName string, batchEndpointName string) BatchEndpointId

NewBatchEndpointID returns a new BatchEndpointId struct

func ParseBatchEndpointID 

func ParseBatchEndpointID(input string) (*BatchEndpointId, error)

ParseBatchEndpointID parses 'input' into a BatchEndpointId

func ParseBatchEndpointIDInsensitively 

func ParseBatchEndpointIDInsensitively(input string) (*BatchEndpointId, error)

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

func (*BatchEndpointId) FromParseResult 

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

func (BatchEndpointId) ID 

func (id BatchEndpointId) ID() string

ID returns the formatted Batch Endpoint ID

func (BatchEndpointId) Segments 

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

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

func (BatchEndpointId) String 

func (id BatchEndpointId) String() string

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

type BatchEndpointTrackedResource 

type BatchEndpointTrackedResource 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 BatchEndpoint                            `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 BatchEndpointTrackedResourceOperationPredicate 

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

func (BatchEndpointTrackedResourceOperationPredicate) Matches 

func (p BatchEndpointTrackedResourceOperationPredicate) Matches(input BatchEndpointTrackedResource) bool

type CreateOrUpdateOperationResponse 

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

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 

func (s *EndpointAuthMode) 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 

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

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BatchEndpointTrackedResource
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListKeysOperationResponse 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Count *int64
	Skip  *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

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

type ManagedServiceIdentityType 

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

func (*ManagedServiceIdentityType) UnmarshalJSON 

func (s *ManagedServiceIdentityType) 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 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 

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

type UpdateOperationResponse 

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

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

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.