5.0.0 • Published 5 years ago

@datafire/azure_billing v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/azure_billing

Client library for BillingManagementClient

Installation and Usage

npm install --save @datafire/azure_billing
let azure_billing = require('@datafire/azure_billing').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Billing client provides access to billing resources for Azure subscriptions.

Actions

BillingAccounts_List

Lists all billing accounts for a user which he has access to.

azure_billing.BillingAccounts_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • $expand string: May be used to expand the address, invoiceSections and billingProfiles.

Output

BillingAccounts_Get

Get the billing account by id.

azure_billing.BillingAccounts_Get({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • $expand string: May be used to expand the address, invoiceSections and billingProfiles.

Output

BillingAccounts_Update

The operation to update a billing account.

azure_billing.BillingAccounts_Update({
  "api-version": "",
  "billingAccountName": "",
  "parameters": null
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • parameters required BillingAccountUpdateRequest

Output

Agreements_ListByBillingAccount

Lists all agreements for a billing account.

azure_billing.Agreements_ListByBillingAccount({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • $expand string: May be used to expand the participants.

Output

Agreements_Get

Get the agreement by name.

azure_billing.Agreements_Get({
  "api-version": "",
  "billingAccountName": "",
  "agreementName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • agreementName required string: Agreement Id.
    • $expand string: May be used to expand the participants.

Output

BillingPermissions_ListByBillingAccount

Lists all billing permissions for the caller under a billing account.

azure_billing.BillingPermissions_ListByBillingAccount({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.

Output

BillingProfiles_ListByBillingAccount

Lists all billing profiles for a user which that user has access to.

azure_billing.BillingProfiles_ListByBillingAccount({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • $expand string: May be used to expand the invoiceSections.

Output

BillingProfiles_Get

Get the billing profile by id.

azure_billing.BillingProfiles_Get({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • $expand string: May be used to expand the invoiceSections.

Output

BillingProfiles_Update

The operation to update a billing profile.

azure_billing.BillingProfiles_Update({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "parameters": {}
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • parameters required BillingProfile

Output

BillingProfiles_Create

The operation to create a BillingProfile.

azure_billing.BillingProfiles_Create({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "parameters": null
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • parameters required BillingProfileCreationRequest

Output

AvailableBalances_GetByBillingProfile

The latest available credit balance for a given billingAccountName and billingProfileName.

azure_billing.AvailableBalances_GetByBillingProfile({
  "billingAccountName": "",
  "billingProfileName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

BillingPermissions_ListByBillingProfile

Lists all billing permissions the caller has for a billing account.

azure_billing.BillingPermissions_ListByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.

Output

BillingRoleAssignments_ListByBillingProfile

Get the role assignments on the Billing Profile

azure_billing.BillingRoleAssignments_ListByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.

Output

BillingRoleAssignments_DeleteByBillingProfile

Delete the role assignment on this Billing Profile

azure_billing.BillingRoleAssignments_DeleteByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "billingRoleAssignmentName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • billingRoleAssignmentName required string: role assignment id.

Output

BillingRoleAssignments_GetByBillingProfile

Get the role assignment for the caller on the Billing Profile

azure_billing.BillingRoleAssignments_GetByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "billingRoleAssignmentName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • billingRoleAssignmentName required string: role assignment id.

Output

BillingRoleDefinitions_ListByBillingProfile

Lists the role definition for a Billing Profile

azure_billing.BillingRoleDefinitions_ListByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.

Output

BillingRoleDefinitions_GetByBillingProfile

Gets the role definition for a role

azure_billing.BillingRoleDefinitions_GetByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "billingRoleDefinitionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • billingRoleDefinitionName required string: role definition id.

Output

BillingSubscriptions_ListByBillingProfile

Lists billing subscriptions by billing profile name.

azure_billing.BillingSubscriptions_ListByBillingProfile({
  "billingAccountName": "",
  "billingProfileName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

BillingRoleAssignments_AddByBillingProfile

The operation to add a role assignment to a billing profile.

azure_billing.BillingRoleAssignments_AddByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "parameters": null
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • parameters required BillingRoleAssignmentPayload

Output

Customers_ListByBillingProfile

Lists customers by billing profile which the current user can work with on-behalf of a partner.

azure_billing.Customers_ListByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • $filter string: May be used to filter the list of customers.
    • $skiptoken string: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

Output

PartnerTransfers_Initiate

Initiates the request to transfer the legacy subscriptions or RIs.

azure_billing.PartnerTransfers_Initiate({
  "billingAccountName": "",
  "billingProfileName": "",
  "customerName": "",
  "parameters": {}
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • customerName required string: Customer name.
    • parameters required InitiateTransferRequest

Output

PartnerTransfers_List

Lists all transfer's details initiated from given invoice section.

azure_billing.PartnerTransfers_List({
  "billingAccountName": "",
  "billingProfileName": "",
  "customerName": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • customerName required string: Customer name.

Output

PartnerTransfers_Cancel

Cancels the transfer for given transfer Id.

azure_billing.PartnerTransfers_Cancel({
  "billingAccountName": "",
  "billingProfileName": "",
  "customerName": "",
  "transferName": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • customerName required string: Customer name.
    • transferName required string: Transfer Name.

Output

PartnerTransfers_Get

Gets the transfer details for given transfer Id.

azure_billing.PartnerTransfers_Get({
  "billingAccountName": "",
  "billingProfileName": "",
  "customerName": "",
  "transferName": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • customerName required string: Customer name.
    • transferName required string: Transfer Name.

Output

Instructions_ListByBillingProfile

Lists the instructions by billing profile id.

azure_billing.Instructions_ListByBillingProfile({
  "billingAccountName": "",
  "billingProfileName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Instructions_Get

Get the instruction by name.

azure_billing.Instructions_Get({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "instructionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • instructionName required string: Instruction Name.

Output

Instructions_Put

The operation to create or update a instruction.

azure_billing.Instructions_Put({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "instructionName": "",
  "parameters": {}
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • instructionName required string: Instruction Name.
    • parameters required Instruction

Output

InvoiceSections_ListByBillingProfile

Lists all invoice sections for a user which he has access to.

azure_billing.InvoiceSections_ListByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.

Output

InvoiceSections_Get

Get the InvoiceSection by id.

azure_billing.InvoiceSections_Get({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.

Output

InvoiceSections_Update

The operation to update a InvoiceSection.

azure_billing.InvoiceSections_Update({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "parameters": {}
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • parameters required InvoiceSection

Output

InvoiceSections_Create

The operation to create an invoice section.

azure_billing.InvoiceSections_Create({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "parameters": null
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • parameters required InvoiceSectionCreationRequest

Output

BillingPermissions_ListByInvoiceSections

Lists all billing permissions for the caller under invoice section.

azure_billing.BillingPermissions_ListByInvoiceSections({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.

Output

BillingRoleAssignments_ListByInvoiceSection

Get the role assignments on the invoice Section

azure_billing.BillingRoleAssignments_ListByInvoiceSection({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.

Output

BillingRoleAssignments_DeleteByInvoiceSection

Delete the role assignment on the invoice Section

azure_billing.BillingRoleAssignments_DeleteByInvoiceSection({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "billingRoleAssignmentName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • billingRoleAssignmentName required string: role assignment id.

Output

BillingRoleAssignments_GetByInvoiceSection

Get the role assignment for the caller on the invoice Section

azure_billing.BillingRoleAssignments_GetByInvoiceSection({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "billingRoleAssignmentName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • billingRoleAssignmentName required string: role assignment id.

Output

BillingRoleDefinitions_ListByInvoiceSection

Lists the role definition for an invoice Section

azure_billing.BillingRoleDefinitions_ListByInvoiceSection({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.

Output

BillingRoleDefinitions_GetByInvoiceSection

Gets the role definition for a role

azure_billing.BillingRoleDefinitions_GetByInvoiceSection({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "billingRoleDefinitionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • billingRoleDefinitionName required string: role definition id.

Output

BillingSubscriptions_ListByInvoiceSection

Lists billing subscription by invoice section name.

azure_billing.BillingSubscriptions_ListByInvoiceSection({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

BillingSubscriptions_Get

Get a single billing subscription by name.

azure_billing.BillingSubscriptions_Get({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "billingSubscriptionName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • billingSubscriptionName required string: Billing Subscription Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

BillingSubscriptions_Transfer

Transfers the subscription from one invoice section to another within a billing account.

azure_billing.BillingSubscriptions_Transfer({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "billingSubscriptionName": "",
  "parameters": {}
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • billingSubscriptionName required string: Billing Subscription Id.
    • parameters required TransferBillingSubscriptionRequestProperties

Output

BillingSubscriptions_ValidateTransfer

Validates the transfer of billing subscriptions across invoice sections.

azure_billing.BillingSubscriptions_ValidateTransfer({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "billingSubscriptionName": "",
  "parameters": {}
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • billingSubscriptionName required string: Billing Subscription Id.
    • parameters required TransferBillingSubscriptionRequestProperties

Output

BillingRoleAssignments_AddByInvoiceSection

The operation to add a role assignment to a invoice Section.

azure_billing.BillingRoleAssignments_AddByInvoiceSection({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "parameters": null
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • parameters required BillingRoleAssignmentPayload

Output

InvoiceSections_ElevateToBillingProfile

Elevates the caller's access to match their billing profile access.

azure_billing.InvoiceSections_ElevateToBillingProfile({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.

Output

Output schema unknown

Transfers_Initiate

Initiates the request to transfer the legacy subscriptions or RIs.

azure_billing.Transfers_Initiate({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "parameters": {}
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • parameters required InitiateTransferRequest

Output

Products_ListByInvoiceSection

Lists products by invoice section name.

azure_billing.Products_ListByInvoiceSection({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • $filter string: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Products_Get

Get a single product by name.

azure_billing.Products_Get({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "productName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • productName required string: Invoice Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Products_Transfer

The operation to transfer a Product to another invoice section.

azure_billing.Products_Transfer({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "productName": "",
  "api-version": "",
  "parameters": null
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • productName required string: Invoice Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • parameters required TransferProductRequestProperties

Output

Products_UpdateAutoRenewByInvoiceSection

Cancel auto renew for product by product id and invoice section name

azure_billing.Products_UpdateAutoRenewByInvoiceSection({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "productName": "",
  "api-version": "",
  "body": {}
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • productName required string: Invoice Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • body required UpdateAutoRenewRequest

Output

Products_ValidateTransfer

Validates the transfer of products across invoice sections.

azure_billing.Products_ValidateTransfer({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "productName": "",
  "parameters": null
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • productName required string: Invoice Id.
    • parameters required TransferProductRequestProperties

Output

Transactions_ListByInvoiceSection

Lists the transactions by invoice section name for given start date and end date.

azure_billing.Transactions_ListByInvoiceSection({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "api-version": "",
  "periodStartDate": "",
  "periodEndDate": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • periodStartDate required string: Start date
    • periodEndDate required string: End date
    • $filter string: May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Transfers_List

Lists all transfer's details initiated from given invoice section.

azure_billing.Transfers_List({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.

Output

Transfers_Cancel

Cancels the transfer for given transfer Id.

azure_billing.Transfers_Cancel({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "transferName": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • transferName required string: Transfer Name.

Output

Transfers_Get

Gets the transfer details for given transfer Id.

azure_billing.Transfers_Get({
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceSectionName": "",
  "transferName": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceSectionName required string: InvoiceSection Id.
    • transferName required string: Transfer Name.

Output

Invoices_ListByBillingProfile

List of invoices for a billing profile.

azure_billing.Invoices_ListByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "periodStartDate": "",
  "periodEndDate": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • periodStartDate required string: Invoice period start date.
    • periodEndDate required string: Invoice period end date.

Output

Invoices_Get

Get the invoice by name.

azure_billing.Invoices_Get({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceName required string: Invoice Id.

Output

PriceSheet_Download

Download price sheet for an invoice.

azure_billing.PriceSheet_Download({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "invoiceName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • invoiceName required string: Invoice Id.

Output

PaymentMethods_ListByBillingProfile

Lists the Payment Methods by billing profile Id.

azure_billing.PaymentMethods_ListByBillingProfile({
  "billingAccountName": "",
  "billingProfileName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Policies_GetByBillingProfile

The policy for a given billing account name and billing profile name.

azure_billing.Policies_GetByBillingProfile({
  "billingAccountName": "",
  "billingProfileName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Policies_Update

The operation to update a policy.

azure_billing.Policies_Update({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": "",
  "parameters": {}
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • parameters required Policy

Output

PriceSheet_DownloadByBillingProfile

Download price sheet for a billing profile.

azure_billing.PriceSheet_DownloadByBillingProfile({
  "api-version": "",
  "billingAccountName": "",
  "billingProfileName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.

Output

Transactions_ListByBillingProfile

Lists the transactions by billing profile name for given start date and end date.

azure_billing.Transactions_ListByBillingProfile({
  "billingAccountName": "",
  "billingProfileName": "",
  "api-version": "",
  "periodStartDate": "",
  "periodEndDate": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • periodStartDate required string: Start date
    • periodEndDate required string: End date
    • $filter string: May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Transactions_Get

Get the transaction.

azure_billing.Transactions_Get({
  "billingAccountName": "",
  "billingProfileName": "",
  "transactionName": "",
  "periodStartDate": "",
  "periodEndDate": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingProfileName required string: Billing Profile Id.
    • transactionName required string: Transaction name.
    • periodStartDate required string: Start date
    • periodEndDate required string: End date
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

BillingRoleAssignments_ListByBillingAccount

Get the role assignments on the Billing Account

azure_billing.BillingRoleAssignments_ListByBillingAccount({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.

Output

BillingRoleAssignments_DeleteByBillingAccount

Delete the role assignment on this billing account

azure_billing.BillingRoleAssignments_DeleteByBillingAccount({
  "api-version": "",
  "billingAccountName": "",
  "billingRoleAssignmentName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingRoleAssignmentName required string: role assignment id.

Output

BillingRoleAssignments_GetByBillingAccount

Get the role assignment for the caller

azure_billing.BillingRoleAssignments_GetByBillingAccount({
  "api-version": "",
  "billingAccountName": "",
  "billingRoleAssignmentName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingRoleAssignmentName required string: role assignment id.

Output

BillingRoleDefinitions_ListByBillingAccount

Lists the role definition for a billing account

azure_billing.BillingRoleDefinitions_ListByBillingAccount({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.

Output

BillingRoleDefinitions_GetByBillingAccount

Gets the role definition for a role

azure_billing.BillingRoleDefinitions_GetByBillingAccount({
  "api-version": "",
  "billingAccountName": "",
  "billingRoleDefinitionName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • billingRoleDefinitionName required string: role definition id.

Output

BillingSubscriptions_ListByBillingAccount

Lists billing subscriptions by billing account name.

azure_billing.BillingSubscriptions_ListByBillingAccount({
  "billingAccountName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Invoices_ListByBillingSubscription

Lists invoices by billing subscriptions name.

azure_billing.Invoices_ListByBillingSubscription({
  "billingAccountName": "",
  "billingSubscriptionName": "",
  "periodStartDate": "",
  "periodEndDate": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingSubscriptionName required string: Billing Subscription Id.
    • periodStartDate required string: Invoice period start date.
    • periodEndDate required string: Invoice period end date.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Invoices_GetById

Gets the invoice by name.

azure_billing.Invoices_GetById({
  "billingAccountName": "",
  "billingSubscriptionName": "",
  "invoiceName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • billingSubscriptionName required string: Billing Subscription Id.
    • invoiceName required string: Invoice Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

BillingRoleAssignments_AddByBillingAccount

The operation to add a role assignment to a billing account.

azure_billing.BillingRoleAssignments_AddByBillingAccount({
  "api-version": "",
  "billingAccountName": "",
  "parameters": null
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • parameters required BillingRoleAssignmentPayload

Output

Customers_ListByBillingAccount

Lists customers which the current user can work with on-behalf of a partner.

azure_billing.Customers_ListByBillingAccount({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • $filter string: May be used to filter the list of customers.
    • $skiptoken string: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

Output

Customers_Get

Gets a customer by its id.

azure_billing.Customers_Get({
  "api-version": "",
  "billingAccountName": "",
  "customerName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • $expand string: May be used to expand enabledAzurePlans, resellers.

Output

BillingPermissions_ListByCustomer

Lists all billing permissions the caller has for a customer.

azure_billing.BillingPermissions_ListByCustomer({
  "api-version": "",
  "billingAccountName": "",
  "customerName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.

Output

BillingSubscriptions_ListByCustomer

Lists billing subscription by customer id.

azure_billing.BillingSubscriptions_ListByCustomer({
  "billingAccountName": "",
  "customerName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

BillingSubscriptions_GetByCustomer

Get a single billing subscription by id.

azure_billing.BillingSubscriptions_GetByCustomer({
  "billingAccountName": "",
  "customerName": "",
  "billingSubscriptionName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • billingSubscriptionName required string: Billing Subscription Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Policies_GetByCustomer

The policy for a given billing account name and customer name.

azure_billing.Policies_GetByCustomer({
  "billingAccountName": "",
  "customerName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Policies_UpdateCustomer

The operation to update a Customer policy.

azure_billing.Policies_UpdateCustomer({
  "api-version": "",
  "billingAccountName": "",
  "customerName": "",
  "parameters": {}
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • parameters required CustomerPolicy

Output

Products_ListByCustomer

Lists products by customer id.

azure_billing.Products_ListByCustomer({
  "billingAccountName": "",
  "customerName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • $filter string: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Products_GetByCustomer

Get a customer's product by name.

azure_billing.Products_GetByCustomer({
  "billingAccountName": "",
  "customerName": "",
  "productName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • productName required string: Invoice Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Transactions_ListByCustomer

Lists the transactions by customer id for given start date and end date.

azure_billing.Transactions_ListByCustomer({
  "billingAccountName": "",
  "customerName": "",
  "api-version": "",
  "periodStartDate": "",
  "periodEndDate": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • customerName required string: Customer name.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • periodStartDate required string: Start date
    • periodEndDate required string: End date
    • $filter string: May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Departments_ListByBillingAccountName

Lists all departments for a user which he has access to.

azure_billing.Departments_ListByBillingAccountName({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • $expand string: May be used to expand the enrollmentAccounts.
    • $filter string: The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Departments_Get

Get the department by id.

azure_billing.Departments_Get({
  "api-version": "",
  "billingAccountName": "",
  "departmentName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • departmentName required string: Department Id.
    • $expand string: May be used to expand the enrollmentAccounts.
    • $filter string: The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

EnrollmentAccounts_ListByBillingAccountName

Lists all Enrollment Accounts for a user which he has access to.

azure_billing.EnrollmentAccounts_ListByBillingAccountName({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • $expand string: May be used to expand the department.
    • $filter string: The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

EnrollmentAccounts_GetByEnrollmentAccountId

Get the enrollment account by id.

azure_billing.EnrollmentAccounts_GetByEnrollmentAccountId({
  "api-version": "",
  "billingAccountName": "",
  "enrollmentAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • enrollmentAccountName required string: Enrollment Account Id.
    • $expand string: May be used to expand the Department.
    • $filter string: The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Invoices_ListByBillingAccount

List of invoices for a billing account.

azure_billing.Invoices_ListByBillingAccount({
  "api-version": "",
  "billingAccountName": "",
  "periodStartDate": "",
  "periodEndDate": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.
    • periodStartDate required string: Invoice period start date.
    • periodEndDate required string: Invoice period end date.

Output

BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission

Lists all invoice sections with create subscription permission for a user.

azure_billing.BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission({
  "api-version": "",
  "billingAccountName": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • billingAccountName required string: billing Account Id.

Output

PaymentMethods_ListByBillingAccount

Lists the Payment Methods by billing account Id.

azure_billing.PaymentMethods_ListByBillingAccount({
  "billingAccountName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

Products_ListByBillingAccount

Lists products by billing account name.

azure_billing.Products_ListByBillingAccount({
  "billingAccountName": "",
  "api-version": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • $filter string: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Transactions_ListByBillingAccount

Lists the transactions by billing account name for given start and end date.

azure_billing.Transactions_ListByBillingAccount({
  "billingAccountName": "",
  "api-version": "",
  "periodStartDate": "",
  "periodEndDate": ""
}, context)

Input

  • input object
    • billingAccountName required string: billing Account Id.
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.
    • periodStartDate required string: Start date
    • periodEndDate required string: End date
    • $filter string: May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

Output

Operations_List

Lists all of the available billing REST API operations.

azure_billing.Operations_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client request. The current version is 2019-10-01-preview.

Output

RecipientTransfers_List

Lists the transfers received by caller.

azure_billing.RecipientTransfers_List(null, context)

Input

This action has no parameters

Output

RecipientTransfers_Get

Gets the transfer with given transfer Id.

azure_billing.RecipientTransfers_Get({
  "transferName": ""
}, context)

Input

  • input object
    • transferName required string: Transfer Name.

Output

RecipientTransfers_Accept

Accepts the transfer with given transfer Id.

azure_billing.RecipientTransfers_Accept({
  "transferName": "",
  "parameters": {}
}, context)

Input

Output

RecipientTransfers_Decline

Declines the transfer with given transfer Id.

azure_billing.RecipientTransfers_Decline({
  "transferName": ""
}, context)

Input

  • input object
    • transferName required string: Transfer Name.

Output

RecipientTransfers_Validate

Validates if the products can be transferred in the context of the given transfer name.

azure_billing.RecipientTransfers_Validate({
  "transferName": "",
  "parameters": {}
}, context)

Input

Output

Address_Validate

Validates the address.

azure_billing.Address_Validate({
  "api-version": "",
  "address": null
}, context)

Input

  • input object
    • api-version required string: Version of the API to be used with the client r
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago