hybridrunbookworker

package
v0.20241209.1115630 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2021-06-22/hybridrunbookworker Documentation

The hybridrunbookworker SDK allows for interaction with Azure Resource Manager automation (API Version 2021-06-22).

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/2021-06-22/hybridrunbookworker"

Client Initialization

client := hybridrunbookworker.NewHybridRunbookWorkerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: HybridRunbookWorkerClient.Create

ctx := context.TODO()
id := hybridrunbookworker.NewHybridRunbookWorkerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "hybridRunbookWorkerGroupName", "hybridRunbookWorkerId")

payload := hybridrunbookworker.HybridRunbookWorkerCreateParameters{
	// ...
}


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

Example Usage: HybridRunbookWorkerClient.Delete

ctx := context.TODO()
id := hybridrunbookworker.NewHybridRunbookWorkerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "hybridRunbookWorkerGroupName", "hybridRunbookWorkerId")

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: HybridRunbookWorkerClient.Get

ctx := context.TODO()
id := hybridrunbookworker.NewHybridRunbookWorkerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "hybridRunbookWorkerGroupName", "hybridRunbookWorkerId")

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: HybridRunbookWorkerClient.ListByHybridRunbookWorkerGroup

ctx := context.TODO()
id := hybridrunbookworker.NewHybridRunbookWorkerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "hybridRunbookWorkerGroupName")

// alternatively `client.ListByHybridRunbookWorkerGroup(ctx, id, hybridrunbookworker.DefaultListByHybridRunbookWorkerGroupOperationOptions())` can be used to do batched pagination
items, err := client.ListByHybridRunbookWorkerGroupComplete(ctx, id, hybridrunbookworker.DefaultListByHybridRunbookWorkerGroupOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: HybridRunbookWorkerClient.Move

ctx := context.TODO()
id := hybridrunbookworker.NewHybridRunbookWorkerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "hybridRunbookWorkerGroupName", "hybridRunbookWorkerId")

payload := hybridrunbookworker.HybridRunbookWorkerMoveParameters{
	// ...
}


read, err := client.Move(ctx, id, payload)
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 PossibleValuesForWorkerType 

func PossibleValuesForWorkerType() []string

func ValidateHybridRunbookWorkerGroupID 

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

ValidateHybridRunbookWorkerGroupID checks that 'input' can be parsed as a Hybrid Runbook Worker Group ID

func ValidateHybridRunbookWorkerID 

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

ValidateHybridRunbookWorkerID checks that 'input' can be parsed as a Hybrid Runbook Worker ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HybridRunbookWorker
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type HybridRunbookWorker 

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

type HybridRunbookWorkerClient 

type HybridRunbookWorkerClient struct {
	Client *resourcemanager.Client
}

func NewHybridRunbookWorkerClientWithBaseURI 

func NewHybridRunbookWorkerClientWithBaseURI(sdkApi sdkEnv.Api) (*HybridRunbookWorkerClient, error)

func (HybridRunbookWorkerClient) Create 

func (c HybridRunbookWorkerClient) Create(ctx context.Context, id HybridRunbookWorkerId, input HybridRunbookWorkerCreateParameters) (result CreateOperationResponse, err error)

Create ...

func (HybridRunbookWorkerClient) Delete 

func (c HybridRunbookWorkerClient) Delete(ctx context.Context, id HybridRunbookWorkerId) (result DeleteOperationResponse, err error)

Delete ...

func (HybridRunbookWorkerClient) Get 

func (c HybridRunbookWorkerClient) Get(ctx context.Context, id HybridRunbookWorkerId) (result GetOperationResponse, err error)

Get ...

func (HybridRunbookWorkerClient) ListByHybridRunbookWorkerGroup 

func (c HybridRunbookWorkerClient) ListByHybridRunbookWorkerGroup(ctx context.Context, id HybridRunbookWorkerGroupId, options ListByHybridRunbookWorkerGroupOperationOptions) (result ListByHybridRunbookWorkerGroupOperationResponse, err error)

ListByHybridRunbookWorkerGroup ...

func (HybridRunbookWorkerClient) ListByHybridRunbookWorkerGroupComplete 

func (c HybridRunbookWorkerClient) ListByHybridRunbookWorkerGroupComplete(ctx context.Context, id HybridRunbookWorkerGroupId, options ListByHybridRunbookWorkerGroupOperationOptions) (ListByHybridRunbookWorkerGroupCompleteResult, error)

ListByHybridRunbookWorkerGroupComplete retrieves all the results into a single object

func (HybridRunbookWorkerClient) ListByHybridRunbookWorkerGroupCompleteMatchingPredicate 

func (c HybridRunbookWorkerClient) ListByHybridRunbookWorkerGroupCompleteMatchingPredicate(ctx context.Context, id HybridRunbookWorkerGroupId, options ListByHybridRunbookWorkerGroupOperationOptions, predicate HybridRunbookWorkerOperationPredicate) (result ListByHybridRunbookWorkerGroupCompleteResult, err error)

ListByHybridRunbookWorkerGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (HybridRunbookWorkerClient) Move 

func (c HybridRunbookWorkerClient) Move(ctx context.Context, id HybridRunbookWorkerId, input HybridRunbookWorkerMoveParameters) (result MoveOperationResponse, err error)

Move ...

type HybridRunbookWorkerCreateOrUpdateParameters 

type HybridRunbookWorkerCreateOrUpdateParameters struct {
	VMResourceId *string `json:"vmResourceId,omitempty"`
}

type HybridRunbookWorkerCreateParameters 

type HybridRunbookWorkerCreateParameters struct {
	Name       *string                                     `json:"name,omitempty"`
	Properties HybridRunbookWorkerCreateOrUpdateParameters `json:"properties"`
}

type HybridRunbookWorkerGroupId 

type HybridRunbookWorkerGroupId struct {
	SubscriptionId               string
	ResourceGroupName            string
	AutomationAccountName        string
	HybridRunbookWorkerGroupName string
}

HybridRunbookWorkerGroupId is a struct representing the Resource ID for a Hybrid Runbook Worker Group

func NewHybridRunbookWorkerGroupID 

func NewHybridRunbookWorkerGroupID(subscriptionId string, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string) HybridRunbookWorkerGroupId

NewHybridRunbookWorkerGroupID returns a new HybridRunbookWorkerGroupId struct

func ParseHybridRunbookWorkerGroupID 

func ParseHybridRunbookWorkerGroupID(input string) (*HybridRunbookWorkerGroupId, error)

ParseHybridRunbookWorkerGroupID parses 'input' into a HybridRunbookWorkerGroupId

func ParseHybridRunbookWorkerGroupIDInsensitively 

func ParseHybridRunbookWorkerGroupIDInsensitively(input string) (*HybridRunbookWorkerGroupId, error)

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

func (*HybridRunbookWorkerGroupId) FromParseResult 

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

func (HybridRunbookWorkerGroupId) ID 

func (id HybridRunbookWorkerGroupId) ID() string

ID returns the formatted Hybrid Runbook Worker Group ID

func (HybridRunbookWorkerGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Hybrid Runbook Worker Group ID

func (HybridRunbookWorkerGroupId) String 

func (id HybridRunbookWorkerGroupId) String() string

String returns a human-readable description of this Hybrid Runbook Worker Group ID

type HybridRunbookWorkerId 

type HybridRunbookWorkerId struct {
	SubscriptionId               string
	ResourceGroupName            string
	AutomationAccountName        string
	HybridRunbookWorkerGroupName string
	HybridRunbookWorkerId        string
}

HybridRunbookWorkerId is a struct representing the Resource ID for a Hybrid Runbook Worker

func NewHybridRunbookWorkerID 

func NewHybridRunbookWorkerID(subscriptionId string, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, hybridRunbookWorkerId string) HybridRunbookWorkerId

NewHybridRunbookWorkerID returns a new HybridRunbookWorkerId struct

func ParseHybridRunbookWorkerID 

func ParseHybridRunbookWorkerID(input string) (*HybridRunbookWorkerId, error)

ParseHybridRunbookWorkerID parses 'input' into a HybridRunbookWorkerId

func ParseHybridRunbookWorkerIDInsensitively 

func ParseHybridRunbookWorkerIDInsensitively(input string) (*HybridRunbookWorkerId, error)

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

func (*HybridRunbookWorkerId) FromParseResult 

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

func (HybridRunbookWorkerId) ID 

func (id HybridRunbookWorkerId) ID() string

ID returns the formatted Hybrid Runbook Worker ID

func (HybridRunbookWorkerId) Segments 

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

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

func (HybridRunbookWorkerId) String 

func (id HybridRunbookWorkerId) String() string

String returns a human-readable description of this Hybrid Runbook Worker ID

type HybridRunbookWorkerMoveParameters 

type HybridRunbookWorkerMoveParameters struct {
	HybridRunbookWorkerGroupName *string `json:"hybridRunbookWorkerGroupName,omitempty"`
}

type HybridRunbookWorkerOperationPredicate 

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

func (HybridRunbookWorkerOperationPredicate) Matches 

func (p HybridRunbookWorkerOperationPredicate) Matches(input HybridRunbookWorker) bool

type HybridRunbookWorkerProperties 

type HybridRunbookWorkerProperties struct {
	IP                 *string     `json:"ip,omitempty"`
	LastSeenDateTime   *string     `json:"lastSeenDateTime,omitempty"`
	RegisteredDateTime *string     `json:"registeredDateTime,omitempty"`
	VMResourceId       *string     `json:"vmResourceId,omitempty"`
	WorkerName         *string     `json:"workerName,omitempty"`
	WorkerType         *WorkerType `json:"workerType,omitempty"`
}

func (*HybridRunbookWorkerProperties) GetLastSeenDateTimeAsTime 

func (o *HybridRunbookWorkerProperties) GetLastSeenDateTimeAsTime() (*time.Time, error)

func (*HybridRunbookWorkerProperties) GetRegisteredDateTimeAsTime 

func (o *HybridRunbookWorkerProperties) GetRegisteredDateTimeAsTime() (*time.Time, error)

func (*HybridRunbookWorkerProperties) SetLastSeenDateTimeAsTime 

func (o *HybridRunbookWorkerProperties) SetLastSeenDateTimeAsTime(input time.Time)

func (*HybridRunbookWorkerProperties) SetRegisteredDateTimeAsTime 

func (o *HybridRunbookWorkerProperties) SetRegisteredDateTimeAsTime(input time.Time)

type ListByHybridRunbookWorkerGroupCompleteResult 

type ListByHybridRunbookWorkerGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []HybridRunbookWorker
}

type ListByHybridRunbookWorkerGroupCustomPager added in v0.20240628.1153531 

type ListByHybridRunbookWorkerGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByHybridRunbookWorkerGroupCustomPager) NextPageLink() *odata.Link

type ListByHybridRunbookWorkerGroupOperationOptions 

type ListByHybridRunbookWorkerGroupOperationOptions struct {
	Filter *string
}

func DefaultListByHybridRunbookWorkerGroupOperationOptions 

func DefaultListByHybridRunbookWorkerGroupOperationOptions() ListByHybridRunbookWorkerGroupOperationOptions

func (ListByHybridRunbookWorkerGroupOperationOptions) ToHeaders added in v0.20240209.1164150 

func (o ListByHybridRunbookWorkerGroupOperationOptions) ToHeaders() *client.Headers

func (ListByHybridRunbookWorkerGroupOperationOptions) ToOData added in v0.20240209.1164150 

func (o ListByHybridRunbookWorkerGroupOperationOptions) ToOData() *odata.Query

func (ListByHybridRunbookWorkerGroupOperationOptions) ToQuery added in v0.20240209.1164150 

func (o ListByHybridRunbookWorkerGroupOperationOptions) ToQuery() *client.QueryParams

type ListByHybridRunbookWorkerGroupOperationResponse 

type ListByHybridRunbookWorkerGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HybridRunbookWorker
}

type MoveOperationResponse 

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

type WorkerType 

type WorkerType string
const (
	WorkerTypeHybridVOne WorkerType = "HybridV1"
	WorkerTypeHybridVTwo WorkerType = "HybridV2"
)

func (*WorkerType) UnmarshalJSON added in v0.20240209.1164150 

func (s *WorkerType) 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.