objectdatatypes

README

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

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

Client Initialization

client := objectdatatypes.NewObjectDataTypesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ObjectDataTypesClient.ListFieldsByModuleAndType

ctx := context.TODO()
id := objectdatatypes.NewModuleObjectDataTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "moduleValue", "objectDataTypeValue")

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

Example Usage: ObjectDataTypesClient.ListFieldsByType

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

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

Documentation

Index

• func ValidateModuleObjectDataTypeID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateObjectDataTypeID(input interface{}, key string) (warnings []string, errors []error)
• type ListFieldsByModuleAndTypeOperationResponse
• type ListFieldsByTypeOperationResponse
• type ModuleObjectDataTypeId
  • func NewModuleObjectDataTypeID(subscriptionId string, resourceGroupName string, automationAccountName string, ...) ModuleObjectDataTypeId
  • func ParseModuleObjectDataTypeID(input string) (*ModuleObjectDataTypeId, error)
  • func ParseModuleObjectDataTypeIDInsensitively(input string) (*ModuleObjectDataTypeId, error)
  • func (id ModuleObjectDataTypeId) ID() string
  • func (id ModuleObjectDataTypeId) Segments() []resourceids.Segment
  • func (id ModuleObjectDataTypeId) String() string
• type ObjectDataTypeId
  • func NewObjectDataTypeID(subscriptionId string, resourceGroupName string, automationAccountName string, ...) ObjectDataTypeId
  • func ParseObjectDataTypeID(input string) (*ObjectDataTypeId, error)
  • func ParseObjectDataTypeIDInsensitively(input string) (*ObjectDataTypeId, error)
  • func (id ObjectDataTypeId) ID() string
  • func (id ObjectDataTypeId) Segments() []resourceids.Segment
  • func (id ObjectDataTypeId) String() string
• type ObjectDataTypesClient
  • func NewObjectDataTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*ObjectDataTypesClient, error)
  • func (c ObjectDataTypesClient) ListFieldsByModuleAndType(ctx context.Context, id ModuleObjectDataTypeId) (result ListFieldsByModuleAndTypeOperationResponse, err error)
  • func (c ObjectDataTypesClient) ListFieldsByType(ctx context.Context, id ObjectDataTypeId) (result ListFieldsByTypeOperationResponse, err error)
• type TypeField
• type TypeFieldListResult

Functions

func ValidateModuleObjectDataTypeID

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

ValidateModuleObjectDataTypeID checks that 'input' can be parsed as a Module Object Data Type ID

func ValidateObjectDataTypeID

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

ValidateObjectDataTypeID checks that 'input' can be parsed as a Object Data Type ID

Types

type ListFieldsByModuleAndTypeOperationResponse

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

type ListFieldsByTypeOperationResponse

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

type ModuleObjectDataTypeId

type ModuleObjectDataTypeId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ModuleName            string
	ObjectDataTypeName    string
}

ModuleObjectDataTypeId is a struct representing the Resource ID for a Module Object Data Type

func NewModuleObjectDataTypeID

func NewModuleObjectDataTypeID(subscriptionId string, resourceGroupName string, automationAccountName string, moduleName string, objectDataTypeName string) ModuleObjectDataTypeId

NewModuleObjectDataTypeID returns a new ModuleObjectDataTypeId struct

func ParseModuleObjectDataTypeID

func ParseModuleObjectDataTypeID(input string) (*ModuleObjectDataTypeId, error)

ParseModuleObjectDataTypeID parses 'input' into a ModuleObjectDataTypeId

func ParseModuleObjectDataTypeIDInsensitively

func ParseModuleObjectDataTypeIDInsensitively(input string) (*ModuleObjectDataTypeId, error)

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

func (ModuleObjectDataTypeId) ID

func (id ModuleObjectDataTypeId) ID() string

ID returns the formatted Module Object Data Type ID

func (ModuleObjectDataTypeId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Module Object Data Type ID

func (ModuleObjectDataTypeId) String

func (id ModuleObjectDataTypeId) String() string

String returns a human-readable description of this Module Object Data Type ID

type ObjectDataTypeId

type ObjectDataTypeId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ObjectDataTypeName    string
}

ObjectDataTypeId is a struct representing the Resource ID for a Object Data Type

func NewObjectDataTypeID

func NewObjectDataTypeID(subscriptionId string, resourceGroupName string, automationAccountName string, objectDataTypeName string) ObjectDataTypeId

NewObjectDataTypeID returns a new ObjectDataTypeId struct

func ParseObjectDataTypeID

func ParseObjectDataTypeID(input string) (*ObjectDataTypeId, error)

ParseObjectDataTypeID parses 'input' into a ObjectDataTypeId

func ParseObjectDataTypeIDInsensitively

func ParseObjectDataTypeIDInsensitively(input string) (*ObjectDataTypeId, error)

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

func (ObjectDataTypeId) ID

func (id ObjectDataTypeId) ID() string

ID returns the formatted Object Data Type ID

func (ObjectDataTypeId) Segments

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

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

func (ObjectDataTypeId) String

func (id ObjectDataTypeId) String() string

String returns a human-readable description of this Object Data Type ID

type ObjectDataTypesClient

type ObjectDataTypesClient struct {
	Client *resourcemanager.Client
}

func NewObjectDataTypesClientWithBaseURI

func NewObjectDataTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*ObjectDataTypesClient, error)

func (ObjectDataTypesClient) ListFieldsByModuleAndType

func (c ObjectDataTypesClient) ListFieldsByModuleAndType(ctx context.Context, id ModuleObjectDataTypeId) (result ListFieldsByModuleAndTypeOperationResponse, err error)

ListFieldsByModuleAndType ...

func (ObjectDataTypesClient) ListFieldsByType

func (c ObjectDataTypesClient) ListFieldsByType(ctx context.Context, id ObjectDataTypeId) (result ListFieldsByTypeOperationResponse, err error)

ListFieldsByType ...

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"`
}