package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# README
github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2022-05-01/scripts
Documentation
The scripts
SDK allows for interaction with the Azure Resource Manager Service vmware
(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/vmware/2022-05-01/scripts"
Client Initialization
client := scripts.NewScriptsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ScriptsClient.ScriptCmdletsGet
ctx := context.TODO()
id := scripts.NewScriptCmdletID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptPackageValue", "scriptCmdletValue")
read, err := client.ScriptCmdletsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ScriptsClient.ScriptCmdletsList
ctx := context.TODO()
id := scripts.NewScriptPackageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptPackageValue")
// alternatively `client.ScriptCmdletsList(ctx, id)` can be used to do batched pagination
items, err := client.ScriptCmdletsListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ScriptsClient.ScriptExecutionsCreateOrUpdate
ctx := context.TODO()
id := scripts.NewScriptExecutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptExecutionValue")
payload := scripts.ScriptExecution{
// ...
}
if err := client.ScriptExecutionsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ScriptsClient.ScriptExecutionsDelete
ctx := context.TODO()
id := scripts.NewScriptExecutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptExecutionValue")
if err := client.ScriptExecutionsDeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: ScriptsClient.ScriptExecutionsGet
ctx := context.TODO()
id := scripts.NewScriptExecutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptExecutionValue")
read, err := client.ScriptExecutionsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ScriptsClient.ScriptExecutionsGetExecutionLogs
ctx := context.TODO()
id := scripts.NewScriptExecutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptExecutionValue")
var payload []ScriptOutputStreamType
read, err := client.ScriptExecutionsGetExecutionLogs(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ScriptsClient.ScriptExecutionsList
ctx := context.TODO()
id := scripts.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")
// alternatively `client.ScriptExecutionsList(ctx, id)` can be used to do batched pagination
items, err := client.ScriptExecutionsListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ScriptsClient.ScriptPackagesGet
ctx := context.TODO()
id := scripts.NewScriptPackageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "scriptPackageValue")
read, err := client.ScriptPackagesGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ScriptsClient.ScriptPackagesList
ctx := context.TODO()
id := scripts.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")
// alternatively `client.ScriptPackagesList(ctx, id)` can be used to do batched pagination
items, err := client.ScriptPackagesListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
NewPrivateCloudID returns a new PrivateCloudId struct.
NewScriptCmdletID returns a new ScriptCmdletId struct.
NewScriptExecutionID returns a new ScriptExecutionId struct.
NewScriptPackageID returns a new ScriptPackageId struct.
No description provided by the author
ParsePrivateCloudID parses 'input' into a PrivateCloudId.
ParsePrivateCloudIDInsensitively parses 'input' case-insensitively into a PrivateCloudId note: this method should only be used for API response data and not user input.
ParseScriptCmdletID parses 'input' into a ScriptCmdletId.
ParseScriptCmdletIDInsensitively parses 'input' case-insensitively into a ScriptCmdletId note: this method should only be used for API response data and not user input.
ParseScriptExecutionID parses 'input' into a ScriptExecutionId.
ParseScriptExecutionIDInsensitively parses 'input' case-insensitively into a ScriptExecutionId note: this method should only be used for API response data and not user input.
ParseScriptPackageID parses 'input' into a ScriptPackageId.
ParseScriptPackageIDInsensitively parses 'input' case-insensitively into a ScriptPackageId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID.
ValidateScriptCmdletID checks that 'input' can be parsed as a Script Cmdlet ID.
ValidateScriptExecutionID checks that 'input' can be parsed as a Script Execution ID.
ValidateScriptPackageID checks that 'input' can be parsed as a Script Package ID.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
PrivateCloudId is a struct representing the Resource ID for a Private Cloud.
No description provided by the author
RawScriptExecutionParameterImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
No description provided by the author
ScriptCmdletId is a struct representing the Resource ID for a Script Cmdlet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ScriptExecutionId is a struct representing the Resource ID for a Script Execution.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ScriptPackageId is a struct representing the Resource ID for a Script Package.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author