bot

package
v0.20240710.1075622 Latest Latest
Warning

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

 Go to latest Published: Jul 10, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

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

Client Initialization

client := bot.NewBotClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BotClient.Create

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

payload := bot.Bot{
	// ...
}


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

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

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

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

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: BotClient.GetCheckNameAvailability

ctx := context.TODO()

payload := bot.CheckNameAvailabilityRequestBody{
	// ...
}


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

Example Usage: BotClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: BotClient.ListByResourceGroup

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

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

Example Usage: BotClient.Update

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

payload := bot.Bot{
	// ...
}


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 PossibleValuesForMsaAppType 

func PossibleValuesForMsaAppType() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState 

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus 

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForSkuName 

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

Types

type Bot 

type Bot 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 *BotProperties     `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 BotClient 

type BotClient struct {
	Client *resourcemanager.Client
}

func NewBotClientWithBaseURI 

func NewBotClientWithBaseURI(sdkApi sdkEnv.Api) (*BotClient, error)

func (BotClient) Create 

func (c BotClient) Create(ctx context.Context, id commonids.BotServiceId, input Bot) (result CreateOperationResponse, err error)

Create ...

func (BotClient) Delete 

func (c BotClient) Delete(ctx context.Context, id commonids.BotServiceId) (result DeleteOperationResponse, err error)

Delete ...

func (BotClient) Get 

func (c BotClient) Get(ctx context.Context, id commonids.BotServiceId) (result GetOperationResponse, err error)

Get ...

func (BotClient) GetCheckNameAvailability 

func (c BotClient) GetCheckNameAvailability(ctx context.Context, input CheckNameAvailabilityRequestBody) (result GetCheckNameAvailabilityOperationResponse, err error)

GetCheckNameAvailability ...

func (BotClient) List 

func (c BotClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (BotClient) ListByResourceGroup 

func (c BotClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (BotClient) ListByResourceGroupComplete 

func (c BotClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (BotClient) ListByResourceGroupCompleteMatchingPredicate 

func (c BotClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate BotOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BotClient) ListComplete 

func (c BotClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (BotClient) ListCompleteMatchingPredicate 

func (c BotClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate BotOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BotClient) Update 

func (c BotClient) Update(ctx context.Context, id commonids.BotServiceId, input Bot) (result UpdateOperationResponse, err error)

Update ...

type BotOperationPredicate 

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

func (BotOperationPredicate) Matches 

func (p BotOperationPredicate) Matches(input Bot) bool

type BotProperties 

type BotProperties struct {
	AllSettings                       *map[string]string           `json:"allSettings,omitempty"`
	AppPasswordHint                   *string                      `json:"appPasswordHint,omitempty"`
	CmekEncryptionStatus              *string                      `json:"cmekEncryptionStatus,omitempty"`
	CmekKeyVaultUrl                   *string                      `json:"cmekKeyVaultUrl,omitempty"`
	ConfiguredChannels                *[]string                    `json:"configuredChannels,omitempty"`
	Description                       *string                      `json:"description,omitempty"`
	DeveloperAppInsightKey            *string                      `json:"developerAppInsightKey,omitempty"`
	DeveloperAppInsightsApiKey        *string                      `json:"developerAppInsightsApiKey,omitempty"`
	DeveloperAppInsightsApplicationId *string                      `json:"developerAppInsightsApplicationId,omitempty"`
	DisableLocalAuth                  *bool                        `json:"disableLocalAuth,omitempty"`
	DisplayName                       string                       `json:"displayName"`
	EnabledChannels                   *[]string                    `json:"enabledChannels,omitempty"`
	Endpoint                          string                       `json:"endpoint"`
	EndpointVersion                   *string                      `json:"endpointVersion,omitempty"`
	IconUrl                           *string                      `json:"iconUrl,omitempty"`
	IsCmekEnabled                     *bool                        `json:"isCmekEnabled,omitempty"`
	IsDeveloperAppInsightsApiKeySet   *bool                        `json:"isDeveloperAppInsightsApiKeySet,omitempty"`
	IsStreamingSupported              *bool                        `json:"isStreamingSupported,omitempty"`
	LuisAppIds                        *[]string                    `json:"luisAppIds,omitempty"`
	LuisKey                           *string                      `json:"luisKey,omitempty"`
	ManifestUrl                       *string                      `json:"manifestUrl,omitempty"`
	MigrationToken                    *string                      `json:"migrationToken,omitempty"`
	MsaAppId                          string                       `json:"msaAppId"`
	MsaAppMSIResourceId               *string                      `json:"msaAppMSIResourceId,omitempty"`
	MsaAppTenantId                    *string                      `json:"msaAppTenantId,omitempty"`
	MsaAppType                        *MsaAppType                  `json:"msaAppType,omitempty"`
	OpenWithHint                      *string                      `json:"openWithHint,omitempty"`
	Parameters                        *map[string]string           `json:"parameters,omitempty"`
	PrivateEndpointConnections        *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState                 *string                      `json:"provisioningState,omitempty"`
	PublicNetworkAccess               *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
	PublishingCredentials             *string                      `json:"publishingCredentials,omitempty"`
	SchemaTransformationVersion       *string                      `json:"schemaTransformationVersion,omitempty"`
	StorageResourceId                 *string                      `json:"storageResourceId,omitempty"`
	TenantId                          *string                      `json:"tenantId,omitempty"`
}

type CheckNameAvailabilityRequestBody 

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

type CheckNameAvailabilityResponseBody 

type CheckNameAvailabilityResponseBody struct {
	AbsCode *string `json:"absCode,omitempty"`
	Message *string `json:"message,omitempty"`
	Valid   *bool   `json:"valid,omitempty"`
}

type CreateOperationResponse 

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

type DeleteOperationResponse 

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

type GetCheckNameAvailabilityOperationResponse 

type GetCheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityResponseBody
}

type GetOperationResponse 

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

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 ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Bot
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Bot
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Bot
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Bot
}

type MsaAppType 

type MsaAppType string
const (
	MsaAppTypeMultiTenant     MsaAppType = "MultiTenant"
	MsaAppTypeSingleTenant    MsaAppType = "SingleTenant"
	MsaAppTypeUserAssignedMSI MsaAppType = "UserAssignedMSI"
)

func (*MsaAppType) UnmarshalJSON 

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

type PrivateEndpoint 

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection 

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

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                   `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON 

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

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON 

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

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON 

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

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        *Bot
}

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.