scriptpackages

README

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

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

Client Initialization

client := scriptpackages.NewScriptPackagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ScriptPackagesClient.Get

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

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

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

// 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

• func PossibleValuesForScriptPackageProvisioningState() []string
• func ValidatePrivateCloudID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateScriptPackageID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type PrivateCloudId
  • func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId
  • func ParsePrivateCloudID(input string) (*PrivateCloudId, error)
  • func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)
  • func (id *PrivateCloudId) FromParseResult(input resourceids.ParseResult) error
  • func (id PrivateCloudId) ID() string
  • func (id PrivateCloudId) Segments() []resourceids.Segment
  • func (id PrivateCloudId) String() string
• type ScriptPackage
• type ScriptPackageId
  • func NewScriptPackageID(subscriptionId string, resourceGroupName string, privateCloudName string, ...) ScriptPackageId
  • func ParseScriptPackageID(input string) (*ScriptPackageId, error)
  • func ParseScriptPackageIDInsensitively(input string) (*ScriptPackageId, error)
  • func (id *ScriptPackageId) FromParseResult(input resourceids.ParseResult) error
  • func (id ScriptPackageId) ID() string
  • func (id ScriptPackageId) Segments() []resourceids.Segment
  • func (id ScriptPackageId) String() string
• type ScriptPackageOperationPredicate
  • func (p ScriptPackageOperationPredicate) Matches(input ScriptPackage) bool
• type ScriptPackageProperties
• type ScriptPackageProvisioningState
  • func (s *ScriptPackageProvisioningState) UnmarshalJSON(bytes []byte) error
• type ScriptPackagesClient
  • func NewScriptPackagesClientWithBaseURI(sdkApi sdkEnv.Api) (*ScriptPackagesClient, error)
  • func (c ScriptPackagesClient) Get(ctx context.Context, id ScriptPackageId) (result GetOperationResponse, err error)
  • func (c ScriptPackagesClient) List(ctx context.Context, id PrivateCloudId) (result ListOperationResponse, err error)
  • func (c ScriptPackagesClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)
  • func (c ScriptPackagesClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, ...) (result ListCompleteResult, err error)

Functions

func PossibleValuesForScriptPackageProvisioningState

func PossibleValuesForScriptPackageProvisioningState() []string

func ValidatePrivateCloudID

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

ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud 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        *ScriptPackage
}

type ListCompleteResult

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

type ListOperationResponse

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

type PrivateCloudId

type PrivateCloudId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
}

PrivateCloudId is a struct representing the Resource ID for a Private Cloud

func NewPrivateCloudID

func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId

NewPrivateCloudID returns a new PrivateCloudId struct

func ParsePrivateCloudID

func ParsePrivateCloudID(input string) (*PrivateCloudId, error)

ParsePrivateCloudID parses 'input' into a PrivateCloudId

func ParsePrivateCloudIDInsensitively

func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)

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

func (*PrivateCloudId) FromParseResult

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

func (PrivateCloudId) ID

func (id PrivateCloudId) ID() string

ID returns the formatted Private Cloud ID

func (PrivateCloudId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Private Cloud ID

func (PrivateCloudId) String

func (id PrivateCloudId) String() string

String returns a human-readable description of this Private Cloud ID

type ScriptPackage

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

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 ScriptPackageOperationPredicate

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

func (ScriptPackageOperationPredicate) Matches

func (p ScriptPackageOperationPredicate) Matches(input ScriptPackage) bool

type ScriptPackageProperties

type ScriptPackageProperties struct {
	Company           *string                         `json:"company,omitempty"`
	Description       *string                         `json:"description,omitempty"`
	ProvisioningState *ScriptPackageProvisioningState `json:"provisioningState,omitempty"`
	Uri               *string                         `json:"uri,omitempty"`
	Version           *string                         `json:"version,omitempty"`
}

type ScriptPackageProvisioningState

type ScriptPackageProvisioningState string

const (
	ScriptPackageProvisioningStateCanceled  ScriptPackageProvisioningState = "Canceled"
	ScriptPackageProvisioningStateFailed    ScriptPackageProvisioningState = "Failed"
	ScriptPackageProvisioningStateSucceeded ScriptPackageProvisioningState = "Succeeded"
)

func (*ScriptPackageProvisioningState) UnmarshalJSON

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

type ScriptPackagesClient

type ScriptPackagesClient struct {
	Client *resourcemanager.Client
}

func NewScriptPackagesClientWithBaseURI

func NewScriptPackagesClientWithBaseURI(sdkApi sdkEnv.Api) (*ScriptPackagesClient, error)

func (ScriptPackagesClient) Get

func (c ScriptPackagesClient) Get(ctx context.Context, id ScriptPackageId) (result GetOperationResponse, err error)

Get ...

func (ScriptPackagesClient) List

func (c ScriptPackagesClient) List(ctx context.Context, id PrivateCloudId) (result ListOperationResponse, err error)

List ...

func (ScriptPackagesClient) ListComplete

func (c ScriptPackagesClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ScriptPackagesClient) ListCompleteMatchingPredicate

func (c ScriptPackagesClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate ScriptPackageOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate