BillingAccountResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- Implements
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.
|
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.
|
AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
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.
|
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.
|
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.
|
CheckAccessBillingPermissionsAsync(BillingCheckAccessContent, CancellationToken) |
Provides a list of check access response objects for a billing account.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
Get(CancellationToken) |
Gets a billing account by its ID.
|
GetAsync(CancellationToken) |
Gets a billing account by its ID.
|
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.
|
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.
|
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.
|
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.
|
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.
|
GetBillingAgreementAsync(String, CancellationToken) |
Gets an agreement by ID.
|
GetBillingAgreements() |
Gets a collection of BillingAgreementResources in the BillingAccount. |
GetBillingAssociatedTenant(String, CancellationToken) |
Gets an associated tenant by ID.
|
GetBillingAssociatedTenantAsync(String, CancellationToken) |
Gets an associated tenant by ID.
|
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.
|
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.
|
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.
|
GetBillingDepartmentAsync(String, CancellationToken) |
Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
|
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.
|
GetBillingEnrollmentAccountAsync(String, CancellationToken) |
Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
|
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.
|
GetBillingInvoiceAsync(String, CancellationToken) |
Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
|
GetBillingInvoices() |
Gets a collection of BillingInvoiceResources in the BillingAccount. |
GetBillingPermissions(CancellationToken) |
Lists the billing permissions the caller has on a billing account.
|
GetBillingPermissionsAsync(CancellationToken) |
Lists the billing permissions the caller has on a billing account.
|
GetBillingProduct(String, CancellationToken) |
Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
|
GetBillingProductAsync(String, CancellationToken) |
Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
|
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.
|
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.
|
GetBillingProfiles() |
Gets a collection of BillingProfileResources in the BillingAccount. |
GetBillingRequests(BillingAccountResourceGetBillingRequestsOptions, CancellationToken) |
The list of billing requests submitted for the billing account.
|
GetBillingRequestsAsync(BillingAccountResourceGetBillingRequestsOptions, CancellationToken) |
The list of billing requests submitted for the billing account.
|
GetBillingReservationOrder(String, String, CancellationToken) |
Get the details of the ReservationOrder in the billing account.
|
GetBillingReservationOrderAsync(String, String, CancellationToken) |
Get the details of the ReservationOrder in the billing account.
|
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.
|
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.
|
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.
|
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.
|
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.
|
GetBillingSubscriptionAlias(String, CancellationToken) |
Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.
|
GetBillingSubscriptionAliasAsync(String, CancellationToken) |
Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.
|
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.
|
GetBillingSubscriptions() |
Gets a collection of BillingSubscriptionResources in the BillingAccount. |
GetByBillingAccountSavingsPlan(BillingAccountResourceGetByBillingAccountSavingsPlanOptions, CancellationToken) |
List savings plans by billing account.
|
GetByBillingAccountSavingsPlanAsync(BillingAccountResourceGetByBillingAccountSavingsPlanOptions, CancellationToken) |
List savings plans by billing account.
|
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.
|
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.
|
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
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.
|
GetReservationsAsync(BillingAccountResourceGetReservationsOptions, CancellationToken) |
Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.
|
GetSavingsPlanOrderModel(String, String, CancellationToken) |
Get a savings plan order by billing account.
|
GetSavingsPlanOrderModelAsync(String, String, CancellationToken) |
Get a savings plan order by billing account.
|
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.
|
RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
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.
|
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.
|
SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
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.
|
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.
|
ValidatePaymentTerms(IEnumerable<BillingPaymentTerm>, CancellationToken) |
Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
|
ValidatePaymentTermsAsync(IEnumerable<BillingPaymentTerm>, CancellationToken) |
Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
|
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).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |