environmentcontainer

package
v0.20231113.1102643 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := environmentcontainer.NewEnvironmentContainerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EnvironmentContainerClient.CreateOrUpdate

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

payload := environmentcontainer.EnvironmentContainerResource{
	// ...
}


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: EnvironmentContainerClient.Delete

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

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: EnvironmentContainerClient.Get

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

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

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

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

func PossibleValuesForListViewType() []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 ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type AssetContainer 

type AssetContainer struct {
	Description   *string            `json:"description,omitempty"`
	IsArchived    *bool              `json:"isArchived,omitempty"`
	LatestVersion *string            `json:"latestVersion,omitempty"`
	NextVersion   *string            `json:"nextVersion,omitempty"`
	Properties    *map[string]string `json:"properties,omitempty"`
	Tags          *map[string]string `json:"tags,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type EnvironmentContainerClient 

type EnvironmentContainerClient struct {
	Client *resourcemanager.Client
}

func NewEnvironmentContainerClientWithBaseURI 

func NewEnvironmentContainerClientWithBaseURI(sdkApi sdkEnv.Api) (*EnvironmentContainerClient, error)

func (EnvironmentContainerClient) CreateOrUpdate 

func (c EnvironmentContainerClient) CreateOrUpdate(ctx context.Context, id EnvironmentId, input EnvironmentContainerResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (EnvironmentContainerClient) Delete 

func (c EnvironmentContainerClient) Delete(ctx context.Context, id EnvironmentId) (result DeleteOperationResponse, err error)

Delete ...

func (EnvironmentContainerClient) Get 

func (c EnvironmentContainerClient) Get(ctx context.Context, id EnvironmentId) (result GetOperationResponse, err error)

Get ...

func (EnvironmentContainerClient) List 

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

List ...

func (EnvironmentContainerClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (EnvironmentContainerClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type EnvironmentContainerResource 

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

type EnvironmentContainerResourceOperationPredicate 

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

func (EnvironmentContainerResourceOperationPredicate) Matches 

func (p EnvironmentContainerResourceOperationPredicate) Matches(input EnvironmentContainerResource) bool

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 GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []EnvironmentContainerResource
}

type ListOperationOptions 

type ListOperationOptions struct {
	ListViewType *ListViewType
	Skip         *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        *[]EnvironmentContainerResource
}

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 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) 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.