sandboxcustomimages

package
v0.20240731.1170959 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

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-helpers/resourcemanager/commonids"
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 := commonids.NewKustoClusterID("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 := commonids.NewKustoClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

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

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 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
	OData        *odata.OData
	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 CreateOrUpdateOperationResponse 

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

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

type Language 

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

func (*Language) UnmarshalJSON 

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

type ListByClusterCompleteResult added in v0.20240226.1173038 

type ListByClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SandboxCustomImage
}

type ListByClusterCustomPager added in v0.20240628.1153531 

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

type ListByClusterOperationResponse 

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SandboxCustomImage
}

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

func (*ProvisioningState) UnmarshalJSON 

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

type Reason 

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

func (*Reason) UnmarshalJSON 

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

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 

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 SandboxCustomImageOperationPredicate added in v0.20240226.1173038 

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

func (SandboxCustomImageOperationPredicate) Matches added in v0.20240226.1173038 

func (p SandboxCustomImageOperationPredicate) Matches(input SandboxCustomImage) bool

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

func (*SandboxCustomImageType) UnmarshalJSON 

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

type SandboxCustomImagesCheckNameRequest 

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

type SandboxCustomImagesClient 

type SandboxCustomImagesClient struct {
	Client *resourcemanager.Client
}

func NewSandboxCustomImagesClientWithBaseURI 

func NewSandboxCustomImagesClientWithBaseURI(sdkApi sdkEnv.Api) (*SandboxCustomImagesClient, error)

func (SandboxCustomImagesClient) CheckNameAvailability 

func (c SandboxCustomImagesClient) CheckNameAvailability(ctx context.Context, id commonids.KustoClusterId, 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 commonids.KustoClusterId) (result ListByClusterOperationResponse, err error)

ListByCluster ...

func (SandboxCustomImagesClient) ListByClusterComplete added in v0.20240226.1173038 

func (c SandboxCustomImagesClient) ListByClusterComplete(ctx context.Context, id commonids.KustoClusterId) (ListByClusterCompleteResult, error)

ListByClusterComplete retrieves all the results into a single object

func (SandboxCustomImagesClient) ListByClusterCompleteMatchingPredicate added in v0.20240226.1173038 

func (c SandboxCustomImagesClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id commonids.KustoClusterId, predicate SandboxCustomImageOperationPredicate) (result ListByClusterCompleteResult, err error)

ListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 UpdateOperationResponse 

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

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.