botconnection

package
v0.20240215.1143935 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/botservice/2022-09-15/botconnection Documentation

The botconnection SDK allows for interaction with the Azure Resource Manager Service botservice (API Version 2022-09-15).

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/botservice/2022-09-15/botconnection"

Client Initialization

client := botconnection.NewBotConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BotConnectionClient.Create

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

payload := botconnection.ConnectionSetting{
	// ...
}


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

Example Usage: BotConnectionClient.Delete

ctx := context.TODO()
id := botconnection.NewConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceValue", "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: BotConnectionClient.Get

ctx := context.TODO()
id := botconnection.NewConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceValue", "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: BotConnectionClient.ListByBotService

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

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

Example Usage: BotConnectionClient.ListWithSecrets

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

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

Example Usage: BotConnectionClient.Update

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

payload := botconnection.ConnectionSetting{
	// ...
}


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 PossibleValuesForKind 

func PossibleValuesForKind() []string

func PossibleValuesForSkuName 

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []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 BotConnectionClient 

type BotConnectionClient struct {
	Client *resourcemanager.Client
}

func NewBotConnectionClientWithBaseURI 

func NewBotConnectionClientWithBaseURI(sdkApi sdkEnv.Api) (*BotConnectionClient, error)

func (BotConnectionClient) Create 

func (c BotConnectionClient) Create(ctx context.Context, id ConnectionId, input ConnectionSetting) (result CreateOperationResponse, err error)

Create ...

func (BotConnectionClient) Delete 

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

Delete ...

func (BotConnectionClient) Get 

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

Get ...

func (BotConnectionClient) ListByBotService 

func (c BotConnectionClient) ListByBotService(ctx context.Context, id commonids.BotServiceId) (result ListByBotServiceOperationResponse, err error)

ListByBotService ...

func (BotConnectionClient) ListByBotServiceComplete 

func (c BotConnectionClient) ListByBotServiceComplete(ctx context.Context, id commonids.BotServiceId) (ListByBotServiceCompleteResult, error)

ListByBotServiceComplete retrieves all the results into a single object

func (BotConnectionClient) ListByBotServiceCompleteMatchingPredicate 

func (c BotConnectionClient) ListByBotServiceCompleteMatchingPredicate(ctx context.Context, id commonids.BotServiceId, predicate ConnectionSettingOperationPredicate) (result ListByBotServiceCompleteResult, err error)

ListByBotServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BotConnectionClient) ListWithSecrets 

func (c BotConnectionClient) ListWithSecrets(ctx context.Context, id ConnectionId) (result ListWithSecretsOperationResponse, err error)

ListWithSecrets ...

func (BotConnectionClient) Update 

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

Update ...

type ConnectionId 

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

ConnectionId is a struct representing the Resource ID for a Connection

func NewConnectionID 

func NewConnectionID(subscriptionId string, resourceGroupName string, botServiceName 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 ConnectionSetting 

type ConnectionSetting struct {
	Etag       *string                      `json:"etag,omitempty"`
	Id         *string                      `json:"id,omitempty"`
	Kind       *Kind                        `json:"kind,omitempty"`
	Location   *string                      `json:"location,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *ConnectionSettingProperties `json:"properties,omitempty"`
	Sku        *Sku                         `json:"sku,omitempty"`
	Tags       *map[string]string           `json:"tags,omitempty"`
	Type       *string                      `json:"type,omitempty"`
	Zones      *zones.Schema                `json:"zones,omitempty"`
}

type ConnectionSettingOperationPredicate 

type ConnectionSettingOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ConnectionSettingOperationPredicate) Matches 

func (p ConnectionSettingOperationPredicate) Matches(input ConnectionSetting) bool

type ConnectionSettingParameter 

type ConnectionSettingParameter struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

type ConnectionSettingProperties 

type ConnectionSettingProperties struct {
	ClientId                   *string                       `json:"clientId,omitempty"`
	ClientSecret               *string                       `json:"clientSecret,omitempty"`
	Id                         *string                       `json:"id,omitempty"`
	Name                       *string                       `json:"name,omitempty"`
	Parameters                 *[]ConnectionSettingParameter `json:"parameters,omitempty"`
	ProvisioningState          *string                       `json:"provisioningState,omitempty"`
	Scopes                     *string                       `json:"scopes,omitempty"`
	ServiceProviderDisplayName *string                       `json:"serviceProviderDisplayName,omitempty"`
	ServiceProviderId          *string                       `json:"serviceProviderId,omitempty"`
	SettingId                  *string                       `json:"settingId,omitempty"`
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionSetting
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type Kind 

type Kind string
const (
	KindAzurebot Kind = "azurebot"
	KindBot      Kind = "bot"
	KindDesigner Kind = "designer"
	KindFunction Kind = "function"
	KindSdk      Kind = "sdk"
)

func (*Kind) UnmarshalJSON 

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

type ListByBotServiceCompleteResult 

type ListByBotServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ConnectionSetting
}

type ListByBotServiceOperationResponse 

type ListByBotServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConnectionSetting
}

type ListWithSecretsOperationResponse 

type ListWithSecretsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionSetting
}

type Sku 

type Sku struct {
	Name SkuName  `json:"name"`
	Tier *SkuTier `json:"tier,omitempty"`
}

type SkuName 

type SkuName string
const (
	SkuNameFZero SkuName = "F0"
	SkuNameSOne  SkuName = "S1"
)

func (*SkuName) UnmarshalJSON 

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

type SkuTier 

type SkuTier string
const (
	SkuTierFree     SkuTier = "Free"
	SkuTierStandard SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON 

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

type UpdateOperationResponse 

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

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.