README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/healthbot/2022-08-08/healthbots
Documentation
The healthbots
SDK allows for interaction with the Azure Resource Manager Service healthbot
(API Version 2022-08-08
).
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/healthbot/2022-08-08/healthbots"
Client Initialization
client := healthbots.NewHealthbotsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: HealthbotsClient.BotsCreate
ctx := context.TODO()
id := healthbots.NewHealthBotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "healthBotValue")
payload := healthbots.HealthBot{
// ...
}
if err := client.BotsCreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: HealthbotsClient.BotsDelete
ctx := context.TODO()
id := healthbots.NewHealthBotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "healthBotValue")
if err := client.BotsDeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: HealthbotsClient.BotsGet
ctx := context.TODO()
id := healthbots.NewHealthBotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "healthBotValue")
read, err := client.BotsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: HealthbotsClient.BotsList
ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.BotsList(ctx, id)` can be used to do batched pagination
items, err := client.BotsListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: HealthbotsClient.BotsListByResourceGroup
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.BotsListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.BotsListByResourceGroupComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: HealthbotsClient.BotsListSecrets
ctx := context.TODO()
id := healthbots.NewHealthBotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "healthBotValue")
read, err := client.BotsListSecrets(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: HealthbotsClient.BotsRegenerateApiJwtSecret
ctx := context.TODO()
id := healthbots.NewHealthBotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "healthBotValue")
read, err := client.BotsRegenerateApiJwtSecret(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: HealthbotsClient.BotsUpdate
ctx := context.TODO()
id := healthbots.NewHealthBotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "healthBotValue")
payload := healthbots.HealthBotUpdateParameters{
// ...
}
if err := client.BotsUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForSkuName() []string
- func ValidateHealthBotID(input interface{}, key string) (warnings []string, errors []error)
- type BotsCreateOperationResponse
- type BotsDeleteOperationResponse
- type BotsGetOperationResponse
- type BotsListByResourceGroupCompleteResult
- type BotsListByResourceGroupCustomPager
- type BotsListByResourceGroupOperationResponse
- type BotsListCompleteResult
- type BotsListCustomPager
- type BotsListOperationResponse
- type BotsListSecretsOperationResponse
- type BotsRegenerateApiJwtSecretOperationResponse
- type BotsUpdateOperationResponse
- type HealthBot
- type HealthBotId
- type HealthBotKey
- type HealthBotKeysResponse
- type HealthBotOperationPredicate
- type HealthBotProperties
- type HealthBotUpdateParameters
- type HealthbotsClient
- func (c HealthbotsClient) BotsCreate(ctx context.Context, id HealthBotId, input HealthBot) (result BotsCreateOperationResponse, err error)
- func (c HealthbotsClient) BotsCreateThenPoll(ctx context.Context, id HealthBotId, input HealthBot) error
- func (c HealthbotsClient) BotsDelete(ctx context.Context, id HealthBotId) (result BotsDeleteOperationResponse, err error)
- func (c HealthbotsClient) BotsDeleteThenPoll(ctx context.Context, id HealthBotId) error
- func (c HealthbotsClient) BotsGet(ctx context.Context, id HealthBotId) (result BotsGetOperationResponse, err error)
- func (c HealthbotsClient) BotsList(ctx context.Context, id commonids.SubscriptionId) (result BotsListOperationResponse, err error)
- func (c HealthbotsClient) BotsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result BotsListByResourceGroupOperationResponse, err error)
- func (c HealthbotsClient) BotsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (BotsListByResourceGroupCompleteResult, error)
- func (c HealthbotsClient) BotsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result BotsListByResourceGroupCompleteResult, err error)
- func (c HealthbotsClient) BotsListComplete(ctx context.Context, id commonids.SubscriptionId) (BotsListCompleteResult, error)
- func (c HealthbotsClient) BotsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result BotsListCompleteResult, err error)
- func (c HealthbotsClient) BotsListSecrets(ctx context.Context, id HealthBotId) (result BotsListSecretsOperationResponse, err error)
- func (c HealthbotsClient) BotsRegenerateApiJwtSecret(ctx context.Context, id HealthBotId) (result BotsRegenerateApiJwtSecretOperationResponse, err error)
- func (c HealthbotsClient) BotsUpdate(ctx context.Context, id HealthBotId, input HealthBotUpdateParameters) (result BotsUpdateOperationResponse, err error)
- func (c HealthbotsClient) BotsUpdateThenPoll(ctx context.Context, id HealthBotId, input HealthBotUpdateParameters) error
- type KeyVaultProperties
- type Sku
- type SkuName
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForSkuName ¶
func PossibleValuesForSkuName() []string
func ValidateHealthBotID ¶
ValidateHealthBotID checks that 'input' can be parsed as a Health Bot ID
Types ¶
type BotsListByResourceGroupCustomPager ¶ added in v0.20240628.1153531
func (*BotsListByResourceGroupCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *BotsListByResourceGroupCustomPager) NextPageLink() *odata.Link
type BotsListCompleteResult ¶
type BotsListCustomPager ¶ added in v0.20240628.1153531
func (*BotsListCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *BotsListCustomPager) NextPageLink() *odata.Link
type BotsListSecretsOperationResponse ¶
type BotsListSecretsOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *HealthBotKeysResponse }
type BotsRegenerateApiJwtSecretOperationResponse ¶
type BotsRegenerateApiJwtSecretOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *HealthBotKey }
type HealthBot ¶
type HealthBot struct { Id *string `json:"id,omitempty"` Identity *identity.SystemAndUserAssignedMap `json:"identity,omitempty"` Location string `json:"location"` Name *string `json:"name,omitempty"` Properties *HealthBotProperties `json:"properties,omitempty"` Sku Sku `json:"sku"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type HealthBotId ¶
HealthBotId is a struct representing the Resource ID for a Health Bot
func NewHealthBotID ¶
func NewHealthBotID(subscriptionId string, resourceGroupName string, healthBotName string) HealthBotId
NewHealthBotID returns a new HealthBotId struct
func ParseHealthBotID ¶
func ParseHealthBotID(input string) (*HealthBotId, error)
ParseHealthBotID parses 'input' into a HealthBotId
func ParseHealthBotIDInsensitively ¶
func ParseHealthBotIDInsensitively(input string) (*HealthBotId, error)
ParseHealthBotIDInsensitively parses 'input' case-insensitively into a HealthBotId note: this method should only be used for API response data and not user input
func (*HealthBotId) FromParseResult ¶
func (id *HealthBotId) FromParseResult(input resourceids.ParseResult) error
func (HealthBotId) Segments ¶
func (id HealthBotId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Health Bot ID
func (HealthBotId) String ¶
func (id HealthBotId) String() string
String returns a human-readable description of this Health Bot ID
type HealthBotKey ¶
type HealthBotKeysResponse ¶
type HealthBotKeysResponse struct {
Secrets *[]HealthBotKey `json:"secrets,omitempty"`
}
type HealthBotOperationPredicate ¶
func (HealthBotOperationPredicate) Matches ¶
func (p HealthBotOperationPredicate) Matches(input HealthBot) bool
type HealthBotProperties ¶
type HealthBotProperties struct { BotManagementPortalLink *string `json:"botManagementPortalLink,omitempty"` KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` }
type HealthBotUpdateParameters ¶
type HealthBotUpdateParameters struct { Identity *identity.SystemAndUserAssignedMap `json:"identity,omitempty"` Location *string `json:"location,omitempty"` Properties *HealthBotProperties `json:"properties,omitempty"` Sku *Sku `json:"sku,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type HealthbotsClient ¶
type HealthbotsClient struct {
Client *resourcemanager.Client
}
func NewHealthbotsClientWithBaseURI ¶
func NewHealthbotsClientWithBaseURI(sdkApi sdkEnv.Api) (*HealthbotsClient, error)
func (HealthbotsClient) BotsCreate ¶
func (c HealthbotsClient) BotsCreate(ctx context.Context, id HealthBotId, input HealthBot) (result BotsCreateOperationResponse, err error)
BotsCreate ...
func (HealthbotsClient) BotsCreateThenPoll ¶
func (c HealthbotsClient) BotsCreateThenPoll(ctx context.Context, id HealthBotId, input HealthBot) error
BotsCreateThenPoll performs BotsCreate then polls until it's completed
func (HealthbotsClient) BotsDelete ¶
func (c HealthbotsClient) BotsDelete(ctx context.Context, id HealthBotId) (result BotsDeleteOperationResponse, err error)
BotsDelete ...
func (HealthbotsClient) BotsDeleteThenPoll ¶
func (c HealthbotsClient) BotsDeleteThenPoll(ctx context.Context, id HealthBotId) error
BotsDeleteThenPoll performs BotsDelete then polls until it's completed
func (HealthbotsClient) BotsGet ¶
func (c HealthbotsClient) BotsGet(ctx context.Context, id HealthBotId) (result BotsGetOperationResponse, err error)
BotsGet ...
func (HealthbotsClient) BotsList ¶
func (c HealthbotsClient) BotsList(ctx context.Context, id commonids.SubscriptionId) (result BotsListOperationResponse, err error)
BotsList ...
func (HealthbotsClient) BotsListByResourceGroup ¶
func (c HealthbotsClient) BotsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result BotsListByResourceGroupOperationResponse, err error)
BotsListByResourceGroup ...
func (HealthbotsClient) BotsListByResourceGroupComplete ¶
func (c HealthbotsClient) BotsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (BotsListByResourceGroupCompleteResult, error)
BotsListByResourceGroupComplete retrieves all the results into a single object
func (HealthbotsClient) BotsListByResourceGroupCompleteMatchingPredicate ¶
func (c HealthbotsClient) BotsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate HealthBotOperationPredicate) (result BotsListByResourceGroupCompleteResult, err error)
BotsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (HealthbotsClient) BotsListComplete ¶
func (c HealthbotsClient) BotsListComplete(ctx context.Context, id commonids.SubscriptionId) (BotsListCompleteResult, error)
BotsListComplete retrieves all the results into a single object
func (HealthbotsClient) BotsListCompleteMatchingPredicate ¶
func (c HealthbotsClient) BotsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate HealthBotOperationPredicate) (result BotsListCompleteResult, err error)
BotsListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (HealthbotsClient) BotsListSecrets ¶
func (c HealthbotsClient) BotsListSecrets(ctx context.Context, id HealthBotId) (result BotsListSecretsOperationResponse, err error)
BotsListSecrets ...
func (HealthbotsClient) BotsRegenerateApiJwtSecret ¶
func (c HealthbotsClient) BotsRegenerateApiJwtSecret(ctx context.Context, id HealthBotId) (result BotsRegenerateApiJwtSecretOperationResponse, err error)
BotsRegenerateApiJwtSecret ...
func (HealthbotsClient) BotsUpdate ¶
func (c HealthbotsClient) BotsUpdate(ctx context.Context, id HealthBotId, input HealthBotUpdateParameters) (result BotsUpdateOperationResponse, err error)
BotsUpdate ...
func (HealthbotsClient) BotsUpdateThenPoll ¶
func (c HealthbotsClient) BotsUpdateThenPoll(ctx context.Context, id HealthBotId, input HealthBotUpdateParameters) error
BotsUpdateThenPoll performs BotsUpdate then polls until it's completed
type KeyVaultProperties ¶
Source Files ¶
- client.go
- constants.go
- id_healthbot.go
- method_botscreate.go
- method_botsdelete.go
- method_botsget.go
- method_botslist.go
- method_botslistbyresourcegroup.go
- method_botslistsecrets.go
- method_botsregenerateapijwtsecret.go
- method_botsupdate.go
- model_healthbot.go
- model_healthbotkey.go
- model_healthbotkeysresponse.go
- model_healthbotproperties.go
- model_healthbotupdateparameters.go
- model_keyvaultproperties.go
- model_sku.go
- predicates.go
- version.go