scriptactions

README

github.com/hashicorp/go-azure-sdk/resource-manager/hdinsight/2021-06-01/scriptactions Documentation

The scriptactions SDK allows for interaction with the Azure Resource Manager Service hdinsight (API Version 2021-06-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/hdinsight/2021-06-01/scriptactions"

Client Initialization

client := scriptactions.NewScriptActionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ScriptActionsClient.Delete

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

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

Example Usage: ScriptActionsClient.ListByCluster

ctx := context.TODO()
id := scriptactions.NewHDInsightClusterID("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
}

Documentation

Index

• func ValidateScriptActionID(input interface{}, key string) (warnings []string, errors []error)
• type DeleteOperationResponse
• type ListByClusterCompleteResult
• type ListByClusterOperationResponse
• type RuntimeScriptActionDetail
• type RuntimeScriptActionDetailOperationPredicate
  • func (p RuntimeScriptActionDetailOperationPredicate) Matches(input RuntimeScriptActionDetail) bool
• type ScriptActionExecutionSummary
• type ScriptActionId
  • func NewScriptActionID(subscriptionId string, resourceGroupName string, clusterName string, ...) ScriptActionId
  • func ParseScriptActionID(input string) (*ScriptActionId, error)
  • func ParseScriptActionIDInsensitively(input string) (*ScriptActionId, error)
  • func (id *ScriptActionId) FromParseResult(input resourceids.ParseResult) error
  • func (id ScriptActionId) ID() string
  • func (id ScriptActionId) Segments() []resourceids.Segment
  • func (id ScriptActionId) String() string
• type ScriptActionsClient
  • func NewScriptActionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ScriptActionsClient, error)
  • func (c ScriptActionsClient) Delete(ctx context.Context, id ScriptActionId) (result DeleteOperationResponse, err error)
  • func (c ScriptActionsClient) ListByCluster(ctx context.Context, id commonids.HDInsightClusterId) (result ListByClusterOperationResponse, err error)
  • func (c ScriptActionsClient) ListByClusterComplete(ctx context.Context, id commonids.HDInsightClusterId) (ListByClusterCompleteResult, error)
  • func (c ScriptActionsClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id commonids.HDInsightClusterId, ...) (result ListByClusterCompleteResult, err error)

Functions

func ValidateScriptActionID

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

ValidateScriptActionID checks that 'input' can be parsed as a Script Action ID

Types

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ListByClusterCompleteResult

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

type ListByClusterOperationResponse

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

type RuntimeScriptActionDetail

type RuntimeScriptActionDetail struct {
	ApplicationName   *string                         `json:"applicationName,omitempty"`
	DebugInformation  *string                         `json:"debugInformation,omitempty"`
	EndTime           *string                         `json:"endTime,omitempty"`
	ExecutionSummary  *[]ScriptActionExecutionSummary `json:"executionSummary,omitempty"`
	Name              string                          `json:"name"`
	Operation         *string                         `json:"operation,omitempty"`
	Parameters        *string                         `json:"parameters,omitempty"`
	Roles             []string                        `json:"roles"`
	ScriptExecutionId *int64                          `json:"scriptExecutionId,omitempty"`
	StartTime         *string                         `json:"startTime,omitempty"`
	Status            *string                         `json:"status,omitempty"`
	Uri               string                          `json:"uri"`
}

type RuntimeScriptActionDetailOperationPredicate

type RuntimeScriptActionDetailOperationPredicate struct {
	ApplicationName   *string
	DebugInformation  *string
	EndTime           *string
	Name              *string
	Operation         *string
	Parameters        *string
	ScriptExecutionId *int64
	StartTime         *string
	Status            *string
	Uri               *string
}

func (RuntimeScriptActionDetailOperationPredicate) Matches

func (p RuntimeScriptActionDetailOperationPredicate) Matches(input RuntimeScriptActionDetail) bool

type ScriptActionExecutionSummary

type ScriptActionExecutionSummary struct {
	InstanceCount *int64  `json:"instanceCount,omitempty"`
	Status        *string `json:"status,omitempty"`
}

type ScriptActionId

type ScriptActionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
	ScriptActionName  string
}

ScriptActionId is a struct representing the Resource ID for a Script Action

func NewScriptActionID

func NewScriptActionID(subscriptionId string, resourceGroupName string, clusterName string, scriptActionName string) ScriptActionId

NewScriptActionID returns a new ScriptActionId struct

func ParseScriptActionID

func ParseScriptActionID(input string) (*ScriptActionId, error)

ParseScriptActionID parses 'input' into a ScriptActionId

func ParseScriptActionIDInsensitively

func ParseScriptActionIDInsensitively(input string) (*ScriptActionId, error)

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

func (*ScriptActionId) FromParseResult

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

func (ScriptActionId) ID

func (id ScriptActionId) ID() string

ID returns the formatted Script Action ID

func (ScriptActionId) Segments

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

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

func (ScriptActionId) String

func (id ScriptActionId) String() string

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

type ScriptActionsClient

type ScriptActionsClient struct {
	Client *resourcemanager.Client
}

func NewScriptActionsClientWithBaseURI

func NewScriptActionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ScriptActionsClient, error)

func (ScriptActionsClient) Delete

func (c ScriptActionsClient) Delete(ctx context.Context, id ScriptActionId) (result DeleteOperationResponse, err error)

Delete ...

func (ScriptActionsClient) ListByCluster

func (c ScriptActionsClient) ListByCluster(ctx context.Context, id commonids.HDInsightClusterId) (result ListByClusterOperationResponse, err error)

ListByCluster ...

func (ScriptActionsClient) ListByClusterComplete

func (c ScriptActionsClient) ListByClusterComplete(ctx context.Context, id commonids.HDInsightClusterId) (ListByClusterCompleteResult, error)

ListByClusterComplete retrieves all the results into a single object

func (ScriptActionsClient) ListByClusterCompleteMatchingPredicate

func (c ScriptActionsClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id commonids.HDInsightClusterId, predicate RuntimeScriptActionDetailOperationPredicate) (result ListByClusterCompleteResult, err error)

ListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate