sandboxcustomimages

package
v0.20231205.1144758 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2023-08-15/sandboxcustomimages Documentation

The sandboxcustomimages SDK allows for interaction with the Azure Resource Manager Service kusto (API Version 2023-08-15).

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/kusto/2023-08-15/sandboxcustomimages"

Client Initialization

client := sandboxcustomimages.NewSandboxCustomImagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SandboxCustomImagesClient.CheckNameAvailability

ctx := context.TODO()
id := sandboxcustomimages.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

payload := sandboxcustomimages.SandboxCustomImagesCheckNameRequest{
	// ...
}


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

Example Usage: SandboxCustomImagesClient.CreateOrUpdate

ctx := context.TODO()
id := sandboxcustomimages.NewSandboxCustomImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "sandboxCustomImageValue")

payload := sandboxcustomimages.SandboxCustomImage{
	// ...
}


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

Example Usage: SandboxCustomImagesClient.Delete

ctx := context.TODO()
id := sandboxcustomimages.NewSandboxCustomImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "sandboxCustomImageValue")

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

Example Usage: SandboxCustomImagesClient.Get

ctx := context.TODO()
id := sandboxcustomimages.NewSandboxCustomImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "sandboxCustomImageValue")

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: SandboxCustomImagesClient.ListByCluster

ctx := context.TODO()
id := sandboxcustomimages.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

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

Example Usage: SandboxCustomImagesClient.Update

ctx := context.TODO()
id := sandboxcustomimages.NewSandboxCustomImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "sandboxCustomImageValue")

payload := sandboxcustomimages.SandboxCustomImage{
	// ...
}


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 PossibleValuesForLanguage 

func PossibleValuesForLanguage() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReason 

func PossibleValuesForReason() []string

func PossibleValuesForSandboxCustomImageType 

func PossibleValuesForSandboxCustomImageType() []string

func ValidateClusterID 

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

func ValidateSandboxCustomImageID 

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

ValidateSandboxCustomImageID checks that 'input' can be parsed as a Sandbox Custom Image ID

Types

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameResult
}

type CheckNameResult 

type CheckNameResult struct {
	Message       *string `json:"message,omitempty"`
	Name          *string `json:"name,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *Reason `json:"reason,omitempty"`
}

type ClusterId 

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID 

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID 

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively 

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult added in v0.20231127.1171502 

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

func (ClusterId) ID 

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments 

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

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

func (ClusterId) String 

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *SandboxCustomImage
}

type Language 

type Language string
const (
	LanguagePython Language = "Python"
)

type ListByClusterOperationResponse 

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	Model        *SandboxCustomImagesListResult
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

type Reason 

type Reason string
const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)

type SandboxCustomImage 

type SandboxCustomImage struct {
	Id         *string                       `json:"id,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *SandboxCustomImageProperties `json:"properties,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type SandboxCustomImageId 

type SandboxCustomImageId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ClusterName            string
	SandboxCustomImageName string
}

SandboxCustomImageId is a struct representing the Resource ID for a Sandbox Custom Image

func NewSandboxCustomImageID 

func NewSandboxCustomImageID(subscriptionId string, resourceGroupName string, clusterName string, sandboxCustomImageName string) SandboxCustomImageId

NewSandboxCustomImageID returns a new SandboxCustomImageId struct

func ParseSandboxCustomImageID 

func ParseSandboxCustomImageID(input string) (*SandboxCustomImageId, error)

ParseSandboxCustomImageID parses 'input' into a SandboxCustomImageId

func ParseSandboxCustomImageIDInsensitively 

func ParseSandboxCustomImageIDInsensitively(input string) (*SandboxCustomImageId, error)

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

func (*SandboxCustomImageId) FromParseResult added in v0.20231127.1171502 

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

func (SandboxCustomImageId) ID 

func (id SandboxCustomImageId) ID() string

ID returns the formatted Sandbox Custom Image ID

func (SandboxCustomImageId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Sandbox Custom Image ID

func (SandboxCustomImageId) String 

func (id SandboxCustomImageId) String() string

String returns a human-readable description of this Sandbox Custom Image ID

type SandboxCustomImageProperties 

type SandboxCustomImageProperties struct {
	Language                Language           `json:"language"`
	LanguageVersion         string             `json:"languageVersion"`
	ProvisioningState       *ProvisioningState `json:"provisioningState,omitempty"`
	RequirementsFileContent *string            `json:"requirementsFileContent,omitempty"`
}

type SandboxCustomImageType 

type SandboxCustomImageType string
const (
	SandboxCustomImageTypeMicrosoftPointKustoClustersSandboxCustomImages SandboxCustomImageType = "Microsoft.Kusto/clusters/sandboxCustomImages"
)

type SandboxCustomImagesCheckNameRequest 

type SandboxCustomImagesCheckNameRequest struct {
	Name string                 `json:"name"`
	Type SandboxCustomImageType `json:"type"`
}

type SandboxCustomImagesClient 

type SandboxCustomImagesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewSandboxCustomImagesClientWithBaseURI 

func NewSandboxCustomImagesClientWithBaseURI(endpoint string) SandboxCustomImagesClient

func (SandboxCustomImagesClient) CheckNameAvailability 

func (c SandboxCustomImagesClient) CheckNameAvailability(ctx context.Context, id ClusterId, input SandboxCustomImagesCheckNameRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (SandboxCustomImagesClient) CreateOrUpdate 

func (c SandboxCustomImagesClient) CreateOrUpdate(ctx context.Context, id SandboxCustomImageId, input SandboxCustomImage) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SandboxCustomImagesClient) CreateOrUpdateThenPoll 

func (c SandboxCustomImagesClient) CreateOrUpdateThenPoll(ctx context.Context, id SandboxCustomImageId, input SandboxCustomImage) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SandboxCustomImagesClient) Delete 

func (c SandboxCustomImagesClient) Delete(ctx context.Context, id SandboxCustomImageId) (result DeleteOperationResponse, err error)

Delete ...

func (SandboxCustomImagesClient) DeleteThenPoll 

func (c SandboxCustomImagesClient) DeleteThenPoll(ctx context.Context, id SandboxCustomImageId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SandboxCustomImagesClient) Get 

func (c SandboxCustomImagesClient) Get(ctx context.Context, id SandboxCustomImageId) (result GetOperationResponse, err error)

Get ...

func (SandboxCustomImagesClient) ListByCluster 

func (c SandboxCustomImagesClient) ListByCluster(ctx context.Context, id ClusterId) (result ListByClusterOperationResponse, err error)

ListByCluster ...

func (SandboxCustomImagesClient) Update 

func (c SandboxCustomImagesClient) Update(ctx context.Context, id SandboxCustomImageId, input SandboxCustomImage) (result UpdateOperationResponse, err error)

Update ...

func (SandboxCustomImagesClient) UpdateThenPoll 

func (c SandboxCustomImagesClient) UpdateThenPoll(ctx context.Context, id SandboxCustomImageId, input SandboxCustomImage) error

UpdateThenPoll performs Update then polls until it's completed

type SandboxCustomImagesListResult 

type SandboxCustomImagesListResult struct {
	NextLink *string               `json:"nextLink,omitempty"`
	Value    *[]SandboxCustomImage `json:"value,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

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.