package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# 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
}

# Functions

No description provided by the author
NewConnectionID returns a new ConnectionId struct.
ParseConnectionID parses 'input' into a ConnectionId.
ParseConnectionIDInsensitively parses 'input' case-insensitively into a ConnectionId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
ValidateConnectionID checks that 'input' can be parsed as a Connection ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
ConnectionId is a struct representing the Resource ID for a Connection.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author