connection

package
v0.20231121.1131003 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

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

Client Initialization

client := connection.NewConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectionClient.CreateOrUpdate

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

payload := connection.ConnectionCreateOrUpdateParameters{
	// ...
}


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: ConnectionClient.Delete

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

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

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

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

ctx := context.TODO()
id := connection.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
}

Example Usage: ConnectionClient.Update

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

payload := connection.ConnectionUpdateParameters{
	// ...
}


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

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 ValidateConnectionID 

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

ValidateConnectionID checks that 'input' can be parsed as a Connection 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 Connection 

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

type ConnectionClient 

type ConnectionClient struct {
	Client *resourcemanager.Client
}

func NewConnectionClientWithBaseURI 

func NewConnectionClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectionClient, error)

func (ConnectionClient) CreateOrUpdate 

func (c ConnectionClient) CreateOrUpdate(ctx context.Context, id ConnectionId, input ConnectionCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ConnectionClient) Delete 

func (c ConnectionClient) Delete(ctx context.Context, id ConnectionId) (result DeleteOperationResponse, err error)

Delete ...

func (ConnectionClient) Get 

func (c ConnectionClient) Get(ctx context.Context, id ConnectionId) (result GetOperationResponse, err error)

Get ...

func (ConnectionClient) ListByAutomationAccount 

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

ListByAutomationAccount ...

func (ConnectionClient) ListByAutomationAccountComplete 

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

ListByAutomationAccountComplete retrieves all the results into a single object

func (ConnectionClient) ListByAutomationAccountCompleteMatchingPredicate 

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

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConnectionClient) Update 

func (c ConnectionClient) Update(ctx context.Context, id ConnectionId, input ConnectionUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type ConnectionCreateOrUpdateParameters 

type ConnectionCreateOrUpdateParameters struct {
	Name       string                             `json:"name"`
	Properties ConnectionCreateOrUpdateProperties `json:"properties"`
}

type ConnectionCreateOrUpdateProperties 

type ConnectionCreateOrUpdateProperties struct {
	ConnectionType        ConnectionTypeAssociationProperty `json:"connectionType"`
	Description           *string                           `json:"description,omitempty"`
	FieldDefinitionValues *map[string]string                `json:"fieldDefinitionValues,omitempty"`
}

type ConnectionId 

type ConnectionId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ConnectionName        string
}

ConnectionId is a struct representing the Resource ID for a Connection

func NewConnectionID 

func NewConnectionID(subscriptionId string, resourceGroupName string, automationAccountName string, connectionName string) ConnectionId

NewConnectionID returns a new ConnectionId struct

func ParseConnectionID 

func ParseConnectionID(input string) (*ConnectionId, error)

ParseConnectionID parses 'input' into a ConnectionId

func ParseConnectionIDInsensitively 

func ParseConnectionIDInsensitively(input string) (*ConnectionId, error)

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

func (ConnectionId) ID 

func (id ConnectionId) ID() string

ID returns the formatted Connection ID

func (ConnectionId) Segments 

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

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

func (ConnectionId) String 

func (id ConnectionId) String() string

String returns a human-readable description of this Connection ID

type ConnectionOperationPredicate 

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

func (ConnectionOperationPredicate) Matches 

func (p ConnectionOperationPredicate) Matches(input Connection) bool

type ConnectionProperties 

type ConnectionProperties struct {
	ConnectionType        *ConnectionTypeAssociationProperty `json:"connectionType,omitempty"`
	CreationTime          *string                            `json:"creationTime,omitempty"`
	Description           *string                            `json:"description,omitempty"`
	FieldDefinitionValues *map[string]string                 `json:"fieldDefinitionValues,omitempty"`
	LastModifiedTime      *string                            `json:"lastModifiedTime,omitempty"`
}

func (*ConnectionProperties) GetCreationTimeAsTime 

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

func (*ConnectionProperties) GetLastModifiedTimeAsTime 

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

func (*ConnectionProperties) SetCreationTimeAsTime 

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

func (*ConnectionProperties) SetLastModifiedTimeAsTime 

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

type ConnectionTypeAssociationProperty 

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

type ConnectionUpdateParameters 

type ConnectionUpdateParameters struct {
	Name       *string                     `json:"name,omitempty"`
	Properties *ConnectionUpdateProperties `json:"properties,omitempty"`
}

type ConnectionUpdateProperties 

type ConnectionUpdateProperties struct {
	Description           *string            `json:"description,omitempty"`
	FieldDefinitionValues *map[string]string `json:"fieldDefinitionValues,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	Items []Connection
}

type ListByAutomationAccountOperationResponse 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Connection
}

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.