hybridrunbookworkergroup

package
v0.20230823.1052657 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2022-08-08/hybridrunbookworkergroup Documentation

The hybridrunbookworkergroup SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2022-08-08).

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/2022-08-08/hybridrunbookworkergroup"

Client Initialization

client := hybridrunbookworkergroup.NewHybridRunbookWorkerGroupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: HybridRunbookWorkerGroupClient.Create

ctx := context.TODO()
id := hybridrunbookworkergroup.NewHybridRunbookWorkerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "hybridRunbookWorkerGroupValue")

payload := hybridrunbookworkergroup.HybridRunbookWorkerGroupCreateOrUpdateParameters{
	// ...
}


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: HybridRunbookWorkerGroupClient.Delete

ctx := context.TODO()
id := hybridrunbookworkergroup.NewHybridRunbookWorkerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "hybridRunbookWorkerGroupValue")

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

ctx := context.TODO()
id := hybridrunbookworkergroup.NewHybridRunbookWorkerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "hybridRunbookWorkerGroupValue")

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: HybridRunbookWorkerGroupClient.ListByAutomationAccount

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

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

Example Usage: HybridRunbookWorkerGroupClient.Update

ctx := context.TODO()
id := hybridrunbookworkergroup.NewHybridRunbookWorkerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "hybridRunbookWorkerGroupValue")

payload := hybridrunbookworkergroup.HybridRunbookWorkerGroupCreateOrUpdateParameters{
	// ...
}


read, err := client.Update(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 PossibleValuesForGroupTypeEnum 

func PossibleValuesForGroupTypeEnum() []string

func ValidateAutomationAccountID 

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID

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

Types

type AutomationAccountId 

type AutomationAccountId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
}

AutomationAccountId is a struct representing the Resource ID for a Automation Account

func NewAutomationAccountID 

func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId

NewAutomationAccountID returns a new AutomationAccountId struct

func ParseAutomationAccountID 

func ParseAutomationAccountID(input string) (*AutomationAccountId, error)

ParseAutomationAccountID parses 'input' into a AutomationAccountId

func ParseAutomationAccountIDInsensitively 

func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)

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

func (AutomationAccountId) ID 

func (id AutomationAccountId) ID() string

ID returns the formatted Automation Account ID

func (AutomationAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Automation Account ID

func (AutomationAccountId) String 

func (id AutomationAccountId) String() string

String returns a human-readable description of this Automation Account ID

type CreateOperationResponse 

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

type DeleteOperationResponse added in v0.20230802.1134024 

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

type GetOperationResponse 

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

type GroupTypeEnum 

type GroupTypeEnum string
const (
	GroupTypeEnumSystem GroupTypeEnum = "System"
	GroupTypeEnumUser   GroupTypeEnum = "User"
)

func (*GroupTypeEnum) UnmarshalJSON added in v0.20230406.1124617 

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

type HybridRunbookWorkerGroup 

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

type HybridRunbookWorkerGroupClient 

type HybridRunbookWorkerGroupClient struct {
	Client *resourcemanager.Client
}

func NewHybridRunbookWorkerGroupClientWithBaseURI 

func NewHybridRunbookWorkerGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*HybridRunbookWorkerGroupClient, error)

func (HybridRunbookWorkerGroupClient) Create 

func (c HybridRunbookWorkerGroupClient) Create(ctx context.Context, id HybridRunbookWorkerGroupId, input HybridRunbookWorkerGroupCreateOrUpdateParameters) (result CreateOperationResponse, err error)

Create ...

func (HybridRunbookWorkerGroupClient) Delete added in v0.20230802.1134024 

func (c HybridRunbookWorkerGroupClient) Delete(ctx context.Context, id HybridRunbookWorkerGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (HybridRunbookWorkerGroupClient) Get 

func (c HybridRunbookWorkerGroupClient) Get(ctx context.Context, id HybridRunbookWorkerGroupId) (result GetOperationResponse, err error)

Get ...

func (HybridRunbookWorkerGroupClient) ListByAutomationAccount 

func (c HybridRunbookWorkerGroupClient) ListByAutomationAccount(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions) (result ListByAutomationAccountOperationResponse, err error)

ListByAutomationAccount ...

func (HybridRunbookWorkerGroupClient) ListByAutomationAccountComplete 

func (c HybridRunbookWorkerGroupClient) ListByAutomationAccountComplete(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions) (ListByAutomationAccountCompleteResult, error)

ListByAutomationAccountComplete retrieves all the results into a single object

func (HybridRunbookWorkerGroupClient) ListByAutomationAccountCompleteMatchingPredicate 

func (c HybridRunbookWorkerGroupClient) ListByAutomationAccountCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions, predicate HybridRunbookWorkerGroupOperationPredicate) (result ListByAutomationAccountCompleteResult, err error)

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (HybridRunbookWorkerGroupClient) Update 

func (c HybridRunbookWorkerGroupClient) Update(ctx context.Context, id HybridRunbookWorkerGroupId, input HybridRunbookWorkerGroupCreateOrUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type HybridRunbookWorkerGroupCreateOrUpdateParameters 

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

type HybridRunbookWorkerGroupCreateOrUpdateProperties 

type HybridRunbookWorkerGroupCreateOrUpdateProperties struct {
	Credential *RunAsCredentialAssociationProperty `json:"credential,omitempty"`
}

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) 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 HybridRunbookWorkerGroupOperationPredicate 

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

func (HybridRunbookWorkerGroupOperationPredicate) Matches 

func (p HybridRunbookWorkerGroupOperationPredicate) Matches(input HybridRunbookWorkerGroup) bool

type HybridRunbookWorkerGroupProperties 

type HybridRunbookWorkerGroupProperties struct {
	Credential *RunAsCredentialAssociationProperty `json:"credential,omitempty"`
	GroupType  *GroupTypeEnum                      `json:"groupType,omitempty"`
}

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	Items []HybridRunbookWorkerGroup
}

type ListByAutomationAccountOperationOptions 

type ListByAutomationAccountOperationOptions struct {
	Filter *string
}

func DefaultListByAutomationAccountOperationOptions 

func DefaultListByAutomationAccountOperationOptions() ListByAutomationAccountOperationOptions

func (ListByAutomationAccountOperationOptions) ToHeaders added in v0.20230216.1112329 

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

func (ListByAutomationAccountOperationOptions) ToOData added in v0.20230216.1112329 

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

func (ListByAutomationAccountOperationOptions) ToQuery added in v0.20230216.1112329 

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

type ListByAutomationAccountOperationResponse 

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HybridRunbookWorkerGroup
}

type RunAsCredentialAssociationProperty 

type RunAsCredentialAssociationProperty struct {
	Name *string `json:"name,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HybridRunbookWorkerGroup
}

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.