共用方式為

BillingAccountResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Billing
Assembly:
Azure.ResourceManager.Billing.dll
Package:
Azure.ResourceManager.Billing v1.2.0
Source:
BillingAccountResource.cs

A Class representing a BillingAccount along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a BillingAccountResource from an instance of ArmClient using the GetBillingAccountResource method. Otherwise you can get one from its parent resource TenantResource using the GetBillingAccount method.

public class BillingAccountResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Billing.BillingAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Billing.BillingAccountData>
type BillingAccountResource = class
    inherit ArmResource
    interface IJsonModel<BillingAccountData>
    interface IPersistableModel<BillingAccountData>
Public Class BillingAccountResource
Inherits ArmResource
Implements IJsonModel(Of BillingAccountData), IPersistableModel(Of BillingAccountData)
Inheritance
Object
ArmResource
BillingAccountResource
Implements
IJsonModel<BillingAccountData> IPersistableModel<BillingAccountData> IPersistableModel<T>

Constructors

BillingAccountResource()

Initializes a new instance of the BillingAccountResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AddPaymentTerms(WaitUntil, IEnumerable<BillingPaymentTerm>, CancellationToken)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms
  • Operation Id: BillingAccounts_AddPaymentTerms
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
AddPaymentTermsAsync(WaitUntil, IEnumerable<BillingPaymentTerm>, CancellationToken)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms
  • Operation Id: BillingAccounts_AddPaymentTerms
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
CancelPaymentTerms(WaitUntil, DateTimeOffset, CancellationToken)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/cancelPaymentTerms
  • Operation Id: BillingAccounts_CancelPaymentTerms
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
CancelPaymentTermsAsync(WaitUntil, DateTimeOffset, CancellationToken)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/cancelPaymentTerms
  • Operation Id: BillingAccounts_CancelPaymentTerms
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CheckAccessBillingPermissions(BillingCheckAccessContent, CancellationToken)

Provides a list of check access response objects for a billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/checkAccess
  • Operation Id: BillingPermissions_CheckAccessByBillingAccount
  • Default Api Version: 2024-04-01
CheckAccessBillingPermissionsAsync(BillingCheckAccessContent, CancellationToken)

Provides a list of check access response objects for a billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/checkAccess
  • Operation Id: BillingPermissions_CheckAccessByBillingAccount
  • Default Api Version: 2024-04-01
ConfirmTransition(CancellationToken)

Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/confirmTransition
  • Operation Id: BillingAccounts_ConfirmTransition
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
ConfirmTransitionAsync(CancellationToken)

Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/confirmTransition
  • Operation Id: BillingAccounts_ConfirmTransition
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
CreateByBillingAccountBillingRoleAssignment(WaitUntil, BillingRoleAssignmentProperties, CancellationToken)

Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment
  • Operation Id: BillingRoleAssignments_CreateByBillingAccount
  • Default Api Version: 2024-04-01
CreateByBillingAccountBillingRoleAssignmentAsync(WaitUntil, BillingRoleAssignmentProperties, CancellationToken)

Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment
  • Operation Id: BillingRoleAssignments_CreateByBillingAccount
  • Default Api Version: 2024-04-01
CreateResourceIdentifier(String)

Generate the resource identifier of a BillingAccountResource instance.
DownloadDocumentsByBillingAccountInvoice(WaitUntil, IEnumerable<BillingDocumentDownloadRequestContent>, CancellationToken)

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments
  • Operation Id: Invoices_DownloadDocumentsByBillingAccount
  • Default Api Version: 2024-04-01
DownloadDocumentsByBillingAccountInvoiceAsync(WaitUntil, IEnumerable<BillingDocumentDownloadRequestContent>, CancellationToken)

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments
  • Operation Id: Invoices_DownloadDocumentsByBillingAccount
  • Default Api Version: 2024-04-01
Get(CancellationToken)

Gets a billing account by its ID.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
GetAsync(CancellationToken)

Gets a billing account by its ID.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetBillingAccountAvailableBalance(CancellationToken)

The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/availableBalance/default
  • Operation Id: AvailableBalances_GetByBillingAccount
  • Default Api Version: 2024-04-01
GetBillingAccountAvailableBalanceAsync(CancellationToken)

The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/availableBalance/default
  • Operation Id: AvailableBalances_GetByBillingAccount
  • Default Api Version: 2024-04-01
GetBillingAccountPaymentMethod(String, CancellationToken)

Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods/{paymentMethodName}
  • Operation Id: PaymentMethods_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountPaymentMethodResource
GetBillingAccountPaymentMethodAsync(String, CancellationToken)

Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods/{paymentMethodName}
  • Operation Id: PaymentMethods_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountPaymentMethodResource
GetBillingAccountPaymentMethods()

Gets a collection of BillingAccountPaymentMethodResources in the BillingAccount.
GetBillingAccountPolicy()

Gets an object representing a BillingAccountPolicyResource along with the instance operations that can be performed on it in the BillingAccount.
GetBillingAgreement(String, CancellationToken)

Gets an agreement by ID.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}
  • Operation Id: Agreements_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAgreementResource
GetBillingAgreementAsync(String, CancellationToken)

Gets an agreement by ID.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}
  • Operation Id: Agreements_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAgreementResource
GetBillingAgreements()

Gets a collection of BillingAgreementResources in the BillingAccount.
GetBillingAssociatedTenant(String, CancellationToken)

Gets an associated tenant by ID.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}
  • Operation Id: AssociatedTenants_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAssociatedTenantResource
GetBillingAssociatedTenantAsync(String, CancellationToken)

Gets an associated tenant by ID.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}
  • Operation Id: AssociatedTenants_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAssociatedTenantResource
GetBillingAssociatedTenants()

Gets a collection of BillingAssociatedTenantResources in the BillingAccount.
GetBillingCustomer(String, CancellationToken)

Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}
  • Operation Id: Customers_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingCustomerResource
GetBillingCustomerAsync(String, CancellationToken)

Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}
  • Operation Id: Customers_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingCustomerResource
GetBillingCustomers()

Gets a collection of BillingCustomerResources in the BillingAccount.
GetBillingDepartment(String, CancellationToken)

Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}
  • Operation Id: Departments_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingDepartmentResource
GetBillingDepartmentAsync(String, CancellationToken)

Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}
  • Operation Id: Departments_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingDepartmentResource
GetBillingDepartments()

Gets a collection of BillingDepartmentResources in the BillingAccount.
GetBillingEnrollmentAccount(String, CancellationToken)

Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
  • Operation Id: EnrollmentAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingEnrollmentAccountResource
GetBillingEnrollmentAccountAsync(String, CancellationToken)

Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
  • Operation Id: EnrollmentAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingEnrollmentAccountResource
GetBillingEnrollmentAccounts()

Gets a collection of BillingEnrollmentAccountResources in the BillingAccount.
GetBillingInvoice(String, CancellationToken)

Gets an invoice by billing account name and ID. The operation is supported for all billing account types.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}
  • Operation Id: Invoices_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingInvoiceResource
GetBillingInvoiceAsync(String, CancellationToken)

Gets an invoice by billing account name and ID. The operation is supported for all billing account types.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}
  • Operation Id: Invoices_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingInvoiceResource
GetBillingInvoices()

Gets a collection of BillingInvoiceResources in the BillingAccount.
GetBillingPermissions(CancellationToken)

Lists the billing permissions the caller has on a billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions
  • Operation Id: BillingPermissions_ListByBillingAccount
  • Default Api Version: 2024-04-01
GetBillingPermissionsAsync(CancellationToken)

Lists the billing permissions the caller has on a billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions
  • Operation Id: BillingPermissions_ListByBillingAccount
  • Default Api Version: 2024-04-01
GetBillingProduct(String, CancellationToken)

Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}
  • Operation Id: Products_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingProductResource
GetBillingProductAsync(String, CancellationToken)

Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}
  • Operation Id: Products_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingProductResource
GetBillingProducts()

Gets a collection of BillingProductResources in the BillingAccount.
GetBillingProfile(String, CancellationToken)

Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
  • Operation Id: BillingProfiles_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingProfileResource
GetBillingProfileAsync(String, CancellationToken)

Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
  • Operation Id: BillingProfiles_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingProfileResource
GetBillingProfiles()

Gets a collection of BillingProfileResources in the BillingAccount.
GetBillingRequests(BillingAccountResourceGetBillingRequestsOptions, CancellationToken)

The list of billing requests submitted for the billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRequests
  • Operation Id: BillingRequests_ListByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingRequestResource
GetBillingRequestsAsync(BillingAccountResourceGetBillingRequestsOptions, CancellationToken)

The list of billing requests submitted for the billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRequests
  • Operation Id: BillingRequests_ListByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingRequestResource
GetBillingReservationOrder(String, String, CancellationToken)

Get the details of the ReservationOrder in the billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}
  • Operation Id: ReservationOrders_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingReservationOrderResource
GetBillingReservationOrderAsync(String, String, CancellationToken)

Get the details of the ReservationOrder in the billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}
  • Operation Id: ReservationOrders_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingReservationOrderResource
GetBillingReservationOrders()

Gets a collection of BillingReservationOrderResources in the BillingAccount.
GetBillingRoleAssignment(String, CancellationToken)

Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
  • Operation Id: BillingRoleAssignments_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingRoleAssignmentResource
GetBillingRoleAssignmentAsync(String, CancellationToken)

Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
  • Operation Id: BillingRoleAssignments_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingRoleAssignmentResource
GetBillingRoleAssignments()

Gets a collection of BillingRoleAssignmentResources in the BillingAccount.
GetBillingRoleDefinition(String, CancellationToken)

Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{roleDefinitionName}
  • Operation Id: BillingRoleDefinition_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingRoleDefinitionResource
GetBillingRoleDefinitionAsync(String, CancellationToken)

Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{roleDefinitionName}
  • Operation Id: BillingRoleDefinition_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingRoleDefinitionResource
GetBillingRoleDefinitions()

Gets a collection of BillingRoleDefinitionResources in the BillingAccount.
GetBillingSubscription(String, String, CancellationToken)

Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}
  • Operation Id: BillingSubscriptions_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingSubscriptionResource
GetBillingSubscriptionAlias(String, CancellationToken)

Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}
  • Operation Id: BillingSubscriptionsAliases_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingSubscriptionAliasResource
GetBillingSubscriptionAliasAsync(String, CancellationToken)

Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}
  • Operation Id: BillingSubscriptionsAliases_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingSubscriptionAliasResource
GetBillingSubscriptionAliases()

Gets a collection of BillingSubscriptionAliasResources in the BillingAccount.
GetBillingSubscriptionAsync(String, String, CancellationToken)

Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}
  • Operation Id: BillingSubscriptions_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingSubscriptionResource
GetBillingSubscriptions()

Gets a collection of BillingSubscriptionResources in the BillingAccount.
GetByBillingAccountSavingsPlan(BillingAccountResourceGetByBillingAccountSavingsPlanOptions, CancellationToken)

List savings plans by billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans
  • Operation Id: SavingsPlans_ListByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingSavingsPlanModelResource
GetByBillingAccountSavingsPlanAsync(BillingAccountResourceGetByBillingAccountSavingsPlanOptions, CancellationToken)

List savings plans by billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans
  • Operation Id: SavingsPlans_ListByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingSavingsPlanModelResource
GetInvoiceSectionsByCreateSubscriptionPermission(String, CancellationToken)

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
  • Operation Id: BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
GetInvoiceSectionsByCreateSubscriptionPermissionAsync(String, CancellationToken)

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
  • Operation Id: BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetReservations(BillingAccountResourceGetReservationsOptions, CancellationToken)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations
  • Operation Id: Reservations_ListByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingReservationResource
GetReservationsAsync(BillingAccountResourceGetReservationsOptions, CancellationToken)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations
  • Operation Id: Reservations_ListByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: BillingReservationResource
GetSavingsPlanOrderModel(String, String, CancellationToken)

Get a savings plan order by billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}
  • Operation Id: SavingsPlanOrders_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: SavingsPlanOrderModelResource
GetSavingsPlanOrderModelAsync(String, String, CancellationToken)

Get a savings plan order by billing account.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}
  • Operation Id: SavingsPlanOrders_GetByBillingAccount
  • Default Api Version: 2024-04-01
  • Resource: SavingsPlanOrderModelResource
GetSavingsPlanOrderModels()

Gets a collection of SavingsPlanOrderModelResources in the BillingAccount.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
ResolveByBillingAccountBillingRoleAssignment(WaitUntil, Nullable<Boolean>, String, CancellationToken)

Lists the role assignments for the caller on a billing account while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/resolveBillingRoleAssignments
  • Operation Id: BillingRoleAssignments_ResolveByBillingAccount
  • Default Api Version: 2024-04-01
ResolveByBillingAccountBillingRoleAssignmentAsync(WaitUntil, Nullable<Boolean>, String, CancellationToken)

Lists the role assignments for the caller on a billing account while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/resolveBillingRoleAssignments
  • Operation Id: BillingRoleAssignments_ResolveByBillingAccount
  • Default Api Version: 2024-04-01
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Get
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, BillingAccountPatch, CancellationToken)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Update
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
UpdateAsync(WaitUntil, BillingAccountPatch, CancellationToken)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
  • Operation Id: BillingAccounts_Update
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
ValidatePaymentTerms(IEnumerable<BillingPaymentTerm>, CancellationToken)

Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/validatePaymentTerms
  • Operation Id: BillingAccounts_ValidatePaymentTerms
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource
ValidatePaymentTermsAsync(IEnumerable<BillingPaymentTerm>, CancellationToken)

Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/validatePaymentTerms
  • Operation Id: BillingAccounts_ValidatePaymentTerms
  • Default Api Version: 2024-04-01
  • Resource: BillingAccountResource

Explicit Interface Implementations

IJsonModel<BillingAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BillingAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BillingAccountData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<BillingAccountData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BillingAccountData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to