listkeys

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2023-11-01/listkeys Documentation

The listkeys SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2023-11-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/automation/2023-11-01/listkeys"

Client Initialization

client := listkeys.NewListKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ListKeysClient.KeysListByAutomationAccount

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

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

Documentation

Index

• func PossibleValuesForAutomationKeyName() []string
• func PossibleValuesForAutomationKeyPermissions() []string
• func ValidateAutomationAccountID(input interface{}, key string) (warnings []string, errors []error)
• type AutomationAccountId
  • func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId
  • func ParseAutomationAccountID(input string) (*AutomationAccountId, error)
  • func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)
  • func (id AutomationAccountId) ID() string
  • func (id AutomationAccountId) Segments() []resourceids.Segment
  • func (id AutomationAccountId) String() string
• type AutomationKeyName
  • func (s *AutomationKeyName) UnmarshalJSON(bytes []byte) error
• type AutomationKeyPermissions
  • func (s *AutomationKeyPermissions) UnmarshalJSON(bytes []byte) error
• type Key
• type KeyListResult
• type KeysListByAutomationAccountOperationResponse
• type ListKeysClient
  • func NewListKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*ListKeysClient, error)
  • func (c ListKeysClient) KeysListByAutomationAccount(ctx context.Context, id AutomationAccountId) (result KeysListByAutomationAccountOperationResponse, err error)

Functions

func PossibleValuesForAutomationKeyName

func PossibleValuesForAutomationKeyName() []string

func PossibleValuesForAutomationKeyPermissions

func PossibleValuesForAutomationKeyPermissions() []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

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 AutomationKeyName

type AutomationKeyName string

const (
	AutomationKeyNamePrimary   AutomationKeyName = "Primary"
	AutomationKeyNameSecondary AutomationKeyName = "Secondary"
)

func (*AutomationKeyName) UnmarshalJSON

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

type AutomationKeyPermissions

type AutomationKeyPermissions string

const (
	AutomationKeyPermissionsFull AutomationKeyPermissions = "Full"
	AutomationKeyPermissionsRead AutomationKeyPermissions = "Read"
)

func (*AutomationKeyPermissions) UnmarshalJSON

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

type Key

type Key struct {
	KeyName     *AutomationKeyName        `json:"KeyName,omitempty"`
	Permissions *AutomationKeyPermissions `json:"Permissions,omitempty"`
	Value       *string                   `json:"Value,omitempty"`
}

type KeyListResult

type KeyListResult struct {
	Keys *[]Key `json:"keys,omitempty"`
}

type KeysListByAutomationAccountOperationResponse

type KeysListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *KeyListResult
}

type ListKeysClient

type ListKeysClient struct {
	Client *resourcemanager.Client
}

func NewListKeysClientWithBaseURI

func NewListKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*ListKeysClient, error)

func (ListKeysClient) KeysListByAutomationAccount

func (c ListKeysClient) KeysListByAutomationAccount(ctx context.Context, id AutomationAccountId) (result KeysListByAutomationAccountOperationResponse, err error)

KeysListByAutomationAccount ...