connections

package
v0.20240923.1142107 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2016-06-01/connections Documentation

The connections SDK allows for interaction with Azure Resource Manager web (API Version 2016-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/web/2016-06-01/connections"

Client Initialization

client := connections.NewConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectionsClient.ConfirmConsentCode

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

payload := connections.ConfirmConsentCodeDefinition{
	// ...
}


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

Example Usage: ConnectionsClient.CreateOrUpdate

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

payload := connections.ApiConnectionDefinition{
	// ...
}


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

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

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

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

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: ConnectionsClient.List

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

read, err := client.List(ctx, id, connections.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}
ctx := context.TODO()
id := connections.NewConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectionName")

payload := connections.ListConsentLinksDefinition{
	// ...
}


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

Example Usage: ConnectionsClient.Update

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

payload := connections.ApiConnectionDefinition{
	// ...
}


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 PossibleValuesForLinkState

func PossibleValuesForLinkState() []string

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 ApiConnectionDefinition

type ApiConnectionDefinition struct {
	Etag       *string                            `json:"etag,omitempty"`
	Id         *string                            `json:"id,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ApiConnectionDefinitionProperties `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type ApiConnectionDefinitionCollection

type ApiConnectionDefinitionCollection struct {
	Value *[]ApiConnectionDefinition `json:"value,omitempty"`
}

type ApiConnectionDefinitionProperties

type ApiConnectionDefinitionProperties struct {
	Api                      *ApiReference                 `json:"api,omitempty"`
	ChangedTime              *string                       `json:"changedTime,omitempty"`
	CreatedTime              *string                       `json:"createdTime,omitempty"`
	CustomParameterValues    *map[string]string            `json:"customParameterValues,omitempty"`
	DisplayName              *string                       `json:"displayName,omitempty"`
	NonSecretParameterValues *map[string]string            `json:"nonSecretParameterValues,omitempty"`
	ParameterValues          *map[string]string            `json:"parameterValues,omitempty"`
	Statuses                 *[]ConnectionStatusDefinition `json:"statuses,omitempty"`
	TestLinks                *[]ApiConnectionTestLink      `json:"testLinks,omitempty"`
}

func (*ApiConnectionDefinitionProperties) GetChangedTimeAsTime

func (o *ApiConnectionDefinitionProperties) GetChangedTimeAsTime() (*time.Time, error)

func (*ApiConnectionDefinitionProperties) GetCreatedTimeAsTime

func (o *ApiConnectionDefinitionProperties) GetCreatedTimeAsTime() (*time.Time, error)

func (*ApiConnectionDefinitionProperties) SetChangedTimeAsTime

func (o *ApiConnectionDefinitionProperties) SetChangedTimeAsTime(input time.Time)

func (*ApiConnectionDefinitionProperties) SetCreatedTimeAsTime

func (o *ApiConnectionDefinitionProperties) SetCreatedTimeAsTime(input time.Time)
type ApiConnectionTestLink struct {
	Method     *string `json:"method,omitempty"`
	RequestUri *string `json:"requestUri,omitempty"`
}

type ApiReference

type ApiReference struct {
	BrandColor  *string      `json:"brandColor,omitempty"`
	Description *string      `json:"description,omitempty"`
	DisplayName *string      `json:"displayName,omitempty"`
	IconUri     *string      `json:"iconUri,omitempty"`
	Id          *string      `json:"id,omitempty"`
	Name        *string      `json:"name,omitempty"`
	Swagger     *interface{} `json:"swagger,omitempty"`
	Type        *string      `json:"type,omitempty"`
}

type ConfirmConsentCodeDefinition

type ConfirmConsentCodeDefinition struct {
	Code     *string `json:"code,omitempty"`
	ObjectId *string `json:"objectId,omitempty"`
	TenantId *string `json:"tenantId,omitempty"`
}

type ConfirmConsentCodeOperationResponse

type ConfirmConsentCodeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfirmConsentCodeDefinition
}

type ConnectionError

type ConnectionError struct {
	Etag       *string                    `json:"etag,omitempty"`
	Id         *string                    `json:"id,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *ConnectionErrorProperties `json:"properties,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type ConnectionErrorProperties

type ConnectionErrorProperties struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type ConnectionId

type ConnectionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ConnectionName    string
}

ConnectionId is a struct representing the Resource ID for a Connection

func NewConnectionID

func NewConnectionID(subscriptionId string, resourceGroupName 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) FromParseResult

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

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 ConnectionStatusDefinition

type ConnectionStatusDefinition struct {
	Error  *ConnectionError `json:"error,omitempty"`
	Status *string          `json:"status,omitempty"`
	Target *string          `json:"target,omitempty"`
}

type ConnectionsClient

type ConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewConnectionsClientWithBaseURI

func NewConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectionsClient, error)

func (ConnectionsClient) ConfirmConsentCode

ConfirmConsentCode ...

func (ConnectionsClient) CreateOrUpdate

CreateOrUpdate ...

func (ConnectionsClient) Delete

Delete ...

func (ConnectionsClient) Get

Get ...

func (ConnectionsClient) List

List ...

ListConsentLinks ...

func (ConnectionsClient) Update

Update ...

type ConsentLinkCollection

type ConsentLinkCollection struct {
	Value *[]ConsentLinkDefinition `json:"value,omitempty"`
}

type ConsentLinkDefinition

type ConsentLinkDefinition struct {
	DisplayName        *string    `json:"displayName,omitempty"`
	FirstPartyLoginUri *string    `json:"firstPartyLoginUri,omitempty"`
	Link               *string    `json:"link,omitempty"`
	Status             *LinkState `json:"status,omitempty"`
}

type ConsentLinkParameterDefinition

type ConsentLinkParameterDefinition struct {
	ObjectId      *string `json:"objectId,omitempty"`
	ParameterName *string `json:"parameterName,omitempty"`
	RedirectUrl   *string `json:"redirectUrl,omitempty"`
	TenantId      *string `json:"tenantId,omitempty"`
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type LinkState

type LinkState string
const (
	LinkStateAuthenticated   LinkState = "Authenticated"
	LinkStateError           LinkState = "Error"
	LinkStateUnauthenticated LinkState = "Unauthenticated"
)

func (*LinkState) UnmarshalJSON

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

type ListConsentLinksDefinition

type ListConsentLinksDefinition struct {
	Parameters *[]ConsentLinkParameterDefinition `json:"parameters,omitempty"`
}

type ListConsentLinksOperationResponse

type ListConsentLinksOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConsentLinkCollection
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiConnectionDefinitionCollection
}

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL