runbookdraft

package
v0.20231214.1160726 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2015-10-31/runbookdraft Documentation

The runbookdraft SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2015-10-31).

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/automation/2015-10-31/runbookdraft"

Client Initialization

client := runbookdraft.NewRunbookDraftClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RunbookDraftClient.Get

ctx := context.TODO()
id := runbookdraft.NewRunbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "runbookValue")

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: RunbookDraftClient.GetContent

ctx := context.TODO()
id := runbookdraft.NewRunbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "runbookValue")

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

Example Usage: RunbookDraftClient.Publish

ctx := context.TODO()
id := runbookdraft.NewRunbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "runbookValue")

if err := client.PublishThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: RunbookDraftClient.ReplaceContent

ctx := context.TODO()
id := runbookdraft.NewRunbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "runbookValue")
var payload []byte

if err := client.ReplaceContentThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RunbookDraftClient.UndoEdit

ctx := context.TODO()
id := runbookdraft.NewRunbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "runbookValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForHTTPStatusCode 

func PossibleValuesForHTTPStatusCode() []string

func ValidateRunbookID 

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

ValidateRunbookID checks that 'input' can be parsed as a Runbook ID

Types

type ContentHash 

type ContentHash struct {
	Algorithm string `json:"algorithm"`
	Value     string `json:"value"`
}
type ContentLink struct {
	ContentHash *ContentHash `json:"contentHash,omitempty"`
	Uri         *string      `json:"uri,omitempty"`
	Version     *string      `json:"version,omitempty"`
}

type GetContentOperationResponse 

type GetContentOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]byte
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *RunbookDraft
}

type HTTPStatusCode 

type HTTPStatusCode string
const (
	HTTPStatusCodeAccepted                     HTTPStatusCode = "Accepted"
	HTTPStatusCodeAmbiguous                    HTTPStatusCode = "Ambiguous"
	HTTPStatusCodeBadGateway                   HTTPStatusCode = "BadGateway"
	HTTPStatusCodeBadRequest                   HTTPStatusCode = "BadRequest"
	HTTPStatusCodeConflict                     HTTPStatusCode = "Conflict"
	HTTPStatusCodeContinue                     HTTPStatusCode = "Continue"
	HTTPStatusCodeCreated                      HTTPStatusCode = "Created"
	HTTPStatusCodeExpectationFailed            HTTPStatusCode = "ExpectationFailed"
	HTTPStatusCodeForbidden                    HTTPStatusCode = "Forbidden"
	HTTPStatusCodeFound                        HTTPStatusCode = "Found"
	HTTPStatusCodeGatewayTimeout               HTTPStatusCode = "GatewayTimeout"
	HTTPStatusCodeGone                         HTTPStatusCode = "Gone"
	HTTPStatusCodeHTTPVersionNotSupported      HTTPStatusCode = "HttpVersionNotSupported"
	HTTPStatusCodeInternalServerError          HTTPStatusCode = "InternalServerError"
	HTTPStatusCodeLengthRequired               HTTPStatusCode = "LengthRequired"
	HTTPStatusCodeMethodNotAllowed             HTTPStatusCode = "MethodNotAllowed"
	HTTPStatusCodeMoved                        HTTPStatusCode = "Moved"
	HTTPStatusCodeMovedPermanently             HTTPStatusCode = "MovedPermanently"
	HTTPStatusCodeMultipleChoices              HTTPStatusCode = "MultipleChoices"
	HTTPStatusCodeNoContent                    HTTPStatusCode = "NoContent"
	HTTPStatusCodeNonAuthoritativeInformation  HTTPStatusCode = "NonAuthoritativeInformation"
	HTTPStatusCodeNotAcceptable                HTTPStatusCode = "NotAcceptable"
	HTTPStatusCodeNotFound                     HTTPStatusCode = "NotFound"
	HTTPStatusCodeNotImplemented               HTTPStatusCode = "NotImplemented"
	HTTPStatusCodeNotModified                  HTTPStatusCode = "NotModified"
	HTTPStatusCodeOK                           HTTPStatusCode = "OK"
	HTTPStatusCodePartialContent               HTTPStatusCode = "PartialContent"
	HTTPStatusCodePaymentRequired              HTTPStatusCode = "PaymentRequired"
	HTTPStatusCodePreconditionFailed           HTTPStatusCode = "PreconditionFailed"
	HTTPStatusCodeProxyAuthenticationRequired  HTTPStatusCode = "ProxyAuthenticationRequired"
	HTTPStatusCodeRedirect                     HTTPStatusCode = "Redirect"
	HTTPStatusCodeRedirectKeepVerb             HTTPStatusCode = "RedirectKeepVerb"
	HTTPStatusCodeRedirectMethod               HTTPStatusCode = "RedirectMethod"
	HTTPStatusCodeRequestEntityTooLarge        HTTPStatusCode = "RequestEntityTooLarge"
	HTTPStatusCodeRequestTimeout               HTTPStatusCode = "RequestTimeout"
	HTTPStatusCodeRequestUriTooLong            HTTPStatusCode = "RequestUriTooLong"
	HTTPStatusCodeRequestedRangeNotSatisfiable HTTPStatusCode = "RequestedRangeNotSatisfiable"
	HTTPStatusCodeResetContent                 HTTPStatusCode = "ResetContent"
	HTTPStatusCodeSeeOther                     HTTPStatusCode = "SeeOther"
	HTTPStatusCodeServiceUnavailable           HTTPStatusCode = "ServiceUnavailable"
	HTTPStatusCodeSwitchingProtocols           HTTPStatusCode = "SwitchingProtocols"
	HTTPStatusCodeTemporaryRedirect            HTTPStatusCode = "TemporaryRedirect"
	HTTPStatusCodeUnauthorized                 HTTPStatusCode = "Unauthorized"
	HTTPStatusCodeUnsupportedMediaType         HTTPStatusCode = "UnsupportedMediaType"
	HTTPStatusCodeUnused                       HTTPStatusCode = "Unused"
	HTTPStatusCodeUpgradeRequired              HTTPStatusCode = "UpgradeRequired"
	HTTPStatusCodeUseProxy                     HTTPStatusCode = "UseProxy"
)

type PublishOperationResponse 

type PublishOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ReplaceContentOperationResponse 

type ReplaceContentOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type RunbookDraft 

type RunbookDraft struct {
	CreationTime     *string                      `json:"creationTime,omitempty"`
	DraftContentLink *ContentLink                 `json:"draftContentLink,omitempty"`
	InEdit           *bool                        `json:"inEdit,omitempty"`
	LastModifiedTime *string                      `json:"lastModifiedTime,omitempty"`
	OutputTypes      *[]string                    `json:"outputTypes,omitempty"`
	Parameters       *map[string]RunbookParameter `json:"parameters,omitempty"`
}

func (*RunbookDraft) GetCreationTimeAsTime 

func (o *RunbookDraft) GetCreationTimeAsTime() (*time.Time, error)

func (*RunbookDraft) GetLastModifiedTimeAsTime 

func (o *RunbookDraft) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*RunbookDraft) SetCreationTimeAsTime 

func (o *RunbookDraft) SetCreationTimeAsTime(input time.Time)

func (*RunbookDraft) SetLastModifiedTimeAsTime 

func (o *RunbookDraft) SetLastModifiedTimeAsTime(input time.Time)

type RunbookDraftClient 

type RunbookDraftClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewRunbookDraftClientWithBaseURI 

func NewRunbookDraftClientWithBaseURI(endpoint string) RunbookDraftClient

func (RunbookDraftClient) Get 

func (c RunbookDraftClient) Get(ctx context.Context, id RunbookId) (result GetOperationResponse, err error)

Get ...

func (RunbookDraftClient) GetContent 

func (c RunbookDraftClient) GetContent(ctx context.Context, id RunbookId) (result GetContentOperationResponse, err error)

GetContent ...

func (RunbookDraftClient) Publish 

func (c RunbookDraftClient) Publish(ctx context.Context, id RunbookId) (result PublishOperationResponse, err error)

Publish ...

func (RunbookDraftClient) PublishThenPoll 

func (c RunbookDraftClient) PublishThenPoll(ctx context.Context, id RunbookId) error

PublishThenPoll performs Publish then polls until it's completed

func (RunbookDraftClient) ReplaceContent 

func (c RunbookDraftClient) ReplaceContent(ctx context.Context, id RunbookId, input []byte) (result ReplaceContentOperationResponse, err error)

ReplaceContent ...

func (RunbookDraftClient) ReplaceContentThenPoll 

func (c RunbookDraftClient) ReplaceContentThenPoll(ctx context.Context, id RunbookId, input []byte) error

ReplaceContentThenPoll performs ReplaceContent then polls until it's completed

func (RunbookDraftClient) UndoEdit 

func (c RunbookDraftClient) UndoEdit(ctx context.Context, id RunbookId) (result UndoEditOperationResponse, err error)

UndoEdit ...

type RunbookDraftUndoEditResult 

type RunbookDraftUndoEditResult struct {
	RequestId  *string         `json:"requestId,omitempty"`
	StatusCode *HTTPStatusCode `json:"statusCode,omitempty"`
}

type RunbookId 

type RunbookId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	RunbookName           string
}

RunbookId is a struct representing the Resource ID for a Runbook

func NewRunbookID 

func NewRunbookID(subscriptionId string, resourceGroupName string, automationAccountName string, runbookName string) RunbookId

NewRunbookID returns a new RunbookId struct

func ParseRunbookID 

func ParseRunbookID(input string) (*RunbookId, error)

ParseRunbookID parses 'input' into a RunbookId

func ParseRunbookIDInsensitively 

func ParseRunbookIDInsensitively(input string) (*RunbookId, error)

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

func (*RunbookId) FromParseResult added in v0.20231127.1171502 

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

func (RunbookId) ID 

func (id RunbookId) ID() string

ID returns the formatted Runbook ID

func (RunbookId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Runbook ID

func (RunbookId) String 

func (id RunbookId) String() string

String returns a human-readable description of this Runbook ID

type RunbookParameter 

type RunbookParameter struct {
	DefaultValue *string `json:"defaultValue,omitempty"`
	IsMandatory  *bool   `json:"isMandatory,omitempty"`
	Position     *int64  `json:"position,omitempty"`
	Type         *string `json:"type,omitempty"`
}

type UndoEditOperationResponse 

type UndoEditOperationResponse struct {
	HttpResponse *http.Response
	Model        *RunbookDraftUndoEditResult
}

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.