Categorygithub.com/hashicorp/go-azure-sdk/resource-managercognitive2023-10-01-previewcommitmentplans
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/cognitive/2023-10-01-preview/commitmentplans
Documentation
The commitmentplans
SDK allows for interaction with the Azure Resource Manager Service cognitive
(API Version 2023-10-01-preview
).
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-sdk/resource-manager/cognitive/2023-10-01-preview/commitmentplans"
Client Initialization
client := commitmentplans.NewCommitmentPlansClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: CommitmentPlansClient.CreateOrUpdate
ctx := context.TODO()
id := commitmentplans.NewAccountCommitmentPlanID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "commitmentPlanValue")
payload := commitmentplans.CommitmentPlan{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CommitmentPlansClient.CreateOrUpdateAssociation
ctx := context.TODO()
id := commitmentplans.NewAccountAssociationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "commitmentPlanValue", "accountAssociationValue")
payload := commitmentplans.CommitmentPlanAccountAssociation{
// ...
}
if err := client.CreateOrUpdateAssociationThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: CommitmentPlansClient.Delete
ctx := context.TODO()
id := commitmentplans.NewAccountCommitmentPlanID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "commitmentPlanValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: CommitmentPlansClient.DeleteAssociation
ctx := context.TODO()
id := commitmentplans.NewAccountAssociationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "commitmentPlanValue", "accountAssociationValue")
if err := client.DeleteAssociationThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: CommitmentPlansClient.Get
ctx := context.TODO()
id := commitmentplans.NewAccountCommitmentPlanID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "commitmentPlanValue")
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: CommitmentPlansClient.GetAssociation
ctx := context.TODO()
id := commitmentplans.NewAccountAssociationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "commitmentPlanValue", "accountAssociationValue")
read, err := client.GetAssociation(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CommitmentPlansClient.List
ctx := context.TODO()
id := commitmentplans.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")
// 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: CommitmentPlansClient.ListAssociations
ctx := context.TODO()
id := commitmentplans.NewCommitmentPlanID("12345678-1234-9876-4563-123456789012", "example-resource-group", "commitmentPlanValue")
// alternatively `client.ListAssociations(ctx, id)` can be used to do batched pagination
items, err := client.ListAssociationsComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
NewAccountAssociationID returns a new AccountAssociationId struct.
NewAccountCommitmentPlanID returns a new AccountCommitmentPlanId struct.
NewAccountID returns a new AccountId struct.
NewCommitmentPlanID returns a new CommitmentPlanId struct.
No description provided by the author
ParseAccountAssociationID parses 'input' into a AccountAssociationId.
ParseAccountAssociationIDInsensitively parses 'input' case-insensitively into a AccountAssociationId note: this method should only be used for API response data and not user input.
ParseAccountCommitmentPlanID parses 'input' into a AccountCommitmentPlanId.
ParseAccountCommitmentPlanIDInsensitively parses 'input' case-insensitively into a AccountCommitmentPlanId note: this method should only be used for API response data and not user input.
ParseAccountID parses 'input' into a AccountId.
ParseAccountIDInsensitively parses 'input' case-insensitively into a AccountId note: this method should only be used for API response data and not user input.
ParseCommitmentPlanID parses 'input' into a CommitmentPlanId.
ParseCommitmentPlanIDInsensitively parses 'input' case-insensitively into a CommitmentPlanId 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
ValidateAccountAssociationID checks that 'input' can be parsed as a Account Association ID.
ValidateAccountCommitmentPlanID checks that 'input' can be parsed as a Account Commitment Plan ID.
ValidateAccountID checks that 'input' can be parsed as a Account ID.
ValidateCommitmentPlanID checks that 'input' can be parsed as a Commitment Plan 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
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
AccountAssociationId is a struct representing the Resource ID for a Account Association.
AccountCommitmentPlanId is a struct representing the Resource ID for a Account Commitment Plan.
AccountId is a struct representing the Resource ID for a Account.
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
CommitmentPlanId is a struct representing the Resource ID for a Commitment Plan.
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
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