agentregistrationinformation

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2019-06-01/agentregistrationinformation Documentation

The agentregistrationinformation SDK allows for interaction with Azure Resource Manager automation (API Version 2019-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/automation/2019-06-01/agentregistrationinformation"

Client Initialization

client := agentregistrationinformation.NewAgentRegistrationInformationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AgentRegistrationInformationClient.Get

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

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: AgentRegistrationInformationClient.RegenerateKey

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

payload := agentregistrationinformation.AgentRegistrationRegenerateKeyParameter{
	// ...
}


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

Documentation

Index

• func PossibleValuesForAgentRegistrationKeyName() []string
• func ValidateAutomationAccountID(input interface{}, key string) (warnings []string, errors []error)
• type AgentRegistration
• type AgentRegistrationInformationClient
  • func NewAgentRegistrationInformationClientWithBaseURI(sdkApi sdkEnv.Api) (*AgentRegistrationInformationClient, error)
  • func (c AgentRegistrationInformationClient) Get(ctx context.Context, id AutomationAccountId) (result GetOperationResponse, err error)
  • func (c AgentRegistrationInformationClient) RegenerateKey(ctx context.Context, id AutomationAccountId, ...) (result RegenerateKeyOperationResponse, err error)
• type AgentRegistrationKeyName
  • func (s *AgentRegistrationKeyName) UnmarshalJSON(bytes []byte) error
• type AgentRegistrationKeys
• type AgentRegistrationRegenerateKeyParameter
• 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) FromParseResult(input resourceids.ParseResult) error
  • func (id AutomationAccountId) ID() string
  • func (id AutomationAccountId) Segments() []resourceids.Segment
  • func (id AutomationAccountId) String() string
• type GetOperationResponse
• type RegenerateKeyOperationResponse

Functions

func PossibleValuesForAgentRegistrationKeyName

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

type AgentRegistration struct {
	DscMetaConfiguration *string                `json:"dscMetaConfiguration,omitempty"`
	Endpoint             *string                `json:"endpoint,omitempty"`
	Id                   *string                `json:"id,omitempty"`
	Keys                 *AgentRegistrationKeys `json:"keys,omitempty"`
}

type AgentRegistrationInformationClient

type AgentRegistrationInformationClient struct {
	Client *resourcemanager.Client
}

func NewAgentRegistrationInformationClientWithBaseURI

func NewAgentRegistrationInformationClientWithBaseURI(sdkApi sdkEnv.Api) (*AgentRegistrationInformationClient, error)

func (AgentRegistrationInformationClient) Get

func (c AgentRegistrationInformationClient) Get(ctx context.Context, id AutomationAccountId) (result GetOperationResponse, err error)

Get ...

func (AgentRegistrationInformationClient) RegenerateKey

func (c AgentRegistrationInformationClient) RegenerateKey(ctx context.Context, id AutomationAccountId, input AgentRegistrationRegenerateKeyParameter) (result RegenerateKeyOperationResponse, err error)

RegenerateKey ...

type AgentRegistrationKeyName

type AgentRegistrationKeyName string

const (
	AgentRegistrationKeyNamePrimary   AgentRegistrationKeyName = "primary"
	AgentRegistrationKeyNameSecondary AgentRegistrationKeyName = "secondary"
)

func (*AgentRegistrationKeyName) UnmarshalJSON

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

type AgentRegistrationKeys

type AgentRegistrationKeys struct {
	Primary   *string `json:"primary,omitempty"`
	Secondary *string `json:"secondary,omitempty"`
}

type AgentRegistrationRegenerateKeyParameter

type AgentRegistrationRegenerateKeyParameter struct {
	KeyName AgentRegistrationKeyName `json:"keyName"`
}

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

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

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 GetOperationResponse

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

type RegenerateKeyOperationResponse

type RegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AgentRegistration
}