connectiontype

package
v0.20240524.1090207 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

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

Client Initialization

client := connectiontype.NewConnectionTypeClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectionTypeClient.CreateOrUpdate

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

payload := connectiontype.ConnectionTypeCreateOrUpdateParameters{
	// ...
}


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

Example Usage: ConnectionTypeClient.Delete

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

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

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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 ValidateConnectionTypeID 

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

ValidateConnectionTypeID checks that 'input' can be parsed as a Connection Type 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) 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 ConnectionType 

type ConnectionType struct {
	Id         *string                   `json:"id,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *ConnectionTypeProperties `json:"properties,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type ConnectionTypeClient 

type ConnectionTypeClient struct {
	Client *resourcemanager.Client
}

func NewConnectionTypeClientWithBaseURI 

func NewConnectionTypeClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectionTypeClient, error)

func (ConnectionTypeClient) CreateOrUpdate 

func (c ConnectionTypeClient) CreateOrUpdate(ctx context.Context, id ConnectionTypeId, input ConnectionTypeCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ConnectionTypeClient) Delete 

func (c ConnectionTypeClient) Delete(ctx context.Context, id ConnectionTypeId) (result DeleteOperationResponse, err error)

Delete ...

func (ConnectionTypeClient) Get 

func (c ConnectionTypeClient) Get(ctx context.Context, id ConnectionTypeId) (result GetOperationResponse, err error)

Get ...

func (ConnectionTypeClient) ListByAutomationAccount 

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

ListByAutomationAccount ...

func (ConnectionTypeClient) ListByAutomationAccountComplete 

func (c ConnectionTypeClient) ListByAutomationAccountComplete(ctx context.Context, id AutomationAccountId) (ListByAutomationAccountCompleteResult, error)

ListByAutomationAccountComplete retrieves all the results into a single object

func (ConnectionTypeClient) ListByAutomationAccountCompleteMatchingPredicate 

func (c ConnectionTypeClient) ListByAutomationAccountCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, predicate ConnectionTypeOperationPredicate) (result ListByAutomationAccountCompleteResult, err error)

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ConnectionTypeCreateOrUpdateParameters 

type ConnectionTypeCreateOrUpdateParameters struct {
	Name       string                                 `json:"name"`
	Properties ConnectionTypeCreateOrUpdateProperties `json:"properties"`
}

type ConnectionTypeCreateOrUpdateProperties 

type ConnectionTypeCreateOrUpdateProperties struct {
	FieldDefinitions map[string]FieldDefinition `json:"fieldDefinitions"`
	IsGlobal         *bool                      `json:"isGlobal,omitempty"`
}

type ConnectionTypeId 

type ConnectionTypeId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ConnectionTypeName    string
}

ConnectionTypeId is a struct representing the Resource ID for a Connection Type

func NewConnectionTypeID 

func NewConnectionTypeID(subscriptionId string, resourceGroupName string, automationAccountName string, connectionTypeName string) ConnectionTypeId

NewConnectionTypeID returns a new ConnectionTypeId struct

func ParseConnectionTypeID 

func ParseConnectionTypeID(input string) (*ConnectionTypeId, error)

ParseConnectionTypeID parses 'input' into a ConnectionTypeId

func ParseConnectionTypeIDInsensitively 

func ParseConnectionTypeIDInsensitively(input string) (*ConnectionTypeId, error)

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

func (*ConnectionTypeId) FromParseResult 

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

func (ConnectionTypeId) ID 

func (id ConnectionTypeId) ID() string

ID returns the formatted Connection Type ID

func (ConnectionTypeId) Segments 

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

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

func (ConnectionTypeId) String 

func (id ConnectionTypeId) String() string

String returns a human-readable description of this Connection Type ID

type ConnectionTypeOperationPredicate 

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

func (ConnectionTypeOperationPredicate) Matches 

func (p ConnectionTypeOperationPredicate) Matches(input ConnectionType) bool

type ConnectionTypeProperties 

type ConnectionTypeProperties struct {
	CreationTime     *string                     `json:"creationTime,omitempty"`
	Description      *string                     `json:"description,omitempty"`
	FieldDefinitions *map[string]FieldDefinition `json:"fieldDefinitions,omitempty"`
	IsGlobal         *bool                       `json:"isGlobal,omitempty"`
	LastModifiedTime *string                     `json:"lastModifiedTime,omitempty"`
}

func (*ConnectionTypeProperties) GetCreationTimeAsTime 

func (o *ConnectionTypeProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*ConnectionTypeProperties) GetLastModifiedTimeAsTime 

func (o *ConnectionTypeProperties) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*ConnectionTypeProperties) SetCreationTimeAsTime 

func (o *ConnectionTypeProperties) SetCreationTimeAsTime(input time.Time)

func (*ConnectionTypeProperties) SetLastModifiedTimeAsTime 

func (o *ConnectionTypeProperties) SetLastModifiedTimeAsTime(input time.Time)

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionType
}

type DeleteOperationResponse 

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

type FieldDefinition 

type FieldDefinition struct {
	IsEncrypted *bool  `json:"isEncrypted,omitempty"`
	IsOptional  *bool  `json:"isOptional,omitempty"`
	Type        string `json:"type"`
}

type GetOperationResponse 

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

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ConnectionType
}

type ListByAutomationAccountOperationResponse 

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

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.