environmentversion

package
v0.20231109.1114643 Latest Latest
Warning

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

 Go to latest Published: Nov 9, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

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

Client Initialization

client := environmentversion.NewEnvironmentVersionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EnvironmentVersionClient.CreateOrUpdate

ctx := context.TODO()
id := environmentversion.NewEnvironmentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "environmentValue", "versionValue")

payload := environmentversion.EnvironmentVersionResource{
	// ...
}


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

Example Usage: EnvironmentVersionClient.Delete

ctx := context.TODO()
id := environmentversion.NewEnvironmentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "environmentValue", "versionValue")

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

Example Usage: EnvironmentVersionClient.Get

ctx := context.TODO()
id := environmentversion.NewEnvironmentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "environmentValue", "versionValue")

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

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

// alternatively `client.List(ctx, id, environmentversion.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, environmentversion.DefaultListOperationOptions())
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 PossibleValuesForEnvironmentType 

func PossibleValuesForEnvironmentType() []string

func PossibleValuesForListViewType 

func PossibleValuesForListViewType() []string

func PossibleValuesForOperatingSystemType 

func PossibleValuesForOperatingSystemType() []string

func ValidateEnvironmentID 

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

ValidateEnvironmentID checks that 'input' can be parsed as a Environment ID

func ValidateEnvironmentVersionID 

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

ValidateEnvironmentVersionID checks that 'input' can be parsed as a Environment Version ID

Types

type BuildContext 

type BuildContext struct {
	ContextUri     string  `json:"contextUri"`
	DockerfilePath *string `json:"dockerfilePath,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentVersionResource
}

type DeleteOperationResponse 

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

type EnvironmentId 

type EnvironmentId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	EnvironmentName   string
}

EnvironmentId is a struct representing the Resource ID for a Environment

func NewEnvironmentID 

func NewEnvironmentID(subscriptionId string, resourceGroupName string, workspaceName string, environmentName string) EnvironmentId

NewEnvironmentID returns a new EnvironmentId struct

func ParseEnvironmentID 

func ParseEnvironmentID(input string) (*EnvironmentId, error)

ParseEnvironmentID parses 'input' into a EnvironmentId

func ParseEnvironmentIDInsensitively 

func ParseEnvironmentIDInsensitively(input string) (*EnvironmentId, error)

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

func (EnvironmentId) ID 

func (id EnvironmentId) ID() string

ID returns the formatted Environment ID

func (EnvironmentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Environment ID

func (EnvironmentId) String 

func (id EnvironmentId) String() string

String returns a human-readable description of this Environment ID

type EnvironmentType 

type EnvironmentType string
const (
	EnvironmentTypeCurated     EnvironmentType = "Curated"
	EnvironmentTypeUserCreated EnvironmentType = "UserCreated"
)

func (*EnvironmentType) UnmarshalJSON added in v0.20230713.1092427 

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

type EnvironmentVersion 

type EnvironmentVersion struct {
	Build           *BuildContext                 `json:"build,omitempty"`
	CondaFile       *string                       `json:"condaFile,omitempty"`
	Description     *string                       `json:"description,omitempty"`
	EnvironmentType *EnvironmentType              `json:"environmentType,omitempty"`
	Image           *string                       `json:"image,omitempty"`
	InferenceConfig *InferenceContainerProperties `json:"inferenceConfig,omitempty"`
	IsAnonymous     *bool                         `json:"isAnonymous,omitempty"`
	IsArchived      *bool                         `json:"isArchived,omitempty"`
	OsType          *OperatingSystemType          `json:"osType,omitempty"`
	Properties      *map[string]string            `json:"properties,omitempty"`
	Tags            *map[string]string            `json:"tags,omitempty"`
}

type EnvironmentVersionClient 

type EnvironmentVersionClient struct {
	Client *resourcemanager.Client
}

func NewEnvironmentVersionClientWithBaseURI 

func NewEnvironmentVersionClientWithBaseURI(sdkApi sdkEnv.Api) (*EnvironmentVersionClient, error)

func (EnvironmentVersionClient) CreateOrUpdate 

func (c EnvironmentVersionClient) CreateOrUpdate(ctx context.Context, id EnvironmentVersionId, input EnvironmentVersionResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (EnvironmentVersionClient) Delete 

func (c EnvironmentVersionClient) Delete(ctx context.Context, id EnvironmentVersionId) (result DeleteOperationResponse, err error)

Delete ...

func (EnvironmentVersionClient) Get 

func (c EnvironmentVersionClient) Get(ctx context.Context, id EnvironmentVersionId) (result GetOperationResponse, err error)

Get ...

func (EnvironmentVersionClient) List 

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

List ...

func (EnvironmentVersionClient) ListComplete 

func (c EnvironmentVersionClient) ListComplete(ctx context.Context, id EnvironmentId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (EnvironmentVersionClient) ListCompleteMatchingPredicate 

func (c EnvironmentVersionClient) ListCompleteMatchingPredicate(ctx context.Context, id EnvironmentId, options ListOperationOptions, predicate EnvironmentVersionResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type EnvironmentVersionId 

type EnvironmentVersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	EnvironmentName   string
	VersionName       string
}

EnvironmentVersionId is a struct representing the Resource ID for a Environment Version

func NewEnvironmentVersionID 

func NewEnvironmentVersionID(subscriptionId string, resourceGroupName string, workspaceName string, environmentName string, versionName string) EnvironmentVersionId

NewEnvironmentVersionID returns a new EnvironmentVersionId struct

func ParseEnvironmentVersionID 

func ParseEnvironmentVersionID(input string) (*EnvironmentVersionId, error)

ParseEnvironmentVersionID parses 'input' into a EnvironmentVersionId

func ParseEnvironmentVersionIDInsensitively 

func ParseEnvironmentVersionIDInsensitively(input string) (*EnvironmentVersionId, error)

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

func (EnvironmentVersionId) ID 

func (id EnvironmentVersionId) ID() string

ID returns the formatted Environment Version ID

func (EnvironmentVersionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Environment Version ID

func (EnvironmentVersionId) String 

func (id EnvironmentVersionId) String() string

String returns a human-readable description of this Environment Version ID

type EnvironmentVersionResource 

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

type EnvironmentVersionResourceOperationPredicate 

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

func (EnvironmentVersionResourceOperationPredicate) Matches 

func (p EnvironmentVersionResourceOperationPredicate) Matches(input EnvironmentVersionResource) bool

type GetOperationResponse 

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

type InferenceContainerProperties 

type InferenceContainerProperties struct {
	LivenessRoute  *Route `json:"livenessRoute,omitempty"`
	ReadinessRoute *Route `json:"readinessRoute,omitempty"`
	ScoringRoute   *Route `json:"scoringRoute,omitempty"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []EnvironmentVersionResource
}

type ListOperationOptions 

type ListOperationOptions struct {
	ListViewType *ListViewType
	OrderBy      *string
	Skip         *string
	Top          *int64
}

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        *[]EnvironmentVersionResource
}

type ListViewType 

type ListViewType string
const (
	ListViewTypeActiveOnly   ListViewType = "ActiveOnly"
	ListViewTypeAll          ListViewType = "All"
	ListViewTypeArchivedOnly ListViewType = "ArchivedOnly"
)

func (*ListViewType) UnmarshalJSON added in v0.20230713.1092427 

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

type OperatingSystemType 

type OperatingSystemType string
const (
	OperatingSystemTypeLinux   OperatingSystemType = "Linux"
	OperatingSystemTypeWindows OperatingSystemType = "Windows"
)

func (*OperatingSystemType) UnmarshalJSON added in v0.20230713.1092427 

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

type Route 

type Route struct {
	Path string `json:"path"`
	Port int64  `json:"port"`
}

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.