healthbots

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: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/healthbot/2024-02-01/healthbots Documentation

The healthbots SDK allows for interaction with Azure Resource Manager healthbot (API Version 2024-02-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/healthbot/2024-02-01/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", "botName")

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", "botName")

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", "botName")

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", "botName")

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", "botName")

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", "botName")

payload := healthbots.HealthBotUpdateParameters{
	// ...
}


if err := client.BotsUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForSkuName 

func PossibleValuesForSkuName() []string

func ValidateHealthBotID 

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

ValidateHealthBotID checks that 'input' can be parsed as a Health Bot ID

Types

type BotsCreateOperationResponse 

type BotsCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HealthBot
}

type BotsDeleteOperationResponse 

type BotsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type BotsGetOperationResponse 

type BotsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HealthBot
}

type BotsListByResourceGroupCompleteResult 

type BotsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []HealthBot
}

type BotsListByResourceGroupCustomPager 

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

type BotsListByResourceGroupOperationResponse 

type BotsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HealthBot
}

type BotsListCompleteResult 

type BotsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []HealthBot
}

type BotsListCustomPager 

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

type BotsListOperationResponse 

type BotsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HealthBot
}

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 BotsUpdateOperationResponse 

type BotsUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HealthBot
}

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 

type HealthBotId struct {
	SubscriptionId    string
	ResourceGroupName string
	HealthBotName     string
}

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) ID 

func (id HealthBotId) ID() string

ID returns the formatted Health Bot ID

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 HealthBotKey struct {
	KeyName *string `json:"keyName,omitempty"`
	Value   *string `json:"value,omitempty"`
}

type HealthBotKeysResponse 

type HealthBotKeysResponse struct {
	Secrets *[]HealthBotKey `json:"secrets,omitempty"`
}

type HealthBotOperationPredicate 

type HealthBotOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

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 

type KeyVaultProperties struct {
	KeyName      string  `json:"keyName"`
	KeyVaultUri  string  `json:"keyVaultUri"`
	KeyVersion   *string `json:"keyVersion,omitempty"`
	UserIdentity *string `json:"userIdentity,omitempty"`
}

type Sku 

type Sku struct {
	Name SkuName `json:"name"`
}

type SkuName 

type SkuName string
const (
	SkuNameCOne  SkuName = "C1"
	SkuNameCZero SkuName = "C0"
	SkuNameFZero SkuName = "F0"
	SkuNamePES   SkuName = "PES"
	SkuNameSOne  SkuName = "S1"
)

func (*SkuName) UnmarshalJSON 

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

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.