scriptcmdlets

package
v0.20240625.1123713 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-09-01/scriptcmdlets Documentation

The scriptcmdlets SDK allows for interaction with the Azure Resource Manager Service vmware (API Version 2023-09-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/vmware/2023-09-01/scriptcmdlets"

Client Initialization

client := scriptcmdlets.NewScriptCmdletsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ScriptCmdletsClient.Get

ctx := context.TODO()
id := scriptcmdlets.NewScriptCmdletID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptPackageValue", "scriptCmdletValue")

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

ctx := context.TODO()
id := scriptcmdlets.NewScriptPackageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptPackageValue")

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

func PossibleValuesForOptionalParamEnum() []string

func PossibleValuesForScriptCmdletAudience 

func PossibleValuesForScriptCmdletAudience() []string

func PossibleValuesForScriptCmdletProvisioningState 

func PossibleValuesForScriptCmdletProvisioningState() []string

func PossibleValuesForScriptParameterTypes 

func PossibleValuesForScriptParameterTypes() []string

func PossibleValuesForVisibilityParameterEnum 

func PossibleValuesForVisibilityParameterEnum() []string

func ValidateScriptCmdletID 

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

ValidateScriptCmdletID checks that 'input' can be parsed as a Script Cmdlet ID

func ValidateScriptPackageID 

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

ValidateScriptPackageID checks that 'input' can be parsed as a Script Package ID

Types

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ScriptCmdlet
}

type OptionalParamEnum 

type OptionalParamEnum string
const (
	OptionalParamEnumOptional OptionalParamEnum = "Optional"
	OptionalParamEnumRequired OptionalParamEnum = "Required"
)

func (*OptionalParamEnum) UnmarshalJSON 

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

type ScriptCmdlet 

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

type ScriptCmdletAudience 

type ScriptCmdletAudience string
const (
	ScriptCmdletAudienceAny        ScriptCmdletAudience = "Any"
	ScriptCmdletAudienceAutomation ScriptCmdletAudience = "Automation"
)

func (*ScriptCmdletAudience) UnmarshalJSON 

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

type ScriptCmdletId 

type ScriptCmdletId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
	ScriptPackageName string
	ScriptCmdletName  string
}

ScriptCmdletId is a struct representing the Resource ID for a Script Cmdlet

func NewScriptCmdletID 

func NewScriptCmdletID(subscriptionId string, resourceGroupName string, privateCloudName string, scriptPackageName string, scriptCmdletName string) ScriptCmdletId

NewScriptCmdletID returns a new ScriptCmdletId struct

func ParseScriptCmdletID 

func ParseScriptCmdletID(input string) (*ScriptCmdletId, error)

ParseScriptCmdletID parses 'input' into a ScriptCmdletId

func ParseScriptCmdletIDInsensitively 

func ParseScriptCmdletIDInsensitively(input string) (*ScriptCmdletId, error)

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

func (*ScriptCmdletId) FromParseResult 

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

func (ScriptCmdletId) ID 

func (id ScriptCmdletId) ID() string

ID returns the formatted Script Cmdlet ID

func (ScriptCmdletId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Script Cmdlet ID

func (ScriptCmdletId) String 

func (id ScriptCmdletId) String() string

String returns a human-readable description of this Script Cmdlet ID

type ScriptCmdletOperationPredicate 

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

func (ScriptCmdletOperationPredicate) Matches 

func (p ScriptCmdletOperationPredicate) Matches(input ScriptCmdlet) bool

type ScriptCmdletProperties 

type ScriptCmdletProperties struct {
	Audience          *ScriptCmdletAudience          `json:"audience,omitempty"`
	Description       *string                        `json:"description,omitempty"`
	Parameters        *[]ScriptParameter             `json:"parameters,omitempty"`
	ProvisioningState *ScriptCmdletProvisioningState `json:"provisioningState,omitempty"`
	Timeout           *string                        `json:"timeout,omitempty"`
}

type ScriptCmdletProvisioningState 

type ScriptCmdletProvisioningState string
const (
	ScriptCmdletProvisioningStateCanceled  ScriptCmdletProvisioningState = "Canceled"
	ScriptCmdletProvisioningStateFailed    ScriptCmdletProvisioningState = "Failed"
	ScriptCmdletProvisioningStateSucceeded ScriptCmdletProvisioningState = "Succeeded"
)

func (*ScriptCmdletProvisioningState) UnmarshalJSON 

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

type ScriptCmdletsClient 

type ScriptCmdletsClient struct {
	Client *resourcemanager.Client
}

func NewScriptCmdletsClientWithBaseURI 

func NewScriptCmdletsClientWithBaseURI(sdkApi sdkEnv.Api) (*ScriptCmdletsClient, error)

func (ScriptCmdletsClient) Get 

func (c ScriptCmdletsClient) Get(ctx context.Context, id ScriptCmdletId) (result GetOperationResponse, err error)

Get ...

func (ScriptCmdletsClient) List 

func (c ScriptCmdletsClient) List(ctx context.Context, id ScriptPackageId) (result ListOperationResponse, err error)

List ...

func (ScriptCmdletsClient) ListComplete 

func (c ScriptCmdletsClient) ListComplete(ctx context.Context, id ScriptPackageId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ScriptCmdletsClient) ListCompleteMatchingPredicate 

func (c ScriptCmdletsClient) ListCompleteMatchingPredicate(ctx context.Context, id ScriptPackageId, predicate ScriptCmdletOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScriptPackageId 

type ScriptPackageId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
	ScriptPackageName string
}

ScriptPackageId is a struct representing the Resource ID for a Script Package

func NewScriptPackageID 

func NewScriptPackageID(subscriptionId string, resourceGroupName string, privateCloudName string, scriptPackageName string) ScriptPackageId

NewScriptPackageID returns a new ScriptPackageId struct

func ParseScriptPackageID 

func ParseScriptPackageID(input string) (*ScriptPackageId, error)

ParseScriptPackageID parses 'input' into a ScriptPackageId

func ParseScriptPackageIDInsensitively 

func ParseScriptPackageIDInsensitively(input string) (*ScriptPackageId, error)

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

func (*ScriptPackageId) FromParseResult 

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

func (ScriptPackageId) ID 

func (id ScriptPackageId) ID() string

ID returns the formatted Script Package ID

func (ScriptPackageId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Script Package ID

func (ScriptPackageId) String 

func (id ScriptPackageId) String() string

String returns a human-readable description of this Script Package ID

type ScriptParameter 

type ScriptParameter struct {
	Description *string                  `json:"description,omitempty"`
	Name        *string                  `json:"name,omitempty"`
	Optional    *OptionalParamEnum       `json:"optional,omitempty"`
	Type        *ScriptParameterTypes    `json:"type,omitempty"`
	Visibility  *VisibilityParameterEnum `json:"visibility,omitempty"`
}

type ScriptParameterTypes 

type ScriptParameterTypes string
const (
	ScriptParameterTypesBool         ScriptParameterTypes = "Bool"
	ScriptParameterTypesCredential   ScriptParameterTypes = "Credential"
	ScriptParameterTypesFloat        ScriptParameterTypes = "Float"
	ScriptParameterTypesInt          ScriptParameterTypes = "Int"
	ScriptParameterTypesSecureString ScriptParameterTypes = "SecureString"
	ScriptParameterTypesString       ScriptParameterTypes = "String"
)

func (*ScriptParameterTypes) UnmarshalJSON 

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

type VisibilityParameterEnum 

type VisibilityParameterEnum string
const (
	VisibilityParameterEnumHidden  VisibilityParameterEnum = "Hidden"
	VisibilityParameterEnumVisible VisibilityParameterEnum = "Visible"
)

func (*VisibilityParameterEnum) UnmarshalJSON 

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

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.