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/billing/2020-05-01/agreements Documentation

The agreements SDK allows for interaction with the Azure Resource Manager Service billing (API Version 2020-05-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-sdk/resource-manager/billing/2020-05-01/agreements"

Client Initialization

client := agreements.NewAgreementsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AgreementsClient.Get

ctx := context.TODO()
id := agreements.NewAgreementID("billingAccountValue", "agreementValue")

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

Example Usage: AgreementsClient.ListByBillingAccount

ctx := context.TODO()
id := agreements.NewBillingAccountID("billingAccountValue")

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

# Functions

No description provided by the author
No description provided by the author
NewAgreementID returns a new AgreementId struct.
No description provided by the author
NewBillingAccountID returns a new BillingAccountId struct.
ParseAgreementID parses 'input' into a AgreementId.
ParseAgreementIDInsensitively parses 'input' case-insensitively into a AgreementId note: this method should only be used for API response data and not user input.
ParseBillingAccountID parses 'input' into a BillingAccountId.
ParseBillingAccountIDInsensitively parses 'input' case-insensitively into a BillingAccountId 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
ValidateAgreementID checks that 'input' can be parsed as a Agreement ID.
ValidateBillingAccountID checks that 'input' can be parsed as a Billing Account 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

# Structs

No description provided by the author
AgreementId is a struct representing the Resource ID for a Agreement.
No description provided by the author
No description provided by the author
No description provided by the author
BillingAccountId is a struct representing the Resource ID for a Billing 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
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