inferenceendpoint

package
v0.20250115.1141151 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2025 License: MPL-2.0 Imports: 14 Imported by: 0

README

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

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

Client Initialization

client := inferenceendpoint.NewInferenceEndpointClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: InferenceEndpointClient.CreateOrUpdate

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

payload := inferenceendpoint.InferenceEndpointTrackedResource{
	// ...
}


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

Example Usage: InferenceEndpointClient.Delete

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

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

Example Usage: InferenceEndpointClient.Get

ctx := context.TODO()
id := inferenceendpoint.NewInferencePoolEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "inferencePoolName", "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: InferenceEndpointClient.List

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

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

Example Usage: InferenceEndpointClient.Update

ctx := context.TODO()
id := inferenceendpoint.NewInferencePoolEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "inferencePoolName", "endpointName")
var payload interface{}

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 PossibleValuesForAuthMode 

func PossibleValuesForAuthMode() []string

func PossibleValuesForOrderString 

func PossibleValuesForOrderString() []string

func PossibleValuesForPoolProvisioningState 

func PossibleValuesForPoolProvisioningState() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func ValidateInferencePoolEndpointID 

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

ValidateInferencePoolEndpointID checks that 'input' can be parsed as a Inference Pool Endpoint ID

func ValidateInferencePoolID 

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

ValidateInferencePoolID checks that 'input' can be parsed as a Inference Pool ID

Types

type AuthMode 

type AuthMode string
const (
	AuthModeAAD AuthMode = "AAD"
)

func (*AuthMode) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

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        *InferenceEndpointTrackedResource
}

type InferenceEndpoint 

type InferenceEndpoint struct {
	AuthMode             AuthMode                    `json:"authMode"`
	Description          *string                     `json:"description,omitempty"`
	EndpointUri          *string                     `json:"endpointUri,omitempty"`
	GroupName            string                      `json:"groupName"`
	Properties           *[]StringStringKeyValuePair `json:"properties,omitempty"`
	ProvisioningState    *PoolProvisioningState      `json:"provisioningState,omitempty"`
	RequestConfiguration *RequestConfiguration       `json:"requestConfiguration,omitempty"`
}

type InferenceEndpointClient 

type InferenceEndpointClient struct {
	Client *resourcemanager.Client
}

func NewInferenceEndpointClientWithBaseURI 

func NewInferenceEndpointClientWithBaseURI(sdkApi sdkEnv.Api) (*InferenceEndpointClient, error)

func (InferenceEndpointClient) CreateOrUpdate 

func (c InferenceEndpointClient) CreateOrUpdate(ctx context.Context, id InferencePoolEndpointId, input InferenceEndpointTrackedResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (InferenceEndpointClient) CreateOrUpdateThenPoll 

func (c InferenceEndpointClient) CreateOrUpdateThenPoll(ctx context.Context, id InferencePoolEndpointId, input InferenceEndpointTrackedResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (InferenceEndpointClient) Delete 

func (c InferenceEndpointClient) Delete(ctx context.Context, id InferencePoolEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (InferenceEndpointClient) DeleteThenPoll 

func (c InferenceEndpointClient) DeleteThenPoll(ctx context.Context, id InferencePoolEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (InferenceEndpointClient) Get 

func (c InferenceEndpointClient) Get(ctx context.Context, id InferencePoolEndpointId) (result GetOperationResponse, err error)

Get ...

func (InferenceEndpointClient) List 

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

List ...

func (InferenceEndpointClient) ListComplete 

func (c InferenceEndpointClient) ListComplete(ctx context.Context, id InferencePoolId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (InferenceEndpointClient) ListCompleteMatchingPredicate 

func (c InferenceEndpointClient) ListCompleteMatchingPredicate(ctx context.Context, id InferencePoolId, options ListOperationOptions, predicate InferenceEndpointTrackedResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (InferenceEndpointClient) Update 

func (c InferenceEndpointClient) Update(ctx context.Context, id InferencePoolEndpointId, input interface{}) (result UpdateOperationResponse, err error)

Update ...

func (InferenceEndpointClient) UpdateThenPoll 

func (c InferenceEndpointClient) UpdateThenPoll(ctx context.Context, id InferencePoolEndpointId, input interface{}) error

UpdateThenPoll performs Update then polls until it's completed

type InferenceEndpointTrackedResource 

type InferenceEndpointTrackedResource 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 InferenceEndpoint                        `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 InferenceEndpointTrackedResourceOperationPredicate 

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

func (InferenceEndpointTrackedResourceOperationPredicate) Matches 

func (p InferenceEndpointTrackedResourceOperationPredicate) Matches(input InferenceEndpointTrackedResource) bool

type InferencePoolEndpointId 

type InferencePoolEndpointId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	InferencePoolName string
	EndpointName      string
}

InferencePoolEndpointId is a struct representing the Resource ID for a Inference Pool Endpoint

func NewInferencePoolEndpointID 

func NewInferencePoolEndpointID(subscriptionId string, resourceGroupName string, workspaceName string, inferencePoolName string, endpointName string) InferencePoolEndpointId

NewInferencePoolEndpointID returns a new InferencePoolEndpointId struct

func ParseInferencePoolEndpointID 

func ParseInferencePoolEndpointID(input string) (*InferencePoolEndpointId, error)

ParseInferencePoolEndpointID parses 'input' into a InferencePoolEndpointId

func ParseInferencePoolEndpointIDInsensitively 

func ParseInferencePoolEndpointIDInsensitively(input string) (*InferencePoolEndpointId, error)

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

func (*InferencePoolEndpointId) FromParseResult 

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

func (InferencePoolEndpointId) ID 

func (id InferencePoolEndpointId) ID() string

ID returns the formatted Inference Pool Endpoint ID

func (InferencePoolEndpointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Inference Pool Endpoint ID

func (InferencePoolEndpointId) String 

func (id InferencePoolEndpointId) String() string

String returns a human-readable description of this Inference Pool Endpoint ID

type InferencePoolId 

type InferencePoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	InferencePoolName string
}

InferencePoolId is a struct representing the Resource ID for a Inference Pool

func NewInferencePoolID 

func NewInferencePoolID(subscriptionId string, resourceGroupName string, workspaceName string, inferencePoolName string) InferencePoolId

NewInferencePoolID returns a new InferencePoolId struct

func ParseInferencePoolID 

func ParseInferencePoolID(input string) (*InferencePoolId, error)

ParseInferencePoolID parses 'input' into a InferencePoolId

func ParseInferencePoolIDInsensitively 

func ParseInferencePoolIDInsensitively(input string) (*InferencePoolId, error)

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

func (*InferencePoolId) FromParseResult 

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

func (InferencePoolId) ID 

func (id InferencePoolId) ID() string

ID returns the formatted Inference Pool ID

func (InferencePoolId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Inference Pool ID

func (InferencePoolId) String 

func (id InferencePoolId) String() string

String returns a human-readable description of this Inference Pool ID

type ListCompleteResult 

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

type ListCustomPager 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Count      *int64
	OrderBy    *OrderString
	Properties *string
	Skip       *string
	Tags       *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        *[]InferenceEndpointTrackedResource
}

type OrderString 

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

func (*OrderString) UnmarshalJSON 

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

type PoolProvisioningState 

type PoolProvisioningState string
const (
	PoolProvisioningStateCanceled  PoolProvisioningState = "Canceled"
	PoolProvisioningStateCreating  PoolProvisioningState = "Creating"
	PoolProvisioningStateDeleting  PoolProvisioningState = "Deleting"
	PoolProvisioningStateFailed    PoolProvisioningState = "Failed"
	PoolProvisioningStateSucceeded PoolProvisioningState = "Succeeded"
	PoolProvisioningStateUpdating  PoolProvisioningState = "Updating"
)

func (*PoolProvisioningState) UnmarshalJSON 

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

type RequestConfiguration 

type RequestConfiguration struct {
	MaxConcurrentRequestsPerInstance *int64  `json:"maxConcurrentRequestsPerInstance,omitempty"`
	RequestTimeout                   *string `json:"requestTimeout,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 StringStringKeyValuePair 

type StringStringKeyValuePair struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

type UpdateOperationResponse 

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

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.