typefields

README

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

The typefields 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/typefields"

Client Initialization

client := typefields.NewTypeFieldsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TypeFieldsClient.FieldsListByType

ctx := context.TODO()
id := typefields.NewTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "moduleValue", "typeValue")

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

Documentation

Index

• func ValidateTypeID(input interface{}, key string) (warnings []string, errors []error)
• type FieldsListByTypeOperationResponse
• type TypeField
• type TypeFieldListResult
• type TypeFieldsClient
  • func NewTypeFieldsClientWithBaseURI(api environments.Api) (*TypeFieldsClient, error)
  • func (c TypeFieldsClient) FieldsListByType(ctx context.Context, id TypeId) (result FieldsListByTypeOperationResponse, err error)
• type TypeId
  • func NewTypeID(subscriptionId string, resourceGroupName string, automationAccountName string, ...) TypeId
  • func ParseTypeID(input string) (*TypeId, error)
  • func ParseTypeIDInsensitively(input string) (*TypeId, error)
  • func (id TypeId) ID() string
  • func (id TypeId) Segments() []resourceids.Segment
  • func (id TypeId) String() string

Functions

func ValidateTypeID

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

ValidateTypeID checks that 'input' can be parsed as a Type ID

Types

type FieldsListByTypeOperationResponse

type FieldsListByTypeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TypeFieldListResult
}

type TypeField

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

type TypeFieldListResult

type TypeFieldListResult struct {
	Value *[]TypeField `json:"value,omitempty"`
}

type TypeFieldsClient

type TypeFieldsClient struct {
	Client *resourcemanager.Client
}

func NewTypeFieldsClientWithBaseURI

func NewTypeFieldsClientWithBaseURI(api environments.Api) (*TypeFieldsClient, error)

func (TypeFieldsClient) FieldsListByType

func (c TypeFieldsClient) FieldsListByType(ctx context.Context, id TypeId) (result FieldsListByTypeOperationResponse, err error)

FieldsListByType ...

type TypeId

type TypeId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ModuleName            string
	TypeName              string
}

TypeId is a struct representing the Resource ID for a Type

func NewTypeID

func NewTypeID(subscriptionId string, resourceGroupName string, automationAccountName string, moduleName string, typeName string) TypeId

NewTypeID returns a new TypeId struct

func ParseTypeID

func ParseTypeID(input string) (*TypeId, error)

ParseTypeID parses 'input' into a TypeId

func ParseTypeIDInsensitively

func ParseTypeIDInsensitively(input string) (*TypeId, error)

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

func (TypeId) ID

func (id TypeId) ID() string

ID returns the formatted Type ID

func (TypeId) Segments

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

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

func (TypeId) String

func (id TypeId) String() string

String returns a human-readable description of this Type ID