{ "swagger": "2.0", "info": { "title": "BillingManagementClient", "version": "2024-04-01", "description": "Documentation for Microsoft.Billing.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "ArmOperations" }, { "name": "Agreement" }, { "name": "BillingRequest" }, { "name": "BillingRoleAssignment" }, { "name": "Invoice" }, { "name": "Transaction" }, { "name": "Reservation" }, { "name": "Reservations" }, { "name": "BillingAccount" }, { "name": "BillingPermission" }, { "name": "Savings plan" }, { "name": "AssociatedTenant" }, { "name": "AvailableBalance" }, { "name": "Product" }, { "name": "BillingProfile" }, { "name": "BillingProperty" }, { "name": "BillingRoleDefinition" }, { "name": "Savings plan order" }, { "name": "BillingSubscription" }, { "name": "Policy" }, { "name": "Customer" }, { "name": "Department" }, { "name": "EnrollmentAccount" }, { "name": "InvoiceSection" }, { "name": "PaymentMethods" }, { "name": "ReservationOrder" }, { "name": "ReservationOrders" }, { "name": "Transfers" }, { "name": "RecipientTransfers" } ], "paths": { "/providers/Microsoft.Billing/billingAccounts": { "get": { "operationId": "BillingAccounts_List", "tags": [ "BillingAccount" ], "description": "Lists the billing accounts that a user has access to.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "includeAll", "in": "query", "description": "When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.", "required": false, "type": "boolean", "default": false }, { "name": "includeAllWithoutBillingProfiles", "in": "query", "description": "When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.", "required": false, "type": "boolean", "default": false }, { "name": "includeDeleted", "in": "query", "description": "When true, results will include any billing accounts in a deleted state.", "required": false, "type": "boolean", "default": false }, { "name": "includePendingAgreement", "in": "query", "description": "Includes billing accounts with agreement pending signature that the user has access to.", "required": false, "type": "boolean", "default": false }, { "name": "includeResellee", "in": "query", "description": "Includes the customer's billing account of Microsoft Partner Agreement that the user has access to.", "required": false, "type": "boolean", "default": false }, { "name": "legalOwnerTID", "in": "query", "description": "Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.", "required": false, "type": "string" }, { "name": "legalOwnerOID", "in": "query", "description": "Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "expand", "in": "query", "description": "Expand is allowed for SoldTo and EnrollmentDetails/PONumber.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingAccountListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountForLegacyAccountDetails": { "$ref": "./examples/billingAccountForLegacyAccountDetails.json" }, "BillingAccountsList": { "$ref": "./examples/billingAccountsList.json" }, "BillingAccountsListWithExpandForPONumber": { "$ref": "./examples/billingAccountsListWithExpandForPONumber.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}": { "get": { "operationId": "BillingAccounts_Get", "tags": [ "BillingAccount" ], "description": "Gets a billing account by its ID.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingAccount" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountWithExpandForPONumber": { "$ref": "./examples/billingAccountWithExpandForPONumber.json" }, "BillingAccountWithRegistrationNumberWithDefaultType": { "$ref": "./examples/billingAccountWithRegistrationNumberWithDefaultType.json" }, "BillingAccountWithRegistrationNumberWithType": { "$ref": "./examples/billingAccountWithRegistrationNumberWithType.json" }, "BillingAccountsGet": { "$ref": "./examples/billingAccountsGet.json" }, "BillingAccountsGetEA": { "$ref": "./examples/billingAccountsGetEA.json" }, "BillingAccountsGetWithExpand": { "$ref": "./examples/billingAccountsGetWithExpand.json" } } }, "patch": { "operationId": "BillingAccounts_Update", "tags": [ "BillingAccount" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "A billing account.", "required": true, "schema": { "$ref": "#/definitions/BillingAccountPatch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingAccount" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountUpdateWithPONumber": { "$ref": "./examples/billingAccountUpdateWithPONumber.json" }, "BillingAccountsUpdate": { "$ref": "./examples/billingAccountsUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingAccount" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms": { "post": { "operationId": "BillingAccounts_AddPaymentTerms", "tags": [ "BillingAccount" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "The properties of payment term.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentTerm" } } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingAccount" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PaymentTermsAdd": { "$ref": "./examples/paymentTermsAdd.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingAccount" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": { "get": { "operationId": "Agreements_ListByBillingAccount", "tags": [ "Agreement" ], "description": "Lists the agreements for a billing account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "expand", "in": "query", "description": "May be used to expand the participants.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AgreementListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AgreementsListByBillingAccount": { "$ref": "./examples/agreementsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}": { "get": { "operationId": "Agreements_Get", "tags": [ "Agreement" ], "description": "Gets an agreement by ID.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "agreementName", "in": "path", "description": "The ID that uniquely identifies an agreement.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{1,12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Agreement" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AgreementByName": { "$ref": "./examples/agreementByName.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants": { "get": { "operationId": "AssociatedTenants_ListByBillingAccount", "tags": [ "AssociatedTenant" ], "description": "Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "includeRevoked", "in": "query", "description": "Can be used to get revoked associated tenants.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AssociatedTenantListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AssociatedTenantsListByBillingAccount": { "$ref": "./examples/associatedTenantsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}": { "get": { "operationId": "AssociatedTenants_Get", "tags": [ "AssociatedTenant" ], "description": "Gets an associated tenant by ID.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "associatedTenantName", "in": "path", "description": "The ID that uniquely identifies a tenant.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AssociatedTenant" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AssociatedTenantsGet": { "$ref": "./examples/associatedTenantsGet.json" } } }, "put": { "operationId": "AssociatedTenants_CreateOrUpdate", "tags": [ "AssociatedTenant" ], "description": "Create or update an associated tenant for the billing account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "associatedTenantName", "in": "path", "description": "The ID that uniquely identifies a tenant.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "parameters", "in": "body", "description": "An associated tenant.", "required": true, "schema": { "$ref": "#/definitions/AssociatedTenant" } } ], "responses": { "200": { "description": "Resource 'AssociatedTenant' update operation succeeded", "schema": { "$ref": "#/definitions/AssociatedTenant" } }, "201": { "description": "Resource 'AssociatedTenant' create operation succeeded", "schema": { "$ref": "#/definitions/AssociatedTenant" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AssociatedTenantsCreateOrUpdate": { "$ref": "./examples/associatedTenantsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/AssociatedTenant" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "AssociatedTenants_Delete", "tags": [ "AssociatedTenant" ], "description": "Deletes an associated tenant for a billing account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "associatedTenantName", "in": "path", "description": "The ID that uniquely identifies a tenant.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AssociatedTenantsDelete": { "$ref": "./examples/associatedTenantsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/availableBalance/default": { "get": { "operationId": "AvailableBalances_GetByBillingAccount", "tags": [ "AvailableBalance" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AvailableBalance" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AvailableBalanceGetByBillingAccount": { "$ref": "./examples/availableBalanceGetByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions": { "get": { "operationId": "BillingPermissions_ListByBillingAccount", "tags": [ "BillingPermission" ], "description": "Lists the billing permissions the caller has on a billing account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPermissionsListByBillingAccount": { "$ref": "./examples/billingPermissionsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles": { "get": { "operationId": "BillingProfiles_ListByBillingAccount", "tags": [ "BillingProfile" ], "description": "Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted billing profiles.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingProfileListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingProfilesListByBillingAccount": { "$ref": "./examples/billingProfilesListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}": { "get": { "operationId": "BillingProfiles_Get", "tags": [ "BillingProfile" ], "description": "Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingProfile" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingProfilesGet": { "$ref": "./examples/billingProfilesGet.json" } } }, "put": { "operationId": "BillingProfiles_CreateOrUpdate", "tags": [ "BillingProfile" ], "description": "Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "A billing profile.", "required": true, "schema": { "$ref": "#/definitions/BillingProfile" } } ], "responses": { "200": { "description": "Resource 'BillingProfile' update operation succeeded", "schema": { "$ref": "#/definitions/BillingProfile" } }, "201": { "description": "Resource 'BillingProfile' create operation succeeded", "schema": { "$ref": "#/definitions/BillingProfile" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingProfilesCreateOrUpdate": { "$ref": "./examples/billingProfilesCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingProfile" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "BillingProfiles_Delete", "tags": [ "BillingProfile" ], "description": "Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingProfilesDelete": { "$ref": "./examples/billingProfilesDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default": { "get": { "operationId": "AvailableBalances_GetByBillingProfile", "tags": [ "AvailableBalance" ], "description": "The Available Credit or Payment on Account Balance for a billing profile. 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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AvailableBalance" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AvailableBalanceGetByBillingProfile": { "$ref": "./examples/availableBalanceGetByBillingProfile.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingPermissions": { "get": { "operationId": "BillingPermissions_ListByBillingProfile", "tags": [ "BillingPermission" ], "description": "Lists the billing permissions the caller has on a billing profile.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPermissionsListByBillingProfile": { "$ref": "./examples/billingPermissionsListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRequests": { "get": { "operationId": "BillingRequests_ListByBillingProfile", "tags": [ "BillingRequest" ], "description": "The list of billing requests submitted for the billing profile.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRequestListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRequestsListByBillingProfile": { "$ref": "./examples/billingRequestsListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments": { "get": { "operationId": "BillingRoleAssignments_ListByBillingProfile", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentListByBillingProfile": { "$ref": "./examples/billingRoleAssignmentListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "operationId": "BillingRoleAssignments_GetByBillingProfile", "tags": [ "BillingRoleAssignment" ], "description": "Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentGetByBillingProfile": { "$ref": "./examples/billingRoleAssignmentGetByBillingProfile.json" } } }, "delete": { "operationId": "BillingRoleAssignments_DeleteByBillingProfile", "tags": [ "BillingRoleAssignment" ], "description": "Deletes a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentDeleteByBillingProfile": { "$ref": "./examples/billingRoleAssignmentDeleteByBillingProfile.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions": { "get": { "operationId": "BillingRoleDefinition_ListByBillingProfile", "tags": [ "BillingRoleDefinition" ], "description": "Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionListByBillingProfile": { "$ref": "./examples/billingRoleDefinitionListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{roleDefinitionName}": { "get": { "operationId": "BillingRoleDefinition_GetByBillingProfile", "tags": [ "BillingRoleDefinition" ], "description": "Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "roleDefinitionName", "in": "path", "description": "The ID that uniquely identifies a role definition.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionGetByBillingProfile": { "$ref": "./examples/billingRoleDefinitionGetByBillingProfile.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions": { "get": { "operationId": "BillingSubscriptions_ListByBillingProfile", "tags": [ "BillingSubscription" ], "description": "Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted billing subscriptions.", "required": false, "type": "boolean", "default": false }, { "name": "expand", "in": "query", "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsListByBillingProfileEA": { "$ref": "./examples/billingSubscriptionsListByBillingProfileEA.json" }, "BillingSubscriptionsListByBillingProfileMCA": { "$ref": "./examples/billingSubscriptionsListByBillingProfileMCA.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions/{billingSubscriptionName}": { "get": { "operationId": "BillingSubscriptions_GetByBillingProfile", "tags": [ "BillingSubscription" ], "description": "Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "expand", "in": "query", "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionGetByBillingProfile": { "$ref": "./examples/billingSubscriptionGetByBillingProfile.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/checkAccess": { "post": { "operationId": "BillingPermissions_CheckAccessByBillingProfile", "tags": [ "BillingPermission" ], "description": "Provides a list of check access response objects for a billing profile.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The request object against which access of the caller will be checked.", "required": true, "schema": { "$ref": "#/definitions/CheckAccessRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckAccessResponse" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CheckAccessByBillingProfile": { "$ref": "./examples/checkAccessByBillingProfile.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/createBillingRoleAssignment": { "post": { "operationId": "BillingRoleAssignments_CreateByBillingProfile", "tags": [ "BillingRoleAssignment" ], "description": "Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The properties of the billing role assignment.", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignmentProperties" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentCreateByBillingProfile": { "$ref": "./examples/billingRoleAssignmentCreateByBillingProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignment" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers": { "get": { "operationId": "Customers_ListByBillingProfile", "tags": [ "Customer" ], "description": "Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "expand", "in": "query", "description": "May be used to expand enabledAzurePlans and resellers", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CustomerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CustomersListByBillingProfile": { "$ref": "./examples/customersListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}": { "get": { "operationId": "Customers_Get", "tags": [ "Customer" ], "description": "Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Customer" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CustomersGet": { "$ref": "./examples/customersGet.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingPermissions": { "get": { "operationId": "BillingPermissions_ListByCustomer", "tags": [ "BillingPermission" ], "description": "Lists the billing permissions the caller has for a customer.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPermissionsListByCustomer": { "$ref": "./examples/billingPermissionsListByCustomer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRequests": { "get": { "operationId": "BillingRequests_ListByCustomer", "tags": [ "BillingRequest" ], "description": "The list of billing requests submitted for the customer.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRequestListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRequestsListByCustomer": { "$ref": "./examples/billingRequestsListByCustomer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments": { "get": { "operationId": "BillingRoleAssignments_ListByCustomer", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentListByCustomer": { "$ref": "./examples/billingRoleAssignmentListByCustomer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "operationId": "BillingRoleAssignments_GetByCustomer", "tags": [ "BillingRoleAssignment" ], "description": "Gets a role assignment for the caller on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentGetByCustomer": { "$ref": "./examples/billingRoleAssignmentGetByCustomer.json" } } }, "delete": { "operationId": "BillingRoleAssignments_DeleteByCustomer", "tags": [ "BillingRoleAssignment" ], "description": "Deletes a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentDeleteByCustomer": { "$ref": "./examples/billingRoleAssignmentDeleteByCustomer.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleDefinitions": { "get": { "operationId": "BillingRoleDefinition_ListByCustomer", "tags": [ "BillingRoleDefinition" ], "description": "Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionListByCustomer": { "$ref": "./examples/billingRoleDefinitionListByCustomer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleDefinitions/{roleDefinitionName}": { "get": { "operationId": "BillingRoleDefinition_GetByCustomer", "tags": [ "BillingRoleDefinition" ], "description": "Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "roleDefinitionName", "in": "path", "description": "The ID that uniquely identifies a role definition.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionGetByCustomer": { "$ref": "./examples/billingRoleDefinitionGetByCustomer.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingSubscriptions": { "get": { "operationId": "BillingSubscriptions_ListByCustomer", "tags": [ "BillingSubscription" ], "description": "Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted billing subscriptions.", "required": false, "type": "boolean", "default": false }, { "name": "expand", "in": "query", "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsListByCustomer": { "$ref": "./examples/billingSubscriptionsListByCustomer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/checkAccess": { "post": { "operationId": "BillingPermissions_CheckAccessByCustomer", "tags": [ "BillingPermission" ], "description": "Provides a list of check access response objects for a customer.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The request object against which access of the caller will be checked.", "required": true, "schema": { "$ref": "#/definitions/CheckAccessRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckAccessResponse" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CheckAccessByCustomer": { "$ref": "./examples/checkAccessByCustomer.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/createBillingRoleAssignment": { "post": { "operationId": "BillingRoleAssignments_CreateByCustomer", "tags": [ "BillingRoleAssignment" ], "description": "Adds a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The properties of the billing role assignment.", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignmentProperties" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentCreateByCustomer": { "$ref": "./examples/billingRoleAssignmentCreateByCustomer.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignment" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/{policyName}": { "get": { "operationId": "Policies_GetByCustomer", "tags": [ "Policy" ], "description": "Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "policyName", "in": "path", "description": "Service-defined resource names such as 'default' which are reserved resource names.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$", "enum": [ "default" ], "x-ms-enum": { "name": "ServiceDefinedResourceName", "modelAsString": true, "values": [ { "name": "default", "value": "default", "description": "default" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CustomerPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesGetByCustomer": { "$ref": "./examples/policiesGetByCustomer.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/default": { "put": { "operationId": "Policies_CreateOrUpdateByCustomer", "tags": [ "Policy" ], "description": "Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "A policy at customer scope.", "required": true, "schema": { "$ref": "#/definitions/CustomerPolicy" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CustomerPolicy" } }, "201": { "description": "Resource 'CustomerPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/CustomerPolicy" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesPutByCustomer": { "$ref": "./examples/policiesPutByCustomer.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/CustomerPolicy" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/resolveBillingRoleAssignments": { "post": { "operationId": "BillingRoleAssignments_ResolveByCustomer", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on a customer while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "resolveScopeDisplayNames", "in": "query", "description": "Resolves the scope display name for each of the role assignments.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResolveBillingRoleAssignmentByCustomer": { "$ref": "./examples/resolveBillingRoleAssignmentByCustomer.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignmentListResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transactions": { "get": { "operationId": "Transactions_ListByCustomer", "tags": [ "Transaction" ], "description": "Lists the billed or unbilled transactions by customer id for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "periodStartDate", "in": "query", "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", "required": true, "type": "string", "format": "date" }, { "name": "periodEndDate", "in": "query", "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", "required": true, "type": "string", "format": "date" }, { "name": "type", "in": "query", "description": "The type of transaction.", "required": true, "type": "string", "enum": [ "Other", "Billed", "Unbilled" ], "x-ms-enum": { "name": "TransactionType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Billed", "value": "Billed", "description": "Billed" }, { "name": "Unbilled", "value": "Unbilled", "description": "Unbilled" } ] } }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransactionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransactionsListByCustomer": { "$ref": "./examples/transactionsListByCustomer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers": { "get": { "operationId": "PartnerTransfers_List", "tags": [ "Transfers" ], "description": "Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PartnerTransferDetailsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PartnerTransfersList": { "$ref": "./examples/partnerTransfersList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}": { "get": { "operationId": "PartnerTransfers_Get", "tags": [ "Transfers" ], "description": "Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PartnerTransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PartnerTransferGet": { "$ref": "./examples/partnerTransfersGet.json" } } }, "put": { "operationId": "PartnerTransfers_Initiate", "tags": [ "Transfers" ], "description": "Sends a request to a user in a customer's billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" }, { "name": "parameters", "in": "body", "description": "Request parameters that are provided to the initiate transfer operation.", "required": true, "schema": { "$ref": "#/definitions/PartnerInitiateTransferRequest" } } ], "responses": { "200": { "description": "Resource 'PartnerTransferDetails' update operation succeeded", "schema": { "$ref": "#/definitions/PartnerTransferDetails" } }, "201": { "description": "Resource 'PartnerTransferDetails' create operation succeeded", "schema": { "$ref": "#/definitions/PartnerTransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InitiatePartnerTransfer": { "$ref": "./examples/partnerTransfersInitiate.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}/cancel": { "post": { "operationId": "PartnerTransfers_Cancel", "tags": [ "Transfers" ], "description": "Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PartnerTransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PartnerTransferCancel": { "$ref": "./examples/partnerTransfersCancel.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections": { "get": { "operationId": "InvoiceSections_ListByBillingProfile", "tags": [ "InvoiceSection" ], "description": "Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted invoice sections.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InvoiceSectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoiceSectionsListByBillingProfile": { "$ref": "./examples/invoiceSectionsListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}": { "get": { "operationId": "InvoiceSections_Get", "tags": [ "InvoiceSection" ], "description": "Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InvoiceSection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoiceSectionsGet": { "$ref": "./examples/invoiceSectionsGet.json" } } }, "put": { "operationId": "InvoiceSections_CreateOrUpdate", "tags": [ "InvoiceSection" ], "description": "Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "An invoice section.", "required": true, "schema": { "$ref": "#/definitions/InvoiceSection" } } ], "responses": { "200": { "description": "Resource 'InvoiceSection' update operation succeeded", "schema": { "$ref": "#/definitions/InvoiceSection" } }, "201": { "description": "Resource 'InvoiceSection' create operation succeeded", "schema": { "$ref": "#/definitions/InvoiceSection" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoiceSectionsCreateOrUpdate": { "$ref": "./examples/invoiceSectionsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/InvoiceSection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "InvoiceSections_Delete", "tags": [ "InvoiceSection" ], "description": "Deletes an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoiceSectionsDelete": { "$ref": "./examples/invoiceSectionsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingPermissions": { "get": { "operationId": "BillingPermissions_ListByInvoiceSection", "tags": [ "BillingPermission" ], "description": "Lists the billing permissions the caller has for an invoice section.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPermissionsListByInvoiceSection": { "$ref": "./examples/billingPermissionsListByInvoiceSection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRequests": { "get": { "operationId": "BillingRequests_ListByInvoiceSection", "tags": [ "BillingRequest" ], "description": "The list of billing requests submitted for the invoice section.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRequestListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRequestsListByInvoiceSection": { "$ref": "./examples/billingRequestsListByInvoiceSection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments": { "get": { "operationId": "BillingRoleAssignments_ListByInvoiceSection", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentListByInvoiceSection": { "$ref": "./examples/billingRoleAssignmentListByInvoiceSection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "operationId": "BillingRoleAssignments_GetByInvoiceSection", "tags": [ "BillingRoleAssignment" ], "description": "Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentGetByInvoiceSection": { "$ref": "./examples/billingRoleAssignmentGetByInvoiceSection.json" } } }, "delete": { "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", "tags": [ "BillingRoleAssignment" ], "description": "Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentDeleteByInvoiceSection": { "$ref": "./examples/billingRoleAssignmentDeleteByInvoiceSection.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions": { "get": { "operationId": "BillingRoleDefinition_ListByInvoiceSection", "tags": [ "BillingRoleDefinition" ], "description": "Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionListByInvoiceSection": { "$ref": "./examples/billingRoleDefinitionListByInvoiceSection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{roleDefinitionName}": { "get": { "operationId": "BillingRoleDefinition_GetByInvoiceSection", "tags": [ "BillingRoleDefinition" ], "description": "Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "roleDefinitionName", "in": "path", "description": "The ID that uniquely identifies a role definition.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionGetByInvoiceSection": { "$ref": "./examples/billingRoleDefinitionGetByInvoiceSection.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions": { "get": { "operationId": "BillingSubscriptions_ListByInvoiceSection", "tags": [ "BillingSubscription" ], "description": "Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted billing subscriptions.", "required": false, "type": "boolean", "default": false }, { "name": "expand", "in": "query", "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsListByInvoiceSection": { "$ref": "./examples/billingSubscriptionsListByInvoiceSection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/checkAccess": { "post": { "operationId": "BillingPermissions_CheckAccessByInvoiceSection", "tags": [ "BillingPermission" ], "description": "Provides a list of check access response objects for an invoice section.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The request object against which access of the caller will be checked.", "required": true, "schema": { "$ref": "#/definitions/CheckAccessRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckAccessResponse" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CheckAccessByInvoiceSection": { "$ref": "./examples/checkAccessByInvoiceSection.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/createBillingRoleAssignment": { "post": { "operationId": "BillingRoleAssignments_CreateByInvoiceSection", "tags": [ "BillingRoleAssignment" ], "description": "Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The properties of the billing role assignment.", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignmentProperties" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentCreateByInvoiceSection": { "$ref": "./examples/billingRoleAssignmentCreateByInvoiceSection.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignment" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products": { "get": { "operationId": "Products_ListByInvoiceSection", "tags": [ "Product" ], "description": "Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProductListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductsListByInvoiceSection": { "$ref": "./examples/productsListByInvoiceSection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/resolveBillingRoleAssignments": { "post": { "operationId": "BillingRoleAssignments_ResolveByInvoiceSection", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on an invoice section while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "resolveScopeDisplayNames", "in": "query", "description": "Resolves the scope display name for each of the role assignments.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResolveBillingRoleAssignmentByInvoiceSection": { "$ref": "./examples/resolveBillingRoleAssignmentByInvoiceSection.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignmentListResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transactions": { "get": { "operationId": "Transactions_ListByInvoiceSection", "tags": [ "Transaction" ], "description": "Lists the billed or unbilled transactions by invoice section name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "periodStartDate", "in": "query", "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", "required": true, "type": "string", "format": "date" }, { "name": "periodEndDate", "in": "query", "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", "required": true, "type": "string", "format": "date" }, { "name": "type", "in": "query", "description": "The type of transaction.", "required": true, "type": "string", "enum": [ "Other", "Billed", "Unbilled" ], "x-ms-enum": { "name": "TransactionType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Billed", "value": "Billed", "description": "Billed" }, { "name": "Unbilled", "value": "Unbilled", "description": "Unbilled" } ] } }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransactionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransactionsListByInvoiceSection": { "$ref": "./examples/transactionsListByInvoiceSection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers": { "get": { "operationId": "Transfers_List", "tags": [ "Transfers" ], "description": "Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransferDetailsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransfersList": { "$ref": "./examples/transfersList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}": { "get": { "operationId": "Transfers_Get", "tags": [ "Transfers" ], "description": "Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransferGet": { "$ref": "./examples/transfersGet.json" } } }, "put": { "operationId": "Transfers_Initiate", "tags": [ "Transfers" ], "description": "Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" }, { "name": "parameters", "in": "body", "description": "Request parameters that are provided to the initiate transfer operation.", "required": true, "schema": { "$ref": "#/definitions/InitiateTransferRequest" } } ], "responses": { "200": { "description": "Resource 'TransferDetails' update operation succeeded", "schema": { "$ref": "#/definitions/TransferDetails" } }, "201": { "description": "Resource 'TransferDetails' create operation succeeded", "schema": { "$ref": "#/definitions/TransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InitiateTransfer": { "$ref": "./examples/transfersInitiate.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}/cancel": { "post": { "operationId": "Transfers_Cancel", "tags": [ "Transfers" ], "description": "Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransferCancel": { "$ref": "./examples/transfersCancel.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/validateDeleteEligibility": { "post": { "operationId": "InvoiceSections_ValidateDeleteEligibility", "tags": [ "InvoiceSection" ], "description": "Validates if the invoice section can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "invoiceSectionName", "in": "path", "description": "The ID that uniquely identifies an invoice section.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeleteInvoiceSectionEligibilityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoiceSectionsValidateDeleteEligibilityFailure": { "$ref": "./examples/invoiceSectionsValidateDeleteEligibilityFailure.json" }, "InvoiceSectionsValidateDeleteEligibilitySuccess": { "$ref": "./examples/invoiceSectionsValidateDeleteEligibilitySuccess.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices": { "get": { "operationId": "Invoices_ListByBillingProfile", "tags": [ "Invoice" ], "description": "Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "periodStartDate", "in": "query", "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "required": false, "type": "string", "format": "date" }, { "name": "periodEndDate", "in": "query", "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "required": false, "type": "string", "format": "date" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InvoiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesListByBillingProfile": { "$ref": "./examples/invoicesListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks": { "get": { "operationId": "PaymentMethods_ListByBillingProfile", "tags": [ "PaymentMethods" ], "description": "Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PaymentMethodLinksListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PaymentMethodsListByBillingProfile": { "$ref": "./examples/paymentMethodsListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks/{paymentMethodName}": { "get": { "operationId": "PaymentMethods_GetByBillingProfile", "tags": [ "PaymentMethods" ], "description": "Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string" }, { "name": "paymentMethodName", "in": "path", "description": "The ID that uniquely identifies a payment method.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PaymentMethodLink" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PaymentMethodsGetByBillingProfile": { "$ref": "./examples/paymentMethodsGetByBillingProfile.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default": { "get": { "operationId": "Policies_GetByBillingProfile", "tags": [ "Policy" ], "description": "Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingProfilePolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesGetByBillingProfile": { "$ref": "./examples/policiesGetByBillingProfile.json" } } }, "put": { "operationId": "Policies_CreateOrUpdateByBillingProfile", "tags": [ "Policy" ], "description": "Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "A policy at billing profile scope.", "required": true, "schema": { "$ref": "#/definitions/BillingProfilePolicy" } } ], "responses": { "200": { "description": "Resource 'BillingProfilePolicy' update operation succeeded", "schema": { "$ref": "#/definitions/BillingProfilePolicy" } }, "201": { "description": "Resource 'BillingProfilePolicy' create operation succeeded", "schema": { "$ref": "#/definitions/BillingProfilePolicy" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesPutByBillingProfile": { "$ref": "./examples/policiesPutByBillingProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingProfilePolicy" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products": { "get": { "operationId": "Products_ListByBillingProfile", "tags": [ "Product" ], "description": "Lists the products for a billing profile. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProductListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductsListByBillingProfile": { "$ref": "./examples/productsListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations": { "get": { "operationId": "Reservations_ListByBillingProfile", "tags": [ "Reservations" ], "description": "Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "skiptoken", "in": "query", "description": "The number of reservations to skip from the list before returning results", "required": false, "type": "number", "format": "float" }, { "name": "refreshSummary", "in": "query", "description": "To indicate whether to refresh the roll up counts of the reservations group by provisioning states", "required": false, "type": "string" }, { "name": "selectedState", "in": "query", "description": "The selected provisioning state", "required": false, "type": "string" }, { "name": "take", "in": "query", "description": "The number of reservations to return in API response.", "required": false, "type": "number", "format": "float" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReservationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReservationsListByBillingProfile": { "$ref": "./examples/reservationsListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/resolveBillingRoleAssignments": { "post": { "operationId": "BillingRoleAssignments_ResolveByBillingProfile", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "resolveScopeDisplayNames", "in": "query", "description": "Resolves the scope display name for each of the role assignments.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResolveBillingRoleAssignmentByBillingProfile": { "$ref": "./examples/resolveBillingRoleAssignmentByBillingProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignmentListResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions": { "get": { "operationId": "Transactions_ListByBillingProfile", "tags": [ "Transaction" ], "description": "Lists the billed or unbilled transactions by billing profile name for given start and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "periodStartDate", "in": "query", "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", "required": true, "type": "string", "format": "date" }, { "name": "periodEndDate", "in": "query", "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", "required": true, "type": "string", "format": "date" }, { "name": "type", "in": "query", "description": "The type of transaction.", "required": true, "type": "string", "enum": [ "Other", "Billed", "Unbilled" ], "x-ms-enum": { "name": "TransactionType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Billed", "value": "Billed", "description": "Billed" }, { "name": "Unbilled", "value": "Unbilled", "description": "Unbilled" } ] } }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransactionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransactionsListByBillingProfile": { "$ref": "./examples/transactionsListByBillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/validateDeleteEligibility": { "post": { "operationId": "BillingProfiles_ValidateDeleteEligibility", "tags": [ "BillingProfile" ], "description": "Validates if the billing profile can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingProfileName", "in": "path", "description": "The ID that uniquely identifies a billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeleteBillingProfileEligibilityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingProfilesValidateDeleteEligibilityFailure": { "$ref": "./examples/billingProfilesValidateDeleteEligibilityFailure.json" }, "BillingProfilesValidateDeleteEligibilitySuccess": { "$ref": "./examples/billingProfilesValidateDeleteEligibilitySuccess.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRequests": { "get": { "operationId": "BillingRequests_ListByBillingAccount", "tags": [ "BillingRequest" ], "description": "The list of billing requests submitted for the billing account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRequestListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRequestsListByBillingAccount": { "$ref": "./examples/billingRequestsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments": { "get": { "operationId": "BillingRoleAssignments_ListByBillingAccount", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments 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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentListByBillingAccount": { "$ref": "./examples/billingRoleAssignmentListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "operationId": "BillingRoleAssignments_GetByBillingAccount", "tags": [ "BillingRoleAssignment" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentGetByBillingAccount": { "$ref": "./examples/billingRoleAssignmentGetByBillingAccount.json" } } }, "put": { "operationId": "BillingRoleAssignments_CreateOrUpdateByBillingAccount", "tags": [ "BillingRoleAssignment" ], "description": "Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" }, { "name": "parameters", "in": "body", "description": "The properties of the billing role assignment.", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignment" } } ], "responses": { "200": { "description": "Resource 'BillingRoleAssignment' update operation succeeded", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "201": { "description": "Resource 'BillingRoleAssignment' create operation succeeded", "schema": { "$ref": "#/definitions/BillingRoleAssignment" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentCreateOrUpdateByBillingAccount": { "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignment" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "BillingRoleAssignments_DeleteByBillingAccount", "tags": [ "BillingRoleAssignment" ], "description": "Deletes a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentDeleteByBillingAccount": { "$ref": "./examples/billingRoleAssignmentDeleteByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions": { "get": { "operationId": "BillingRoleDefinition_ListByBillingAccount", "tags": [ "BillingRoleDefinition" ], "description": "Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionListByBillingAccount": { "$ref": "./examples/billingRoleDefinitionListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{roleDefinitionName}": { "get": { "operationId": "BillingRoleDefinition_GetByBillingAccount", "tags": [ "BillingRoleDefinition" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "roleDefinitionName", "in": "path", "description": "The ID that uniquely identifies a role definition.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionGetByBillingAccount": { "$ref": "./examples/billingRoleDefinitionGetByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases": { "get": { "operationId": "BillingSubscriptionsAliases_ListByBillingAccount", "tags": [ "BillingSubscription" ], "description": "Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted billing subscriptions.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionAliasListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionAliasList": { "$ref": "./examples/billingSubscriptionAliasList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}": { "get": { "operationId": "BillingSubscriptionsAliases_Get", "tags": [ "BillingSubscription" ], "description": "Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "aliasName", "in": "path", "description": "The ID that uniquely identifies a subscription alias.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionAlias" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionAliasGet": { "$ref": "./examples/billingSubscriptionAliasGet.json" } } }, "put": { "operationId": "BillingSubscriptionsAliases_CreateOrUpdate", "tags": [ "BillingSubscription" ], "description": "Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "aliasName", "in": "path", "description": "The ID that uniquely identifies a subscription alias.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "A billing subscription alias.", "required": true, "schema": { "$ref": "#/definitions/BillingSubscriptionAlias" } } ], "responses": { "200": { "description": "Resource 'BillingSubscriptionAlias' update operation succeeded", "schema": { "$ref": "#/definitions/BillingSubscriptionAlias" } }, "201": { "description": "Resource 'BillingSubscriptionAlias' create operation succeeded", "schema": { "$ref": "#/definitions/BillingSubscriptionAlias" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionAliasCreateOrUpdate": { "$ref": "./examples/billingSubscriptionAliasCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingSubscriptionAlias" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions": { "get": { "operationId": "BillingSubscriptions_ListByBillingAccount", "tags": [ "BillingSubscription" ], "description": "Lists the subscriptions for a billing account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted billing subscriptions.", "required": false, "type": "boolean", "default": false }, { "name": "includeTenantSubscriptions", "in": "query", "description": "Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts.", "required": false, "type": "boolean", "default": false }, { "name": "includeFailed", "in": "query", "description": "Can be used to get failed billing subscriptions.", "required": false, "type": "boolean", "default": false }, { "name": "expand", "in": "query", "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsListByBillingAccount": { "$ref": "./examples/billingSubscriptionsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}": { "get": { "operationId": "BillingSubscriptions_Get", "tags": [ "BillingSubscription" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "expand", "in": "query", "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsGet": { "$ref": "./examples/billingSubscriptionsGet.json" } } }, "patch": { "operationId": "BillingSubscriptions_Update", "tags": [ "BillingSubscription" ], "description": "Updates the properties of a billing subscription.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The billing properties of a subscription.", "required": true, "schema": { "$ref": "#/definitions/BillingSubscriptionPatch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscription" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsUpdate": { "$ref": "./examples/billingSubscriptionsUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingSubscription" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "BillingSubscriptions_Delete", "tags": [ "BillingSubscription" ], "description": "Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsDelete": { "$ref": "./examples/billingSubscriptionsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/cancel": { "post": { "operationId": "BillingSubscriptions_Cancel", "tags": [ "BillingSubscription" ], "description": "Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Request parameters for cancel customer subscription.", "required": true, "schema": { "$ref": "#/definitions/CancelSubscriptionRequest" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsCancel": { "$ref": "./examples/billingSubscriptionsCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/merge": { "post": { "operationId": "BillingSubscriptions_Merge", "tags": [ "BillingSubscription" ], "description": "Merges the billing subscription provided in the request with a target billing subscription.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Request parameters that are provided to merge the two billing subscriptions.", "required": true, "schema": { "$ref": "#/definitions/BillingSubscriptionMergeRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscription" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsMerge": { "$ref": "./examples/billingSubscriptionsMerge.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingSubscription" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/move": { "post": { "operationId": "BillingSubscriptions_Move", "tags": [ "BillingSubscription" ], "description": "Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Request parameters to transfer billing subscription.", "required": true, "schema": { "$ref": "#/definitions/MoveBillingSubscriptionRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscription" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionMove": { "$ref": "./examples/billingSubscriptionMove.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingSubscription" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/split": { "post": { "operationId": "BillingSubscriptions_Split", "tags": [ "BillingSubscription" ], "description": "Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Request parameters that are provided to split the billing subscription.", "required": true, "schema": { "$ref": "#/definitions/BillingSubscriptionSplitRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscription" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsSplit": { "$ref": "./examples/billingSubscriptionsSplit.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingSubscription" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/validateMoveEligibility": { "post": { "operationId": "BillingSubscriptions_ValidateMoveEligibility", "tags": [ "BillingSubscription" ], "description": "Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "billingSubscriptionName", "in": "path", "description": "The ID that uniquely identifies a subscription.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Request parameters to transfer billing subscription.", "required": true, "schema": { "$ref": "#/definitions/MoveBillingSubscriptionRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MoveBillingSubscriptionEligibilityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionValidateMoveFailure": { "$ref": "./examples/billingSubscriptionValidateMoveFailure.json" }, "BillingSubscriptionValidateMoveSuccess": { "$ref": "./examples/billingSubscriptionValidateMoveSuccess.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/cancelPaymentTerms": { "post": { "operationId": "BillingAccounts_CancelPaymentTerms", "tags": [ "BillingAccount" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "Date after which any payment terms that needs to be cancelled.", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingAccount" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PaymentTermsCancel": { "$ref": "./examples/paymentTermsCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingAccount" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/checkAccess": { "post": { "operationId": "BillingPermissions_CheckAccessByBillingAccount", "tags": [ "BillingPermission" ], "description": "Provides a list of check access response objects for a billing account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "The request object against which access of the caller will be checked.", "required": true, "schema": { "$ref": "#/definitions/CheckAccessRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckAccessResponse" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CheckAccessByBillingAccount": { "$ref": "./examples/checkAccessByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/confirmTransition": { "post": { "operationId": "BillingAccounts_ConfirmTransition", "tags": [ "BillingAccount" ], "description": "Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransitionDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountsConfirmTransition": { "$ref": "./examples/billingAccountsConfirmTransition.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment": { "post": { "operationId": "BillingRoleAssignments_CreateByBillingAccount", "tags": [ "BillingRoleAssignment" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "The properties of the billing role assignment.", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignmentProperties" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentCreateByBillingAccount": { "$ref": "./examples/billingRoleAssignmentCreateByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignment" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers": { "get": { "operationId": "Customers_ListByBillingAccount", "tags": [ "Customer" ], "description": "Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "expand", "in": "query", "description": "May be used to expand enabledAzurePlans and resellers", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CustomerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CustomersListByBillingAccount": { "$ref": "./examples/customersListByBillingAccount.json" }, "CustomersListByBillingAccountWithExpand": { "$ref": "./examples/customersListByBillingAccountWithExpand.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}": { "get": { "operationId": "Customers_GetByBillingAccount", "tags": [ "Customer" ], "description": "Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Customer" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CustomersGetByBillingAccount": { "$ref": "./examples/customersGetByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingPermissions": { "get": { "operationId": "BillingPermissions_ListByCustomerAtBillingAccount", "tags": [ "BillingPermission" ], "description": "Lists the billing permissions the caller has for a customer at billing account level.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPermissionsListByCustomerAtBillingAccount": { "$ref": "./examples/billingPermissionsListByCustomerAtBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions": { "get": { "operationId": "BillingSubscriptions_ListByCustomerAtBillingAccount", "tags": [ "BillingSubscription" ], "description": "Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string" }, { "name": "includeDeleted", "in": "query", "description": "Can be used to get deleted billing subscriptions.", "required": false, "type": "boolean", "default": false }, { "name": "expand", "in": "query", "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsListByCustomerAtBillingAccount": { "$ref": "./examples/billingSubscriptionsListByCustomerAtBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default": { "get": { "operationId": "Policies_GetByCustomerAtBillingAccount", "tags": [ "Policy" ], "description": "Lists the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CustomerPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesGetByCustomerAtBillingAccount": { "$ref": "./examples/policiesGetByCustomerAtBillingAccount.json" } } }, "put": { "operationId": "Policies_CreateOrUpdateByCustomerAtBillingAccount", "tags": [ "Policy" ], "description": "Updates the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "A policy at customer scope.", "required": true, "schema": { "$ref": "#/definitions/CustomerPolicy" } } ], "responses": { "200": { "description": "Resource 'CustomerPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/CustomerPolicy" } }, "201": { "description": "Resource 'CustomerPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/CustomerPolicy" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesPutByCustomerAtBillingAccount": { "$ref": "./examples/policiesPutByCustomerAtBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/CustomerPolicy" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products": { "get": { "operationId": "Products_ListByCustomer", "tags": [ "Product" ], "description": "Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "customerName", "in": "path", "description": "The ID that uniquely identifies a customer.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProductListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductsListByCustomer": { "$ref": "./examples/productsListByCustomer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments": { "get": { "operationId": "Departments_ListByBillingAccount", "tags": [ "Department" ], "description": "Lists the departments that a user has access to. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DepartmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DepartmentsListByBillingAccount": { "$ref": "./examples/departmentsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}": { "get": { "operationId": "Departments_Get", "tags": [ "Department" ], "description": "Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Department" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DepartmentGet": { "$ref": "./examples/departmentGet.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingPermissions": { "get": { "operationId": "BillingPermissions_ListByDepartment", "tags": [ "BillingPermission" ], "description": "Lists the billing permissions the caller has for a department.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPermissionsListByDepartment": { "$ref": "./examples/billingPermissionsListByDepartment.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments": { "get": { "operationId": "BillingRoleAssignments_ListByDepartment", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on a department. The operation is supported for billing accounts of type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentListByDepartment": { "$ref": "./examples/billingRoleAssignmentListByDepartment.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "operationId": "BillingRoleAssignments_GetByDepartment", "tags": [ "BillingRoleAssignment" ], "description": "Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentGetByDepartment": { "$ref": "./examples/billingRoleAssignmentGetByDepartment.json" } } }, "put": { "operationId": "BillingRoleAssignments_CreateOrUpdateByDepartment", "tags": [ "BillingRoleAssignment" ], "description": "Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" }, { "name": "parameters", "in": "body", "description": "The properties of the billing role assignment.", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignment" } } ], "responses": { "200": { "description": "Resource 'BillingRoleAssignment' update operation succeeded", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "201": { "description": "Resource 'BillingRoleAssignment' create operation succeeded", "schema": { "$ref": "#/definitions/BillingRoleAssignment" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentCreateOrUpdateByDepartment": { "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByDepartment.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignment" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "BillingRoleAssignments_DeleteByDepartment", "tags": [ "BillingRoleAssignment" ], "description": "Deletes a role assignment on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentDeleteByDepartment": { "$ref": "./examples/billingRoleAssignmentDeleteByDepartment.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions": { "get": { "operationId": "BillingRoleDefinition_ListByDepartment", "tags": [ "BillingRoleDefinition" ], "description": "List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionListByDepartment": { "$ref": "./examples/billingRoleDefinitionListByDepartment.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions/{roleDefinitionName}": { "get": { "operationId": "BillingRoleDefinition_GetByDepartment", "tags": [ "BillingRoleDefinition" ], "description": "Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "roleDefinitionName", "in": "path", "description": "The ID that uniquely identifies a role definition.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionGetByDepartment": { "$ref": "./examples/billingRoleDefinitionGetByDepartment.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/checkAccess": { "post": { "operationId": "BillingPermissions_CheckAccessByDepartment", "tags": [ "BillingPermission" ], "description": "Provides a list of check access response objects for a department.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The request object against which access of the caller will be checked.", "required": true, "schema": { "$ref": "#/definitions/CheckAccessRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckAccessResponse" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CheckAccessByDepartment": { "$ref": "./examples/checkAccessByDepartment.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts": { "get": { "operationId": "EnrollmentAccounts_ListByDepartment", "tags": [ "EnrollmentAccount" ], "description": "Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnrollmentAccountListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "EnrollmentAccountsListByDepartment": { "$ref": "./examples/enrollmentAccountsListByDepartment.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts/{enrollmentAccountName}": { "get": { "operationId": "EnrollmentAccounts_GetByDepartment", "tags": [ "EnrollmentAccount" ], "description": "Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "departmentName", "in": "path", "description": "The name of the department.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnrollmentAccount" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "EnrollmentAccountByDepartment": { "$ref": "./examples/enrollmentAccountByDepartment.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments": { "post": { "operationId": "Invoices_DownloadDocumentsByBillingAccount", "tags": [ "Invoice" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "A list of download details for individual documents.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/DocumentDownloadRequest" } } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DocumentDownloadResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesDownloadDocumentsByBillingAccount": { "$ref": "./examples/invoicesDownloadDocumentsByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DocumentDownloadResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts": { "get": { "operationId": "EnrollmentAccounts_ListByBillingAccount", "tags": [ "EnrollmentAccount" ], "description": "Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnrollmentAccountListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "EnrollmentAccountsListByBillingAccount": { "$ref": "./examples/enrollmentAccountsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}": { "get": { "operationId": "EnrollmentAccounts_Get", "tags": [ "EnrollmentAccount" ], "description": "Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnrollmentAccount" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "EnrollmentAccountGet": { "$ref": "./examples/enrollmentAccountGet.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingPermissions": { "get": { "operationId": "BillingPermissions_ListByEnrollmentAccount", "tags": [ "BillingPermission" ], "description": "Lists the billing permissions the caller has for an enrollment account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPermissionsListByEnrollmentAccount": { "$ref": "./examples/billingPermissionsListByEnrollmentAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments": { "get": { "operationId": "BillingRoleAssignments_ListByEnrollmentAccount", "tags": [ "BillingRoleAssignment" ], "description": "Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentListByEnrollmentAccount": { "$ref": "./examples/billingRoleAssignmentListByEnrollmentAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "operationId": "BillingRoleAssignments_GetByEnrollmentAccount", "tags": [ "BillingRoleAssignment" ], "description": "Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentGetByEnrollmentAccount": { "$ref": "./examples/billingRoleAssignmentGetByEnrollmentAccount.json" } } }, "put": { "operationId": "BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount", "tags": [ "BillingRoleAssignment" ], "description": "Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" }, { "name": "parameters", "in": "body", "description": "The properties of the billing role assignment.", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignment" } } ], "responses": { "200": { "description": "Resource 'BillingRoleAssignment' update operation succeeded", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "201": { "description": "Resource 'BillingRoleAssignment' create operation succeeded", "schema": { "$ref": "#/definitions/BillingRoleAssignment" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount": { "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignment" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "BillingRoleAssignments_DeleteByEnrollmentAccount", "tags": [ "BillingRoleAssignment" ], "description": "Deletes a role assignment on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "billingRoleAssignmentName", "in": "path", "description": "The ID that uniquely identifies a role assignment.", "required": true, "type": "string", "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleAssignmentDeleteByEnrollmentAccount": { "$ref": "./examples/billingRoleAssignmentDeleteByEnrollmentAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions": { "get": { "operationId": "BillingRoleDefinition_ListByEnrollmentAccount", "tags": [ "BillingRoleDefinition" ], "description": "List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionListByEnrollmentAccount": { "$ref": "./examples/billingRoleDefinitionListByEnrollmentAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions/{roleDefinitionName}": { "get": { "operationId": "BillingRoleDefinition_GetByEnrollmentAccount", "tags": [ "BillingRoleDefinition" ], "description": "Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "roleDefinitionName", "in": "path", "description": "The ID that uniquely identifies a role definition.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRoleDefinitionGetByEnrollmentAccount": { "$ref": "./examples/billingRoleDefinitionGetByEnrollmentAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingSubscriptions": { "get": { "operationId": "BillingSubscriptions_ListByEnrollmentAccount", "tags": [ "BillingSubscription" ], "description": "Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingSubscriptionsListByEnrollmentAccount": { "$ref": "./examples/billingSubscriptionsListByEnrollmentAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/checkAccess": { "post": { "operationId": "BillingPermissions_CheckAccessByEnrollmentAccount", "tags": [ "BillingPermission" ], "description": "Provides a list of check access response objects for an enrollment account.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "enrollmentAccountName", "in": "path", "description": "The name of the enrollment account.", "required": true, "type": "string", "pattern": "^[a-zA-Z\\d-_]{1,128}$" }, { "name": "parameters", "in": "body", "description": "The request object against which access of the caller will be checked.", "required": true, "schema": { "$ref": "#/definitions/CheckAccessRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckAccessResponse" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CheckAccessByEnrollmentAccount": { "$ref": "./examples/checkAccessByEnrollmentAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices": { "get": { "operationId": "Invoices_ListByBillingAccount", "tags": [ "Invoice" ], "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "periodStartDate", "in": "query", "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "required": false, "type": "string", "format": "date" }, { "name": "periodEndDate", "in": "query", "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "required": false, "type": "string", "format": "date" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InvoiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesListByBillingAccount": { "$ref": "./examples/invoicesListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": { "get": { "operationId": "Invoices_GetByBillingAccount", "tags": [ "Invoice" ], "description": "Gets an invoice by billing account name and ID. The operation is supported for all billing account types.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Invoice" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesGetByBillingAccount": { "$ref": "./examples/invoicesGetByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/amend": { "post": { "operationId": "Invoices_Amend", "tags": [ "Invoice" ], "description": "Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesAmend": { "$ref": "./examples/invoicesAmend.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download": { "post": { "operationId": "Invoices_DownloadByBillingAccount", "tags": [ "Invoice" ], "description": "Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" }, { "name": "documentName", "in": "query", "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DocumentDownloadResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesDownloadByBillingAccount": { "$ref": "./examples/invoicesDownloadByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DocumentDownloadResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/downloadSummary": { "post": { "operationId": "Invoices_DownloadSummaryByBillingAccount", "tags": [ "Invoice" ], "description": "Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DocumentDownloadResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesDownloadSummaryByBillingAccount": { "$ref": "./examples/invoicesDownloadSummaryByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DocumentDownloadResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactionSummary": { "get": { "operationId": "Transactions_GetTransactionSummaryByInvoice", "tags": [ "Transaction" ], "description": "Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter the line items that are aggregated to create the line item summary.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "The search query option allows clients to filter the line items that are aggregated to create the line item summary.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransactionSummary" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransactionSummaryGetByInvoice": { "$ref": "./examples/transactionSummaryGetByInvoice.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions": { "get": { "operationId": "Transactions_ListByInvoice", "tags": [ "Transaction" ], "description": "Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransactionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransactionsListByInvoice": { "$ref": "./examples/transactionsListByInvoice.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactionsDownload": { "post": { "operationId": "Transactions_TransactionsDownloadByInvoice", "tags": [ "Transaction" ], "description": "Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DocumentDownloadResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TransactionsDownloadByInvoice": { "$ref": "./examples/transactionsDownloadByInvoice.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DocumentDownloadResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission": { "post": { "operationId": "BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission", "tags": [ "BillingAccount" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InvoiceSectionWithCreateSubPermissionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoiceSectionsWithCreateSubscriptionPermissionList": { "$ref": "./examples/invoiceSectionsWithCreateSubscriptionPermissionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods": { "get": { "operationId": "PaymentMethods_ListByBillingAccount", "tags": [ "PaymentMethods" ], "description": "Lists the payment methods available for a billing account. Along with the payment methods owned by the caller, these payment methods can be attached to a billing profile to make payments. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PaymentMethodsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PaymentMethodsListByBillingAccount": { "$ref": "./examples/paymentMethodsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods/{paymentMethodName}": { "get": { "operationId": "PaymentMethods_GetByBillingAccount", "tags": [ "PaymentMethods" ], "description": "Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string" }, { "name": "paymentMethodName", "in": "path", "description": "The ID that uniquely identifies a payment method.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PaymentMethod" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PaymentMethodGetAtBillingProfile": { "$ref": "./examples/paymentMethodsGetByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/policies/default": { "get": { "operationId": "Policies_GetByBillingAccount", "tags": [ "Policy" ], "description": "Get the policies for a billing account of Enterprise Agreement type.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingAccountPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesGetByBillingAccount": { "$ref": "./examples/policiesGetByBillingAccount.json" } } }, "put": { "operationId": "Policies_CreateOrUpdateByBillingAccount", "tags": [ "Policy" ], "description": "Update the policies for a billing account of Enterprise Agreement type.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "A policy at billing account scope.", "required": true, "schema": { "$ref": "#/definitions/BillingAccountPolicy" } } ], "responses": { "200": { "description": "Resource 'BillingAccountPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/BillingAccountPolicy" } }, "201": { "description": "Resource 'BillingAccountPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/BillingAccountPolicy" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesPutByBillingAccount": { "$ref": "./examples/policiesPutByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingAccountPolicy" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products": { "get": { "operationId": "Products_ListByBillingAccount", "tags": [ "Product" ], "description": "Lists the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProductListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductsListByBillingAccount": { "$ref": "./examples/productsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}": { "get": { "operationId": "Products_Get", "tags": [ "Product" ], "description": "Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "productName", "in": "path", "description": "The ID that uniquely identifies a product.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Product" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductsGet": { "$ref": "./examples/productsGet.json" } } }, "patch": { "operationId": "Products_Update", "tags": [ "Product" ], "description": "Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "productName", "in": "path", "description": "The ID that uniquely identifies a product.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "parameters", "in": "body", "description": "A product.", "required": true, "schema": { "$ref": "#/definitions/ProductPatch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Product" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductsUpdate": { "$ref": "./examples/productsUpdate.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/move": { "post": { "operationId": "Products_Move", "tags": [ "Product" ], "description": "Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "productName", "in": "path", "description": "The ID that uniquely identifies a product.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "parameters", "in": "body", "description": "The properties of the product to initiate a transfer.", "required": true, "schema": { "$ref": "#/definitions/MoveProductRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Product" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductMove": { "$ref": "./examples/productMove.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Product" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/validateMoveEligibility": { "post": { "operationId": "Products_ValidateMoveEligibility", "tags": [ "Product" ], "description": "Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "productName", "in": "path", "description": "The ID that uniquely identifies a product.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "parameters", "in": "body", "description": "The properties of the product to initiate a transfer.", "required": true, "schema": { "$ref": "#/definitions/MoveProductRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MoveProductEligibilityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ProductValidateMoveFailure": { "$ref": "./examples/productValidateMoveFailure.json" }, "ProductValidateMoveSuccess": { "$ref": "./examples/productValidateMoveSuccess.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders": { "get": { "operationId": "ReservationOrders_ListByBillingAccount", "tags": [ "ReservationOrders" ], "summary": "Get all `ReservationOrders in the billing account.", "description": "List all the ReservationOrders in the billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "skiptoken", "in": "query", "description": "The number of reservations to skip from the list before returning results", "required": false, "type": "number", "format": "float" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReservationOrderList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "reservationOrderListByBillingAccount": { "$ref": "./examples/reservationOrdersListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}": { "get": { "operationId": "ReservationOrders_GetByBillingAccount", "tags": [ "ReservationOrder" ], "summary": "Get a specific ReservationOrder in the billing account.", "description": "Get the details of the ReservationOrder in the billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "reservationOrderId", "in": "path", "description": "Order Id of the reservation", "required": true, "type": "string" }, { "name": "expand", "in": "query", "description": "May be used to expand the detail information of some properties.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReservationOrder" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "reservationOrderGetByBillingAccount": { "$ref": "./examples/reservationOrderGetByBillingAccount.json" }, "reservationOrderGetByBillingAccountWithExpandPlanInformation": { "$ref": "./examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations": { "get": { "operationId": "Reservations_ListByReservationOrder", "tags": [ "Reservations" ], "summary": "Get Reservations in a given reservation Order in the billing account", "description": "List Reservations within a single ReservationOrder in the billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "reservationOrderId", "in": "path", "description": "Order Id of the reservation", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReservationList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "reservationsGetFromOrderByBillingAccount": { "$ref": "./examples/reservationsGetFromOrderByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations/{reservationId}": { "get": { "operationId": "Reservations_GetByReservationOrder", "tags": [ "Reservation" ], "summary": "Get Reservation details in the billing account.", "description": "Get specific Reservation details in the billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "reservationOrderId", "in": "path", "description": "Order Id of the reservation", "required": true, "type": "string" }, { "name": "reservationId", "in": "path", "description": "Id of the reservation item", "required": true, "type": "string" }, { "name": "expand", "in": "query", "description": "May be used to expand the detail information of some properties.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Reservation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "reservationGetByBillingAccount": { "$ref": "./examples/reservationGetByBillingAccount.json" }, "reservationGetByBillingAccountManagementGroup": { "$ref": "./examples/reservationGetByBillingAccountManagementGroup.json" }, "reservationGetByBillingAccountSingleResourceGroup": { "$ref": "./examples/reservationGetByBillingAccountSingleResourceGroup.json" }, "reservationGetByBillingAccountSingleScope": { "$ref": "./examples/reservationGetByBillingAccountSingleScope.json" } } }, "patch": { "operationId": "Reservations_UpdateByBillingAccount", "tags": [ "Reservation" ], "description": "Update reservation by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "reservationOrderId", "in": "path", "description": "Order Id of the reservation", "required": true, "type": "string" }, { "name": "reservationId", "in": "path", "description": "Id of the reservation item", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body for patching a reservation", "required": true, "schema": { "$ref": "#/definitions/Patch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Reservation" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReservationUpdate": { "$ref": "./examples/reservationUpdateByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Reservation" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations": { "get": { "operationId": "Reservations_ListByBillingAccount", "tags": [ "Reservations" ], "description": "Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "skiptoken", "in": "query", "description": "The number of reservations to skip from the list before returning results", "required": false, "type": "number", "format": "float" }, { "name": "refreshSummary", "in": "query", "description": "To indicate whether to refresh the roll up counts of the reservations group by provisioning states", "required": false, "type": "string" }, { "name": "selectedState", "in": "query", "description": "The selected provisioning state", "required": false, "type": "string" }, { "name": "take", "in": "query", "description": "The number of reservations to return in API response.", "required": false, "type": "number", "format": "float" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReservationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "reservationsListByBillingAccount": { "$ref": "./examples/reservationsListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/resolveBillingRoleAssignments": { "post": { "operationId": "BillingRoleAssignments_ResolveByBillingAccount", "tags": [ "BillingRoleAssignment" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "resolveScopeDisplayNames", "in": "query", "description": "Resolves the scope display name for each of the role assignments.", "required": false, "type": "boolean", "default": false }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResolveBillingRoleAssignmentByBillingAccount": { "$ref": "./examples/resolveBillingRoleAssignmentByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRoleAssignmentListResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders": { "get": { "operationId": "SavingsPlanOrders_ListByBillingAccount", "tags": [ "Savings plan order" ], "description": "List all Savings plan orders by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "skiptoken", "in": "query", "description": "The number of savings plans to skip from the list before returning results", "required": false, "type": "number", "format": "float" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanOrderModelList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanOrderList": { "$ref": "./examples/savingsPlanOrderListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}": { "get": { "operationId": "SavingsPlanOrders_GetByBillingAccount", "tags": [ "Savings plan order" ], "description": "Get a savings plan order by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "expand", "in": "query", "description": "May be used to expand the planInformation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanOrderModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanOrderGet": { "$ref": "./examples/savingsPlanOrderGetByBillingAccount.json" }, "SavingsPlanOrderWithExpandedPaymentsGet": { "$ref": "./examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans": { "get": { "operationId": "SavingsPlans_ListBySavingsPlanOrder", "tags": [ "Savings plan" ], "description": "List savings plans in an order by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanModelList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlansInOrderList": { "$ref": "./examples/savingsPlansListBySavingsPlanOrders.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}": { "get": { "operationId": "SavingsPlans_GetByBillingAccount", "tags": [ "Savings plan" ], "description": "Get savings plan by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "ID of the savings plan", "required": true, "type": "string" }, { "name": "expand", "in": "query", "description": "May be used to expand the planInformation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanGet": { "$ref": "./examples/savingsPlanGetByBillingAccount.json" }, "SavingsPlanGetExpandRenewProperties": { "$ref": "./examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json" } } }, "patch": { "operationId": "SavingsPlans_UpdateByBillingAccount", "tags": [ "Savings plan" ], "description": "Update savings plan by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "ID of the savings plan", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body for patching a savings plan order alias", "required": true, "schema": { "$ref": "#/definitions/SavingsPlanUpdateRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanModel" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanUpdate": { "$ref": "./examples/savingsPlanUpdateByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/SavingsPlanModel" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate": { "post": { "operationId": "SavingsPlans_ValidateUpdateByBillingAccount", "tags": [ "Savings plan" ], "description": "Validate savings plan patch by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "ID of the savings plan", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body for patching a savings plan order alias", "required": true, "schema": { "$ref": "#/definitions/SavingsPlanUpdateValidateRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanValidateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanValidateUpdate": { "$ref": "./examples/savingsPlanValidateUpdateByBillingAccount.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans": { "get": { "operationId": "SavingsPlans_ListByBillingAccount", "tags": [ "Savings plan" ], "description": "List savings plans by billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "skiptoken", "in": "query", "description": "The number of savings plans to skip from the list before returning results", "required": false, "type": "number", "format": "float" }, { "name": "take", "in": "query", "description": "The number of savings plans to return", "required": false, "type": "number", "format": "float" }, { "name": "selectedState", "in": "query", "description": "The selected provisioning state", "required": false, "type": "string" }, { "name": "refreshSummary", "in": "query", "description": "To indicate whether to refresh the roll up counts of the savings plans group by provisioning states", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanModelListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlansList": { "$ref": "./examples/savingsPlansListByBillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/validatePaymentTerms": { "post": { "operationId": "BillingAccounts_ValidatePaymentTerms", "tags": [ "BillingAccount" ], "description": "Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The ID that uniquely identifies a billing account.", "required": true, "type": "string", "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$" }, { "name": "parameters", "in": "body", "description": "The properties of payment term.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentTerm" } } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PaymentTermsEligibilityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PaymentTermInvalid": { "$ref": "./examples/paymentTermInvalid.json" }, "PaymentTermValid": { "$ref": "./examples/paymentTermValid.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments": { "post": { "operationId": "Invoices_DownloadDocumentsByBillingSubscription", "tags": [ "Invoice" ], "description": "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.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "name": "subscriptionId", "in": "path", "description": "The ID that uniquely identifies a billing subscription.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "description": "A list of download details for individual documents.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/DocumentDownloadRequest" } } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DocumentDownloadResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesDownloadDocumentsByBillingSubscription": { "$ref": "./examples/invoicesDownloadDocumentsByBillingSubscription.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DocumentDownloadResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices": { "get": { "operationId": "Invoices_ListByBillingSubscription", "tags": [ "Invoice" ], "description": "Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "subscriptionId", "in": "path", "description": "The ID that uniquely identifies a billing subscription.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "periodStartDate", "in": "query", "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "required": false, "type": "string", "format": "date" }, { "name": "periodEndDate", "in": "query", "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "required": false, "type": "string", "format": "date" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InvoiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesListByBillingSubscription": { "$ref": "./examples/invoicesListByBillingSubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}": { "get": { "operationId": "Invoices_GetByBillingSubscription", "tags": [ "Invoice" ], "description": "Gets an invoice by subscription ID and invoice ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "subscriptionId", "in": "path", "description": "The ID that uniquely identifies a billing subscription.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Invoice" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesGetByBillingSubscription": { "$ref": "./examples/invoicesGetByBillingSubscription.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download": { "post": { "operationId": "Invoices_DownloadByBillingSubscription", "tags": [ "Invoice" ], "description": "Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "subscriptionId", "in": "path", "description": "The ID that uniquely identifies a billing subscription.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" }, { "name": "documentName", "in": "query", "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DocumentDownloadResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesDownloadByBillingSubscription": { "$ref": "./examples/invoicesDownloadByBillingSubscription.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DocumentDownloadResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}": { "get": { "operationId": "Invoices_Get", "tags": [ "Invoice" ], "description": "Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Invoice" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "InvoicesGet": { "$ref": "./examples/invoicesGet.json" } } } }, "/providers/Microsoft.Billing/billingRequests": { "get": { "operationId": "BillingRequests_ListByUser", "tags": [ "BillingRequest" ], "description": "The list of billing requests submitted by a user.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "filter", "in": "query", "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", "required": false, "type": "string" }, { "name": "orderBy", "in": "query", "description": "The orderby query option allows clients to request resources in a particular order.", "required": false, "type": "string" }, { "name": "top", "in": "query", "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", "required": false, "type": "integer", "format": "int64" }, { "name": "skip", "in": "query", "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", "required": false, "type": "integer", "format": "int64" }, { "name": "count", "in": "query", "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", "required": false, "type": "boolean" }, { "name": "search", "in": "query", "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRequestListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRequestsListByUser": { "$ref": "./examples/billingRequestsListByUser.json" }, "BillingRequestsListByUserWithFilter": { "$ref": "./examples/billingRequestsListByUserWithFilter.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingRequests/{billingRequestName}": { "get": { "operationId": "BillingRequests_Get", "tags": [ "BillingRequest" ], "description": "Gets a billing request by its ID.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingRequestName", "in": "path", "description": "The ID that uniquely identifies a billing request.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingRequest" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRequestsGet": { "$ref": "./examples/billingRequestsGet.json" } } }, "put": { "operationId": "BillingRequests_CreateOrUpdate", "tags": [ "BillingRequest" ], "description": "Create or update a billing request.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingRequestName", "in": "path", "description": "The ID that uniquely identifies a billing request.", "required": true, "type": "string", "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" }, { "name": "parameters", "in": "body", "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", "required": true, "schema": { "$ref": "#/definitions/BillingRequest" } } ], "responses": { "200": { "description": "Resource 'BillingRequest' update operation succeeded", "schema": { "$ref": "#/definitions/BillingRequest" } }, "201": { "description": "Resource 'BillingRequest' create operation succeeded", "schema": { "$ref": "#/definitions/BillingRequest" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingRequestsCreateOrUpdate": { "$ref": "./examples/billingRequestsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BillingRequest" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Billing/operations": { "get": { "operationId": "Operations_List", "tags": [ "ArmOperations" ], "description": "List of operations supported by provider.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "OperationsList": { "$ref": "./examples/operationsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/paymentMethods": { "get": { "operationId": "PaymentMethods_ListByUser", "tags": [ "PaymentMethods" ], "description": "Lists the payment methods owned by the caller.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PaymentMethodsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ListPaymentMethodOwnedByUser": { "$ref": "./examples/paymentMethodsListByUser.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/paymentMethods/{paymentMethodName}": { "get": { "operationId": "PaymentMethods_GetByUser", "tags": [ "PaymentMethods" ], "description": "Gets a payment method owned by the caller.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "paymentMethodName", "in": "path", "description": "The ID that uniquely identifies a payment method.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PaymentMethod" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GetPaymentMethodOwnedByUser": { "$ref": "./examples/paymentMethodsGetByUser.json" } } }, "delete": { "operationId": "PaymentMethods_DeleteByUser", "tags": [ "PaymentMethods" ], "description": "Deletes a payment method owned by the caller.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "paymentMethodName", "in": "path", "description": "The ID that uniquely identifies a payment method.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeletePaymentMethodOwnedByUser": { "$ref": "./examples/paymentMethodsDeleteByUser.json" } } } }, "/providers/Microsoft.Billing/transfers": { "get": { "operationId": "RecipientTransfers_List", "tags": [ "RecipientTransfers" ], "summary": "Lists the transfer requests received by the caller.", "description": "Lists the transfer requests received by the caller.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecipientTransferDetailsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RecipientTransfersList": { "$ref": "./examples/recipientTransfersList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/transfers/{transferName}": { "get": { "operationId": "RecipientTransfers_Get", "tags": [ "RecipientTransfers" ], "summary": "Gets a transfer request by ID. The caller must be the recipient of the transfer request.", "description": "Gets a transfer request by ID. The caller must be the recipient of the transfer request.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RecipientTransferGet": { "$ref": "./examples/recipientTransfersGet.json" } } } }, "/providers/Microsoft.Billing/transfers/{transferName}/accept": { "post": { "operationId": "RecipientTransfers_Accept", "tags": [ "RecipientTransfers" ], "summary": "Accepts a transfer request.", "description": "Accepts a transfer request.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" }, { "name": "parameters", "in": "body", "description": "Request parameters that are provided to the accept transfer operation.", "required": true, "schema": { "$ref": "#/definitions/AcceptTransferRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AcceptTransfer": { "$ref": "./examples/recipientTransfersAccept.json" } } } }, "/providers/Microsoft.Billing/transfers/{transferName}/decline": { "post": { "operationId": "RecipientTransfers_Decline", "tags": [ "RecipientTransfers" ], "summary": "Declines a transfer request.", "description": "Declines a transfer request.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeclineTransfer": { "$ref": "./examples/recipientTransfersDecline.json" } } } }, "/providers/Microsoft.Billing/transfers/{transferName}/validate": { "post": { "operationId": "RecipientTransfers_Validate", "tags": [ "RecipientTransfers" ], "summary": "Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.", "description": "Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "transferName", "in": "path", "description": "The ID that uniquely identifies a transfer request.", "required": true, "type": "string", "pattern": "^[a-z0-9]*$" }, { "name": "parameters", "in": "body", "description": "Request parameters that are provided to the validate transfer operation.", "required": true, "schema": { "$ref": "#/definitions/AcceptTransferRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ValidateTransferListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ValidateTransfer": { "$ref": "./examples/recipientTransfersValidate.json" } } } }, "/providers/Microsoft.Billing/validateAddress": { "post": { "operationId": "Address_Validate", "tags": [ "BillingAccount" ], "description": "Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/AddressDetails" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AddressValidationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AddressValidateInvalid": { "$ref": "./examples/addressValidateInvalid.json" }, "AddressValidateValid": { "$ref": "./examples/addressValidateValid.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default": { "get": { "operationId": "BillingProperty_Get", "tags": [ "BillingProperty" ], "description": "Gets the billing properties for a subscription", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "includeBillingCountry", "in": "query", "description": "A flag that specifies whether or not to include billing country.", "required": false, "type": "boolean", "default": false }, { "name": "includeTransitionStatus", "in": "query", "description": "A flag that specifies whether or not to include transition status for billing accounts with agreement type Microsoft Customer Agreement.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingProperty" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPropertyGetMCA": { "$ref": "./examples/billingPropertyGetMCA.json" }, "BillingPropertyGetMOSP": { "$ref": "./examples/billingPropertyGetMOSP.json" }, "BillingPropertyGetMPA": { "$ref": "./examples/billingPropertyGetMPA.json" } } }, "patch": { "operationId": "BillingProperty_Update", "tags": [ "BillingProperty" ], "description": "Updates the billing property of a subscription. Currently, cost center can be updated for billing accounts with agreement type Microsoft Customer Agreement and subscription service usage address can be updated for billing accounts with agreement type Microsoft Online Service Program.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "description": "A billing property.", "required": true, "schema": { "$ref": "#/definitions/BillingProperty" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BillingProperty" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingPropertyPatchCostCenter": { "$ref": "./examples/billingPropertyPatchCostCenter.json" }, "BillingPropertyPatchSubscriptionServiceUsageAddress": { "$ref": "./examples/billingPropertyPatchSubscriptionServiceUsageAddress.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/policies/default": { "get": { "operationId": "Policies_GetBySubscription", "tags": [ "Policy" ], "description": "Lists the policies that are managed by the Billing Admin for the defined subscriptions. This is supported for Microsoft Online Services Program, Microsoft Customer Agreement and Microsoft Partner Agreement.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SubscriptionPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PoliciesGetBySubscription": { "$ref": "./examples/policiesGetBySubscription.json" } } } } }, "definitions": { "AcceptTransferProperties": { "type": "object", "description": "Request parameters to accept transfer.", "properties": { "productDetails": { "type": "array", "description": "Request parameters to accept transfer.", "items": { "$ref": "#/definitions/ProductDetails" }, "x-ms-identifiers": [] } } }, "AcceptTransferRequest": { "type": "object", "description": "Request parameters to accept transfer.", "properties": { "properties": { "$ref": "#/definitions/AcceptTransferProperties", "description": "Request parameters to accept transfer.", "x-ms-client-flatten": true } } }, "AcceptanceMode": { "type": "string", "description": "The mode of acceptance for an agreement.", "enum": [ "Other", "ClickToAccept", "ESignEmbedded", "ESignOffline", "Implicit", "Offline", "PhysicalSign" ], "x-ms-enum": { "name": "AcceptanceMode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "ClickToAccept", "value": "ClickToAccept", "description": "ClickToAccept" }, { "name": "ESignEmbedded", "value": "ESignEmbedded", "description": "ESignEmbedded" }, { "name": "ESignOffline", "value": "ESignOffline", "description": "ESignOffline" }, { "name": "Implicit", "value": "Implicit", "description": "Implicit" }, { "name": "Offline", "value": "Offline", "description": "Offline" }, { "name": "PhysicalSign", "value": "PhysicalSign", "description": "PhysicalSign" } ] } }, "AccessDecision": { "type": "string", "description": "Access Decision, specifies access is allowed or not.", "enum": [ "Other", "Allowed", "NotAllowed" ], "x-ms-enum": { "name": "AccessDecision", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "AccountStatus": { "type": "string", "description": "The current status of the billing account.", "enum": [ "Other", "Active", "UnderReview", "Disabled", "Deleted", "Extended", "Pending", "New", "Expired", "Terminated", "Transferred" ], "x-ms-enum": { "name": "AccountStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "UnderReview", "value": "UnderReview", "description": "UnderReview" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "Extended", "value": "Extended", "description": "Extended" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "New", "value": "New", "description": "New" }, { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "Terminated", "value": "Terminated", "description": "Terminated" }, { "name": "Transferred", "value": "Transferred", "description": "Transferred" } ] } }, "AccountSubType": { "type": "string", "description": "The tier of the account.", "enum": [ "Other", "None", "Individual", "Professional", "Enterprise" ], "x-ms-enum": { "name": "AccountSubType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "None", "value": "None", "description": "None" }, { "name": "Individual", "value": "Individual", "description": "Individual" }, { "name": "Professional", "value": "Professional", "description": "Professional" }, { "name": "Enterprise", "value": "Enterprise", "description": "Enterprise" } ] } }, "AccountType": { "type": "string", "description": "The type of customer.", "enum": [ "Other", "Enterprise", "Individual", "Partner", "Reseller", "ClassicPartner", "Internal", "Tenant", "Business" ], "x-ms-enum": { "name": "AccountType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Enterprise", "value": "Enterprise", "description": "Enterprise" }, { "name": "Individual", "value": "Individual", "description": "Individual" }, { "name": "Partner", "value": "Partner", "description": "Partner" }, { "name": "Reseller", "value": "Reseller", "description": "Reseller" }, { "name": "ClassicPartner", "value": "ClassicPartner", "description": "ClassicPartner" }, { "name": "Internal", "value": "Internal", "description": "Internal" }, { "name": "Tenant", "value": "Tenant", "description": "Tenant" }, { "name": "Business", "value": "Business", "description": "Business" } ] } }, "AddressDetails": { "type": "object", "description": "Address details.", "properties": { "addressLine1": { "type": "string", "description": "Address line 1.", "minLength": 1 }, "addressLine2": { "type": "string", "description": "Address line 2." }, "addressLine3": { "type": "string", "description": "Address line 3." }, "city": { "type": "string", "description": "Address city." }, "companyName": { "type": "string", "description": "Company name. Optional for MCA Individual (Pay-as-you-go)." }, "country": { "type": "string", "description": "Country code uses ISO 3166-1 Alpha-2 format.", "minLength": 1 }, "district": { "type": "string", "description": "Address district." }, "email": { "type": "string", "description": "Email address." }, "firstName": { "type": "string", "description": "First name. Optional for MCA Enterprise." }, "lastName": { "type": "string", "description": "Last name. Optional for MCA Enterprise." }, "middleName": { "type": "string", "description": "Middle name." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "postalCode": { "type": "string", "description": "Postal code." }, "region": { "type": "string", "description": "Address region." }, "isValidAddress": { "type": "boolean", "description": "Indicates if the address is incomplete." } }, "required": [ "addressLine1", "country" ] }, "AddressValidationResponse": { "type": "object", "description": "Result of the address validation.", "properties": { "status": { "$ref": "#/definitions/AddressValidationStatus", "description": "Status of the address validation.", "readOnly": true }, "suggestedAddresses": { "type": "array", "description": "The list of suggested addresses.", "items": { "$ref": "#/definitions/AddressDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "validationMessage": { "type": "string", "description": "Validation error message.", "readOnly": true } } }, "AddressValidationStatus": { "type": "string", "description": "Status of the address validation.", "enum": [ "Other", "Valid", "Invalid" ], "x-ms-enum": { "name": "AddressValidationStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Valid", "value": "Valid", "description": "Valid" }, { "name": "Invalid", "value": "Invalid", "description": "Invalid" } ] } }, "Agreement": { "type": "object", "description": "An agreement.", "properties": { "properties": { "$ref": "#/definitions/AgreementProperties", "description": "An agreement." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "AgreementListResult": { "type": "object", "description": "Paged collection of Agreement items", "properties": { "value": { "type": "array", "description": "The Agreement items on this page", "items": { "$ref": "#/definitions/Agreement" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AgreementProperties": { "type": "object", "description": "An agreement.", "properties": { "acceptanceMode": { "$ref": "#/definitions/AcceptanceMode", "description": "The mode of acceptance for an agreement.", "readOnly": true }, "agreementLink": { "type": "string", "description": "The URL to download the agreement.", "readOnly": true }, "billingProfileInfo": { "type": "array", "description": "The list of billing profiles associated with agreement and present only for specific agreements.", "items": { "$ref": "#/definitions/BillingProfileInfo" }, "readOnly": true, "x-ms-identifiers": [] }, "category": { "$ref": "#/definitions/Category", "description": "The category of the agreement.", "readOnly": true }, "displayName": { "type": "string", "description": "The name of the agreement signed by a customer.", "readOnly": true }, "effectiveDate": { "type": "string", "format": "date-time", "description": "The date from which the agreement is effective.", "readOnly": true }, "expirationDate": { "type": "string", "format": "date-time", "description": "The date when the agreement expires.", "readOnly": true }, "participants": { "type": "array", "description": "The list of participants that participates in acceptance of an agreement.", "items": { "$ref": "#/definitions/Participant" }, "readOnly": true, "x-ms-identifiers": [] }, "status": { "type": "string", "description": "The current status of the agreement.", "readOnly": true }, "leadBillingAccountName": { "type": "string", "description": "The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms.", "readOnly": true } } }, "AgreementType": { "type": "string", "description": "The type of agreement.", "enum": [ "Other", "MicrosoftCustomerAgreement", "EnterpriseAgreement", "MicrosoftOnlineServicesProgram", "MicrosoftPartnerAgreement" ], "x-ms-enum": { "name": "AgreementType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "MicrosoftCustomerAgreement", "value": "MicrosoftCustomerAgreement", "description": "MicrosoftCustomerAgreement" }, { "name": "EnterpriseAgreement", "value": "EnterpriseAgreement", "description": "EnterpriseAgreement" }, { "name": "MicrosoftOnlineServicesProgram", "value": "MicrosoftOnlineServicesProgram", "description": "MicrosoftOnlineServicesProgram" }, { "name": "MicrosoftPartnerAgreement", "value": "MicrosoftPartnerAgreement", "description": "MicrosoftPartnerAgreement" } ] } }, "Amount": { "type": "object", "description": "The amount.", "properties": { "currency": { "type": "string", "description": "The currency for the amount value.", "readOnly": true }, "value": { "type": "number", "format": "float", "description": "The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.", "readOnly": true } } }, "AppliedScopeProperties": { "type": "object", "description": "Properties specific to applied scope type. Not required if not applicable.", "properties": { "tenantId": { "type": "string", "description": "Tenant ID where the savings plan where the benefit is applied." }, "managementGroupId": { "type": "string", "description": "Fully-qualified identifier of the management group where the benefit is applied." }, "subscriptionId": { "type": "string", "description": "Fully-qualified identifier of the subscription where the benefit is applied." }, "resourceGroupId": { "type": "string", "description": "Fully-qualified identifier of the resource group where the benefit is applied." }, "displayName": { "type": "string", "description": "Display name" } } }, "AppliedScopeType": { "type": "string", "description": "Type of the Applied Scope.", "enum": [ "Single", "Shared", "ManagementGroup" ], "x-ms-enum": { "name": "AppliedScopeType", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single" }, { "name": "Shared", "value": "Shared", "description": "Shared" }, { "name": "ManagementGroup", "value": "ManagementGroup", "description": "ManagementGroup" } ] } }, "AssociatedTenant": { "type": "object", "description": "An associated tenant.", "properties": { "properties": { "$ref": "#/definitions/AssociatedTenantProperties", "description": "An associated tenant." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "AssociatedTenantListResult": { "type": "object", "description": "Paged collection of AssociatedTenant items", "properties": { "value": { "type": "array", "description": "The AssociatedTenant items on this page", "items": { "$ref": "#/definitions/AssociatedTenant" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AssociatedTenantProperties": { "type": "object", "description": "An associated tenant.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "displayName": { "type": "string", "description": "The name of the associated tenant." }, "tenantId": { "type": "string", "description": "The ID that uniquely identifies a tenant." }, "billingManagementState": { "$ref": "#/definitions/BillingManagementTenantState", "description": "The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases." }, "provisioningManagementState": { "$ref": "#/definitions/ProvisioningTenantState", "description": "The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request." }, "provisioningBillingRequestId": { "type": "string", "description": "The unique identifier for the billing request that is created when enabling provisioning for an associated tenant.", "readOnly": true } } }, "AutoRenew": { "type": "string", "description": "Indicates whether auto renewal is turned on or off for a product.", "enum": [ "Off", "On" ], "x-ms-enum": { "name": "AutoRenew", "modelAsString": true, "values": [ { "name": "Off", "value": "Off", "description": "Off" }, { "name": "On", "value": "On", "description": "On" } ] } }, "AvailableBalance": { "type": "object", "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", "properties": { "properties": { "$ref": "#/definitions/AvailableBalanceProperties", "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "AvailableBalanceProperties": { "type": "object", "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", "properties": { "amount": { "$ref": "#/definitions/AvailableBalancePropertiesAmount", "description": "Credit amount for immediate payment." }, "paymentsOnAccount": { "type": "array", "description": "The list of payments on accounts.", "items": { "$ref": "#/definitions/PaymentOnAccount" }, "readOnly": true, "x-ms-identifiers": [] }, "totalPaymentsOnAccount": { "$ref": "#/definitions/AvailableBalancePropertiesTotalPaymentsOnAccount", "description": "Total amount of payments on accounts." } } }, "AvailableBalancePropertiesAmount": { "type": "object", "description": "Credit amount for immediate payment.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "AvailableBalancePropertiesTotalPaymentsOnAccount": { "type": "object", "description": "Total amount of payments on accounts.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "AzurePlan": { "type": "object", "description": "Details of the Azure plan.", "properties": { "productId": { "type": "string", "description": "The ID that uniquely identifies a product." }, "skuId": { "type": "string", "description": "The ID that uniquely identifies a sku." }, "skuDescription": { "type": "string", "description": "The sku description." } } }, "Beneficiary": { "type": "object", "description": "Details of the beneficiary.", "properties": { "tenantId": { "type": "string", "description": "The ID that uniquely identifies a tenant." }, "objectId": { "type": "string", "description": "The ID that uniquely identifies a user in a tenant." } } }, "BillingAccount": { "type": "object", "description": "A billing account.", "properties": { "properties": { "$ref": "#/definitions/BillingAccountProperties", "description": "A billing account." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingAccountListResult": { "type": "object", "description": "Paged collection of BillingAccount items", "properties": { "value": { "type": "array", "description": "The BillingAccount items on this page", "items": { "$ref": "#/definitions/BillingAccount" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BillingAccountPatch": { "type": "object", "description": "A billing account.", "properties": { "properties": { "$ref": "#/definitions/BillingAccountProperties", "description": "A billing account." } }, "allOf": [ { "$ref": "#/definitions/ProxyResourceWithTags" } ] }, "BillingAccountPolicy": { "type": "object", "description": "A policy at billing account scope.", "properties": { "properties": { "$ref": "#/definitions/BillingAccountPolicyProperties", "description": "A policy at billing account scope." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingAccountPolicyProperties": { "type": "object", "description": "A policy at billing account scope.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "enterpriseAgreementPolicies": { "$ref": "#/definitions/BillingAccountPolicyPropertiesEnterpriseAgreementPolicies", "description": "The policies for Enterprise Agreement enrollments." }, "marketplacePurchases": { "$ref": "#/definitions/MarketplacePurchasesPolicy", "description": "The policy that controls whether Azure marketplace purchases are allowed." }, "reservationPurchases": { "$ref": "#/definitions/ReservationPurchasesPolicy", "description": "The policy that controls whether Azure reservation purchases are allowed." }, "savingsPlanPurchases": { "$ref": "#/definitions/SavingsPlanPurchasesPolicy", "description": "The policy that controls whether users with Azure savings plan purchase are allowed." }, "policies": { "type": "array", "description": "List of all policies defined at the billing scope.", "items": { "$ref": "#/definitions/PolicySummary" }, "x-ms-identifiers": [ "name" ] } } }, "BillingAccountPolicyPropertiesEnterpriseAgreementPolicies": { "type": "object", "description": "The policies for Enterprise Agreement enrollments.", "allOf": [ { "$ref": "#/definitions/EnterpriseAgreementPolicies" } ] }, "BillingAccountProperties": { "type": "object", "description": "A billing account.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "accountStatus": { "$ref": "#/definitions/AccountStatus", "description": "The current status of the billing account.", "readOnly": true }, "accountType": { "$ref": "#/definitions/AccountType", "description": "The type of customer.", "readOnly": true }, "accountSubType": { "$ref": "#/definitions/AccountSubType", "description": "The tier of the account.", "readOnly": true }, "accountStatusReasonCode": { "$ref": "#/definitions/BillingAccountStatusReasonCode", "description": "Reason for the specified billing account status.", "readOnly": true }, "agreementType": { "$ref": "#/definitions/AgreementType", "description": "The type of agreement.", "readOnly": true }, "displayName": { "type": "string", "description": "The billing account name." }, "enrollmentDetails": { "$ref": "#/definitions/BillingAccountPropertiesEnrollmentDetails", "description": "The properties of an enrollment." }, "hasReadAccess": { "type": "boolean", "description": "Indicates whether user has read access to the billing account." }, "hasNoBillingProfiles": { "type": "boolean", "description": "Indicates whether or not the billing account has any billing profiles." }, "notificationEmailAddress": { "type": "string", "description": "Notification email address for legacy account. Available for agreement type Microsoft Online Services Program." }, "primaryBillingTenantId": { "type": "string", "description": "The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant." }, "soldTo": { "$ref": "#/definitions/BillingAccountPropertiesSoldTo", "description": "The address of the individual or organization that is responsible for the billing account." }, "registrationNumber": { "$ref": "#/definitions/BillingAccountPropertiesRegistrationNumber", "description": "Describes the registration number of the organization linked with the billing account." }, "billingRelationshipTypes": { "type": "array", "description": "Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party.", "items": { "$ref": "#/definitions/BillingRelationshipType" }, "readOnly": true }, "qualifications": { "type": "array", "description": "Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government.", "items": { "type": "string" }, "readOnly": true }, "taxIds": { "type": "array", "description": "A list of tax identifiers for the billing account.", "items": { "$ref": "#/definitions/TaxIdentifier" }, "x-ms-identifiers": [] } } }, "BillingAccountPropertiesEnrollmentDetails": { "type": "object", "description": "The properties of an enrollment.", "allOf": [ { "$ref": "#/definitions/EnrollmentDetails" } ] }, "BillingAccountPropertiesRegistrationNumber": { "type": "object", "description": "Describes the registration number of the organization linked with the billing account.", "allOf": [ { "$ref": "#/definitions/RegistrationNumber" } ] }, "BillingAccountPropertiesSoldTo": { "type": "object", "description": "The address of the individual or organization that is responsible for the billing account.", "allOf": [ { "$ref": "#/definitions/AddressDetails" } ] }, "BillingAccountStatusReasonCode": { "type": "string", "description": "Reason for the specified billing account status.", "enum": [ "Other", "UnusualActivity", "ManuallyTerminated", "Expired", "Transferred", "TerminateProcessing" ], "x-ms-enum": { "name": "BillingAccountStatusReasonCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "UnusualActivity", "value": "UnusualActivity", "description": "UnusualActivity" }, { "name": "ManuallyTerminated", "value": "ManuallyTerminated", "description": "ManuallyTerminated" }, { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "Transferred", "value": "Transferred", "description": "Transferred" }, { "name": "TerminateProcessing", "value": "TerminateProcessing", "description": "TerminateProcessing" } ] } }, "BillingManagementTenantState": { "type": "string", "description": "The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases.", "enum": [ "Other", "NotAllowed", "Active", "Revoked" ], "x-ms-enum": { "name": "BillingManagementTenantState", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Revoked", "value": "Revoked", "description": "Revoked" } ] } }, "BillingPermission": { "type": "object", "description": "The set of allowed action and not allowed actions a caller has on a resource.", "properties": { "actions": { "type": "array", "description": "The set of actions that the caller is allowed to perform.", "items": { "type": "string" }, "readOnly": true }, "notActions": { "type": "array", "description": "The set of actions that the caller is not allowed to perform.", "items": { "type": "string" }, "readOnly": true } } }, "BillingPermissionListResult": { "type": "object", "description": "A container for a list of resources", "properties": { "value": { "type": "array", "description": "The BillingPermission items on this page", "items": { "$ref": "#/definitions/BillingPermission" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BillingPlan": { "type": "string", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly purchases.", "enum": [ "P1M" ], "x-ms-enum": { "name": "BillingPlan", "modelAsString": true, "values": [ { "name": "P1M", "value": "P1M", "description": "P1M" } ] } }, "BillingPlanInformation": { "type": "object", "description": "Information describing the type of billing plan for this savings plan.", "properties": { "pricingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount of money to be paid for the Order. Tax is not included." }, "startDate": { "type": "string", "format": "date", "description": "Date when the billing plan has started." }, "nextPaymentDueDate": { "type": "string", "format": "date", "description": "For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off." }, "transactions": { "type": "array", "items": { "$ref": "#/definitions/PaymentDetail" }, "x-ms-identifiers": [] } } }, "BillingProfile": { "type": "object", "description": "A billing profile.", "properties": { "properties": { "$ref": "#/definitions/BillingProfileProperties", "description": "A billing profile." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingProfileInfo": { "type": "object", "description": "Details about billing profile associated with agreement and available only for specific agreements.", "properties": { "billingAccountId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing account." }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile." }, "billingProfileId": { "type": "string", "description": "The friendly ID that uniquely identifies a billing profile." }, "billingProfileSystemId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile." }, "indirectRelationshipOrganizationName": { "type": "string", "description": "Billing account name. Available for a specific type of agreement." } } }, "BillingProfileListResult": { "type": "object", "description": "Paged collection of BillingProfile items", "properties": { "value": { "type": "array", "description": "The BillingProfile items on this page", "items": { "$ref": "#/definitions/BillingProfile" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BillingProfilePolicy": { "type": "object", "description": "A policy at billing profile scope.", "properties": { "properties": { "$ref": "#/definitions/BillingProfilePolicyProperties", "description": "A policy at billing profile scope." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingProfilePolicyProperties": { "type": "object", "description": "A policy at billing profile scope.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "enterpriseAgreementPolicies": { "$ref": "#/definitions/BillingProfilePolicyPropertiesEnterpriseAgreementPolicies", "description": "The policies for Enterprise Agreement enrollments." }, "invoiceSectionLabelManagement": { "$ref": "#/definitions/InvoiceSectionLabelManagementPolicy", "description": "The policy that controls invoice section label management at invoice section scope. This is allowed by default." }, "marketplacePurchases": { "$ref": "#/definitions/MarketplacePurchasesPolicy", "description": "The policy that controls whether Azure marketplace purchases are allowed." }, "reservationPurchases": { "$ref": "#/definitions/ReservationPurchasesPolicy", "description": "The policy that controls whether Azure reservation purchases are allowed." }, "savingsPlanPurchases": { "$ref": "#/definitions/SavingsPlanPurchasesPolicy", "description": "The policy that controls whether users with Azure savings plan purchase are allowed." }, "viewCharges": { "$ref": "#/definitions/ViewChargesPolicy", "description": "The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices." }, "policies": { "type": "array", "description": "List of all policies defined at the billing scope.", "items": { "$ref": "#/definitions/PolicySummary" }, "x-ms-identifiers": [ "name" ] } } }, "BillingProfilePolicyPropertiesEnterpriseAgreementPolicies": { "type": "object", "description": "The policies for Enterprise Agreement enrollments.", "allOf": [ { "$ref": "#/definitions/EnterpriseAgreementPolicies" } ] }, "BillingProfileProperties": { "type": "object", "description": "A billing profile.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "billingRelationshipType": { "$ref": "#/definitions/BillingRelationshipType", "description": "Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.", "readOnly": true }, "billTo": { "$ref": "#/definitions/BillingProfilePropertiesBillTo", "description": "Billing address." }, "currency": { "type": "string", "description": "The currency in which the charges for the billing profile are billed.", "readOnly": true }, "displayName": { "type": "string", "description": "The name of the billing profile." }, "enabledAzurePlans": { "type": "array", "description": "Information about the enabled azure plans.", "items": { "$ref": "#/definitions/AzurePlan" }, "x-ms-identifiers": [] }, "hasReadAccess": { "type": "boolean", "description": "Indicates whether user has read access to the billing profile.", "readOnly": true }, "indirectRelationshipInfo": { "$ref": "#/definitions/BillingProfilePropertiesIndirectRelationshipInfo", "description": "Identifies the billing profile that is linked to another billing profile in indirect purchase motion." }, "invoiceDay": { "type": "integer", "format": "int32", "description": "The day of the month when the invoice for the billing profile is generated.", "readOnly": true }, "invoiceEmailOptIn": { "type": "boolean", "description": "Flag controlling whether the invoices for the billing profile are sent through email." }, "invoiceRecipients": { "type": "array", "description": "The list of email addresses to receive invoices by email for the billing profile.", "items": { "type": "string" } }, "poNumber": { "type": "string", "description": "The default purchase order number that will appear on the invoices generated for the billing profile." }, "shipTo": { "$ref": "#/definitions/BillingProfilePropertiesShipTo", "description": "The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used." }, "soldTo": { "$ref": "#/definitions/BillingProfilePropertiesSoldTo", "description": "The address of the individual or organization that is responsible for the billing account." }, "spendingLimit": { "$ref": "#/definitions/SpendingLimit", "description": "The billing profile spending limit.", "readOnly": true }, "spendingLimitDetails": { "type": "array", "description": "The details of billing profile spending limit.", "items": { "$ref": "#/definitions/SpendingLimitDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "status": { "$ref": "#/definitions/BillingProfileStatus", "description": "The status of the billing profile.", "readOnly": true }, "statusReasonCode": { "$ref": "#/definitions/BillingProfileStatusReasonCode", "description": "Reason for the specified billing profile status.", "readOnly": true }, "systemId": { "type": "string", "description": "The system generated unique identifier for a billing profile.", "readOnly": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } }, "targetClouds": { "type": "array", "description": "Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds.", "items": { "type": "string" }, "readOnly": true }, "currentPaymentTerm": { "$ref": "#/definitions/BillingProfilePropertiesCurrentPaymentTerm", "description": "The current payment term of the billing profile." }, "otherPaymentTerms": { "type": "array", "description": "The other payment terms of the billing profile.", "items": { "$ref": "#/definitions/PaymentTerm" }, "readOnly": true, "x-ms-identifiers": [] } } }, "BillingProfilePropertiesBillTo": { "type": "object", "description": "Billing address.", "allOf": [ { "$ref": "#/definitions/AddressDetails" } ] }, "BillingProfilePropertiesCurrentPaymentTerm": { "type": "object", "description": "The current payment term of the billing profile.", "allOf": [ { "$ref": "#/definitions/PaymentTerm" } ] }, "BillingProfilePropertiesIndirectRelationshipInfo": { "type": "object", "description": "Identifies the billing profile that is linked to another billing profile in indirect purchase motion.", "allOf": [ { "$ref": "#/definitions/IndirectRelationshipInfo" } ] }, "BillingProfilePropertiesShipTo": { "type": "object", "description": "The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used.", "allOf": [ { "$ref": "#/definitions/AddressDetails" } ] }, "BillingProfilePropertiesSoldTo": { "type": "object", "description": "The address of the individual or organization that is responsible for the billing account.", "allOf": [ { "$ref": "#/definitions/AddressDetails" } ] }, "BillingProfileStatus": { "type": "string", "description": "The status of the billing profile.", "enum": [ "Other", "Active", "Disabled", "Warned", "Deleted", "UnderReview" ], "x-ms-enum": { "name": "BillingProfileStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Warned", "value": "Warned", "description": "Warned" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "UnderReview", "value": "UnderReview", "description": "UnderReview" } ] } }, "BillingProfileStatusReasonCode": { "type": "string", "description": "Reason for the specified billing profile status.", "enum": [ "Other", "PastDue", "UnusualActivity", "SpendingLimitReached", "SpendingLimitExpired" ], "x-ms-enum": { "name": "BillingProfileStatusReasonCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "PastDue", "value": "PastDue", "description": "PastDue" }, { "name": "UnusualActivity", "value": "UnusualActivity", "description": "UnusualActivity" }, { "name": "SpendingLimitReached", "value": "SpendingLimitReached", "description": "SpendingLimitReached" }, { "name": "SpendingLimitExpired", "value": "SpendingLimitExpired", "description": "SpendingLimitExpired" } ] } }, "BillingProperty": { "type": "object", "description": "A billing property.", "properties": { "properties": { "$ref": "#/definitions/BillingPropertyProperties", "description": "A billing property." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingPropertyProperties": { "type": "object", "description": "A billing property.", "properties": { "billingAccountAgreementType": { "$ref": "#/definitions/AgreementType", "description": "The type of agreement.", "readOnly": true }, "billingAccountDisplayName": { "type": "string", "description": "The name of the billing account.", "readOnly": true }, "billingAccountId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing account.", "readOnly": true }, "accountAdminNotificationEmailAddress": { "type": "string", "description": "Notification email address for legacy account. Available for agreement type Microsoft Online Services Program.", "readOnly": true }, "billingAccountSoldToCountry": { "type": "string", "description": "The country of the individual or organization that is responsible for the billing account.", "readOnly": true }, "billingAccountStatus": { "$ref": "#/definitions/AccountStatus", "description": "The current status of the billing account.", "readOnly": true }, "billingAccountStatusReasonCode": { "$ref": "#/definitions/BillingAccountStatusReasonCode", "description": "Reason for the specified billing account status.", "readOnly": true }, "billingAccountType": { "$ref": "#/definitions/AccountType", "description": "The type of customer.", "readOnly": true }, "billingAccountSubType": { "$ref": "#/definitions/AccountSubType", "description": "The tier of the account.", "readOnly": true }, "billingCurrency": { "type": "string", "description": "The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement", "readOnly": true }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile.", "readOnly": true }, "billingProfileSpendingLimit": { "$ref": "#/definitions/SpendingLimit", "description": "The billing profile spending limit.", "readOnly": true }, "billingProfileSpendingLimitDetails": { "type": "array", "description": "The details of billing profile spending limit.", "items": { "$ref": "#/definitions/SpendingLimitDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "billingProfileStatus": { "$ref": "#/definitions/BillingProfileStatus", "description": "The status of the billing profile.", "readOnly": true }, "billingProfileStatusReasonCode": { "$ref": "#/definitions/BillingProfileStatusReasonCode", "description": "Reason for the specified billing profile status.", "readOnly": true }, "billingProfilePaymentMethodFamily": { "$ref": "#/definitions/PaymentMethodFamily", "description": "The payment method family of the primary payment method for the billing profile.", "readOnly": true }, "billingProfilePaymentMethodType": { "type": "string", "description": "The payment method type of the primary payment method for the billing profile.", "readOnly": true }, "billingTenantId": { "type": "string", "description": "The Azure AD tenant ID of the billing account for the subscription.", "readOnly": true }, "costCenter": { "type": "string", "description": "The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch." }, "customerDisplayName": { "type": "string", "description": "The name of the customer.", "readOnly": true }, "customerId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a customer.", "readOnly": true }, "customerStatus": { "$ref": "#/definitions/CustomerStatus", "description": "Identifies the status of an customer. This is an upcoming property that will be populated in the future.", "readOnly": true }, "invoiceSectionDisplayName": { "type": "string", "description": "The name of the invoice section.", "readOnly": true }, "invoiceSectionId": { "type": "string", "description": "The fully qualified ID that uniquely identifies an invoice section.", "readOnly": true }, "invoiceSectionStatus": { "$ref": "#/definitions/InvoiceSectionState", "description": "Identifies the status of an invoice section.", "readOnly": true }, "invoiceSectionStatusReasonCode": { "$ref": "#/definitions/InvoiceSectionStateReasonCode", "description": "Reason for the specified invoice section status.", "readOnly": true }, "isTransitionedBillingAccount": { "type": "boolean", "description": "Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account.", "readOnly": true }, "skuDescription": { "type": "string", "description": "The sku description.", "readOnly": true }, "skuId": { "type": "string", "description": "The ID that uniquely identifies a sku.", "readOnly": true }, "subscriptionBillingStatus": { "$ref": "#/definitions/BillingSubscriptionStatus", "description": "The subscription status.", "readOnly": true }, "subscriptionBillingStatusDetails": { "type": "array", "description": "The reason codes for the subscription status.", "items": { "$ref": "#/definitions/BillingSubscriptionStatusDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "subscriptionBillingType": { "$ref": "#/definitions/SubscriptionBillingType", "description": "The type of billing subscription.", "readOnly": true }, "subscriptionServiceUsageAddress": { "$ref": "#/definitions/BillingPropertyPropertiesSubscriptionServiceUsageAddress", "description": "The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch." }, "subscriptionWorkloadType": { "$ref": "#/definitions/SubscriptionWorkloadType", "description": "The Azure workload type of the subscription.", "readOnly": true }, "enrollmentDetails": { "$ref": "#/definitions/BillingPropertyPropertiesEnrollmentDetails", "description": "The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement." }, "isAccountAdmin": { "type": "boolean", "description": "Indicates whether user is the account admin.", "readOnly": true }, "productId": { "type": "string", "description": "The ID that uniquely identifies a product.", "readOnly": true }, "productName": { "type": "string", "description": "The ID that uniquely identifies a product.", "readOnly": true } } }, "BillingPropertyPropertiesEnrollmentDetails": { "type": "object", "description": "The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.", "allOf": [ { "$ref": "#/definitions/SubscriptionEnrollmentDetails" } ] }, "BillingPropertyPropertiesSubscriptionServiceUsageAddress": { "type": "object", "description": "The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch.", "allOf": [ { "$ref": "#/definitions/AddressDetails" } ] }, "BillingRelationshipType": { "type": "string", "description": "Identifies the billing relationships represented by a billing account or billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.", "enum": [ "Other", "Direct", "IndirectCustomer", "IndirectPartner", "CSPPartner", "CSPCustomer" ], "x-ms-enum": { "name": "BillingRelationshipType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Direct", "value": "Direct", "description": "Direct" }, { "name": "IndirectCustomer", "value": "IndirectCustomer", "description": "IndirectCustomer" }, { "name": "IndirectPartner", "value": "IndirectPartner", "description": "IndirectPartner" }, { "name": "CSPPartner", "value": "CSPPartner", "description": "CSPPartner" }, { "name": "CSPCustomer", "value": "CSPCustomer", "description": "CSPCustomer" } ] } }, "BillingRequest": { "type": "object", "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", "properties": { "properties": { "$ref": "#/definitions/BillingRequestProperties", "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingRequestListResult": { "type": "object", "description": "Paged collection of BillingRequest items", "properties": { "value": { "type": "array", "description": "The BillingRequest items on this page", "items": { "$ref": "#/definitions/BillingRequest" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BillingRequestProperties": { "type": "object", "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "additionalInformation": { "type": "object", "description": "Additional information for the billing request.", "additionalProperties": { "type": "string" } }, "reviewedBy": { "$ref": "#/definitions/BillingRequestPropertiesReviewedBy", "description": "The principal of the request reviewer. Will only be set if request is approved." }, "reviewalDate": { "type": "string", "format": "date-time", "description": "The date and time when the request was reviewed.", "readOnly": true }, "billingAccountId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing account.", "readOnly": true }, "billingAccountName": { "type": "string", "description": "The ID that uniquely identifies a billing account.", "readOnly": true }, "billingAccountDisplayName": { "type": "string", "description": "The name of the billing account.", "readOnly": true }, "billingAccountPrimaryBillingTenantId": { "type": "string", "description": "The primary tenant ID of the billing account for which the billing request was submitted.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile.", "readOnly": true }, "billingProfileName": { "type": "string", "description": "The ID that uniquely identifies a billing profile.", "readOnly": true }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile.", "readOnly": true }, "createdBy": { "$ref": "#/definitions/BillingRequestPropertiesCreatedBy", "description": "The principal of the entity who created the request." }, "creationDate": { "type": "string", "format": "date-time", "description": "The date and time when the request was created.", "readOnly": true }, "expirationDate": { "type": "string", "format": "date-time", "description": "The date and time when the request expires.", "readOnly": true }, "decisionReason": { "type": "string", "description": "The reason to approve or decline the request." }, "invoiceSectionId": { "type": "string", "description": "The fully qualified ID that uniquely identifies an invoice section.", "readOnly": true }, "invoiceSectionName": { "type": "string", "description": "The ID that uniquely identifies an invoice section.", "readOnly": true }, "invoiceSectionDisplayName": { "type": "string", "description": "The name of the invoice section.", "readOnly": true }, "customerId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a customer.", "readOnly": true }, "customerName": { "type": "string", "description": "The ID that uniquely identifies a customer.", "readOnly": true }, "customerDisplayName": { "type": "string", "description": "The name of the customer.", "readOnly": true }, "subscriptionId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing subscription.", "readOnly": true }, "subscriptionName": { "type": "string", "description": "The ID that uniquely identifies a billing subscription.", "readOnly": true }, "subscriptionDisplayName": { "type": "string", "description": "The name of the billing subscription.", "readOnly": true }, "justification": { "type": "string", "description": "Justification for submitting request." }, "recipients": { "type": "array", "description": "The recipients of the billing request.", "items": { "$ref": "#/definitions/Principal" }, "x-ms-identifiers": [] }, "requestScope": { "type": "string", "description": "The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}')." }, "billingScope": { "type": "string", "description": "The billing scope for which the request will be applied. This is a read only property derived by the service.", "readOnly": true }, "status": { "$ref": "#/definitions/BillingRequestStatus", "description": "Status of billing request." }, "type": { "$ref": "#/definitions/BillingRequestType", "description": "Type of billing request." }, "lastUpdatedBy": { "$ref": "#/definitions/BillingRequestPropertiesLastUpdatedBy", "description": "The principal of the entity who last updated the request." }, "lastUpdatedDate": { "type": "string", "format": "date-time", "description": "Date and time of last update.", "readOnly": true } } }, "BillingRequestPropertiesCreatedBy": { "type": "object", "description": "The principal of the entity who created the request.", "allOf": [ { "$ref": "#/definitions/Principal" } ] }, "BillingRequestPropertiesLastUpdatedBy": { "type": "object", "description": "The principal of the entity who last updated the request.", "allOf": [ { "$ref": "#/definitions/Principal" } ] }, "BillingRequestPropertiesReviewedBy": { "type": "object", "description": "The principal of the request reviewer. Will only be set if request is approved.", "allOf": [ { "$ref": "#/definitions/Principal" } ] }, "BillingRequestStatus": { "type": "string", "description": "Status of billing request.", "enum": [ "Other", "Pending", "Approved", "Declined", "Cancelled", "Completed", "Expired" ], "x-ms-enum": { "name": "BillingRequestStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "Approved", "value": "Approved", "description": "Approved" }, { "name": "Declined", "value": "Declined", "description": "Declined" }, { "name": "Cancelled", "value": "Cancelled", "description": "Cancelled" }, { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "Expired", "value": "Expired", "description": "Expired" } ] } }, "BillingRequestType": { "type": "string", "description": "Type of billing request.", "enum": [ "Other", "InvoiceAccess", "ProvisioningAccess", "RoleAssignment", "UpdateBillingPolicy" ], "x-ms-enum": { "name": "BillingRequestType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "InvoiceAccess", "value": "InvoiceAccess", "description": "InvoiceAccess" }, { "name": "ProvisioningAccess", "value": "ProvisioningAccess", "description": "ProvisioningAccess" }, { "name": "RoleAssignment", "value": "RoleAssignment", "description": "RoleAssignment" }, { "name": "UpdateBillingPolicy", "value": "UpdateBillingPolicy", "description": "UpdateBillingPolicy" } ] } }, "BillingRoleAssignment": { "type": "object", "description": "The properties of the billing role assignment.", "properties": { "properties": { "$ref": "#/definitions/BillingRoleAssignmentProperties", "description": "The properties of the billing role assignment." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingRoleAssignmentListResult": { "type": "object", "description": "Paged collection of BillingRoleAssignment items", "properties": { "value": { "type": "array", "description": "The BillingRoleAssignment items on this page", "items": { "$ref": "#/definitions/BillingRoleAssignment" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BillingRoleAssignmentProperties": { "type": "object", "description": "The properties of the billing role assignment.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "createdOn": { "type": "string", "format": "date-time", "description": "The date the role assignment was created.", "readOnly": true }, "createdByPrincipalTenantId": { "type": "string", "description": "The tenant Id of the user who created the role assignment.", "readOnly": true }, "createdByPrincipalId": { "type": "string", "description": "The object ID of the user who created the role assignment.", "readOnly": true }, "createdByPrincipalPuid": { "type": "string", "description": "The principal PUID of the user who created the role assignment.", "readOnly": true }, "createdByUserEmailAddress": { "type": "string", "description": "The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.", "readOnly": true }, "modifiedOn": { "type": "string", "format": "date-time", "description": "The date the role assignment was modified.", "readOnly": true }, "modifiedByPrincipalPuid": { "type": "string", "description": "The principal PUID of the user who modified the role assignment.", "readOnly": true }, "modifiedByUserEmailAddress": { "type": "string", "description": "The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.", "readOnly": true }, "modifiedByPrincipalId": { "type": "string", "description": "The principal PUID of the user who modified the role assignment.", "readOnly": true }, "modifiedByPrincipalTenantId": { "type": "string", "description": "The tenant Id of the user who modified the role assignment.", "readOnly": true }, "principalPuid": { "type": "string", "description": "The principal PUID of the user to whom the role was assigned." }, "principalId": { "type": "string", "description": "The object id of the user to whom the role was assigned." }, "principalTenantId": { "type": "string", "description": "The principal tenant id of the user to whom the role was assigned." }, "roleDefinitionId": { "type": "string", "description": "The ID of the role definition.", "minLength": 1 }, "scope": { "type": "string", "description": "The scope at which the role was assigned." }, "userAuthenticationType": { "type": "string", "description": "The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement." }, "userEmailAddress": { "type": "string", "description": "The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement." }, "principalTenantName": { "type": "string", "description": "The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account.", "readOnly": true }, "principalDisplayName": { "type": "string", "description": "The display name of the principal to whom the role was assigned.", "readOnly": true }, "principalType": { "$ref": "#/definitions/PrincipalType", "description": "The type of a role Assignment.", "readOnly": true }, "billingRequestId": { "type": "string", "description": "The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request.", "readOnly": true }, "billingAccountId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing account.", "readOnly": true }, "billingAccountDisplayName": { "type": "string", "description": "The name of the billing account.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile.", "readOnly": true }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile.", "readOnly": true }, "invoiceSectionId": { "type": "string", "description": "The fully qualified ID that uniquely identifies an invoice section.", "readOnly": true }, "invoiceSectionDisplayName": { "type": "string", "description": "The name of the invoice section.", "readOnly": true }, "customerId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a customer.", "readOnly": true }, "customerDisplayName": { "type": "string", "description": "The name of the customer.", "readOnly": true } }, "required": [ "roleDefinitionId" ] }, "BillingRoleDefinition": { "type": "object", "description": "The properties of a role definition.", "properties": { "properties": { "$ref": "#/definitions/BillingRoleDefinitionProperties", "description": "The properties of a role definition." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingRoleDefinitionListResult": { "type": "object", "description": "Paged collection of BillingRoleDefinition items", "properties": { "value": { "type": "array", "description": "The BillingRoleDefinition items on this page", "items": { "$ref": "#/definitions/BillingRoleDefinition" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BillingRoleDefinitionProperties": { "type": "object", "description": "The properties of a role definition.", "properties": { "description": { "type": "string", "description": "The role description.", "readOnly": true }, "permissions": { "type": "array", "description": "The billingPermissions the role has.", "items": { "$ref": "#/definitions/BillingPermission" }, "readOnly": true, "x-ms-identifiers": [] }, "roleName": { "type": "string", "description": "The name of the role.", "minLength": 1 } }, "required": [ "roleName" ] }, "BillingSubscription": { "type": "object", "description": "The billing properties of a subscription.", "properties": { "properties": { "$ref": "#/definitions/BillingSubscriptionProperties", "description": "The properties of a(n) BillingSubscription", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingSubscriptionAlias": { "type": "object", "description": "A billing subscription alias.", "properties": { "properties": { "$ref": "#/definitions/BillingSubscriptionAliasProperties", "description": "The properties of a(n) BillingSubscriptionAlias", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BillingSubscriptionAliasListResult": { "type": "object", "description": "Paged collection of BillingSubscriptionAlias items", "properties": { "value": { "type": "array", "description": "The BillingSubscriptionAlias items on this page", "items": { "$ref": "#/definitions/BillingSubscriptionAlias" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BillingSubscriptionAliasProperties": { "type": "object", "description": "A billing subscription alias.", "properties": { "billingSubscriptionId": { "type": "string", "description": "The ID of the billing subscription with the subscription alias.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/BillingSubscriptionProperties" } ] }, "BillingSubscriptionListResult": { "type": "object", "description": "A container for a list of resources", "properties": { "nextLink": { "type": "string", "format": "uri", "description": "The link (url) to the next page of results.", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "description": "Total number of records.", "readOnly": true }, "value": { "type": "array", "description": "The list of resources.", "items": { "$ref": "#/definitions/BillingSubscription" }, "readOnly": true, "x-ms-identifiers": [ "id" ] } } }, "BillingSubscriptionMergeRequest": { "type": "object", "description": "Request parameters that are provided to merge the two billing subscriptions.", "properties": { "targetBillingSubscriptionName": { "type": "string", "description": "The ID of the target billing subscription that will be merged with the source subscription provided in the request." }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of the source billing subscription that will be merged with the target billing subscription." } } }, "BillingSubscriptionOperationStatus": { "type": "string", "description": "The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.", "enum": [ "Other", "None", "LockedForUpdate" ], "x-ms-enum": { "name": "BillingSubscriptionOperationStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "None", "value": "None", "description": "None" }, { "name": "LockedForUpdate", "value": "LockedForUpdate", "description": "LockedForUpdate" } ] } }, "BillingSubscriptionPatch": { "type": "object", "description": "The billing properties of a subscription.", "properties": { "properties": { "$ref": "#/definitions/BillingSubscriptionProperties", "description": "The properties of a(n) BillingSubscription", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/ProxyResourceWithTags" } ] }, "BillingSubscriptionProperties": { "type": "object", "description": "The billing properties of a subscription.", "properties": { "autoRenew": { "$ref": "#/definitions/AutoRenew", "description": "Indicates whether auto renewal is turned on or off for a product." }, "beneficiaryTenantId": { "type": "string", "description": "The provisioning tenant of the subscription." }, "beneficiary": { "$ref": "#/definitions/Beneficiary", "description": "The beneficiary of the billing subscription." }, "billingFrequency": { "type": "string", "description": "The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y" }, "billingProfileId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile." }, "billingPolicies": { "type": "object", "description": "Dictionary of billing policies associated with the subscription.", "additionalProperties": { "type": "string" }, "readOnly": true }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile.", "readOnly": true }, "billingProfileName": { "type": "string", "description": "The ID that uniquely identifies a billing profile.", "readOnly": true }, "consumptionCostCenter": { "type": "string", "description": "The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts." }, "customerId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a customer." }, "customerDisplayName": { "type": "string", "description": "The name of the customer.", "readOnly": true }, "customerName": { "type": "string", "description": "The ID that uniquely identifies a customer.", "readOnly": true }, "displayName": { "type": "string", "description": "The name of the billing subscription." }, "enrollmentAccountId": { "type": "string", "description": "The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.", "readOnly": true }, "enrollmentAccountDisplayName": { "type": "string", "description": "The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.", "readOnly": true }, "enrollmentAccountSubscriptionDetails": { "$ref": "#/definitions/EnrollmentAccountSubscriptionDetails", "description": "Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.", "readOnly": true, "x-ms-client-flatten": true }, "invoiceSectionId": { "type": "string", "description": "The fully qualified ID that uniquely identifies an invoice section." }, "invoiceSectionDisplayName": { "type": "string", "description": "The name of the invoice section.", "readOnly": true }, "invoiceSectionName": { "type": "string", "description": "The ID that uniquely identifies an invoice section.", "readOnly": true }, "lastMonthCharges": { "$ref": "#/definitions/Amount", "description": "The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.", "readOnly": true }, "monthToDateCharges": { "$ref": "#/definitions/Amount", "description": "The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.", "readOnly": true }, "nextBillingCycleDetails": { "$ref": "#/definitions/NextBillingCycleDetails", "description": "Next billing cycle details of the subscription.", "readOnly": true }, "offerId": { "type": "string", "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.", "readOnly": true }, "productCategory": { "type": "string", "description": "The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.", "readOnly": true }, "productType": { "type": "string", "description": "Type of the product for which the subscription is purchased.", "readOnly": true }, "productTypeId": { "type": "string", "description": "Id of the product for which the subscription is purchased." }, "purchaseDate": { "type": "string", "format": "date-time", "description": "Purchase date of the product in UTC time.", "readOnly": true }, "quantity": { "type": "integer", "format": "int64", "description": "The quantity of licenses or fulfillment units for the subscription." }, "reseller": { "$ref": "#/definitions/Reseller", "description": "Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.", "readOnly": true }, "renewalTermDetails": { "$ref": "#/definitions/RenewalTermDetails", "description": "Details for the next renewal term of a subscription.", "readOnly": true }, "skuId": { "type": "string", "description": "The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts." }, "skuDescription": { "type": "string", "description": "The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", "readOnly": true }, "systemOverrides": { "$ref": "#/definitions/SystemOverrides", "description": "System imposed policies that regulate behavior of the subscription." }, "resourceUri": { "type": "string", "description": "Unique identifier of the linked resource.", "readOnly": true }, "termDuration": { "type": "string", "description": "The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y" }, "termStartDate": { "type": "string", "format": "date-time", "description": "Start date of the term in UTC time.", "readOnly": true }, "termEndDate": { "type": "string", "format": "date-time", "description": "End date of the term in UTC time.", "readOnly": true }, "provisioningTenantId": { "type": "string", "description": "The tenant in which the subscription is provisioned." }, "status": { "$ref": "#/definitions/BillingSubscriptionStatus", "description": "The status of the subscription. This field is not available for Enterprise Agreement billing accounts", "readOnly": true }, "operationStatus": { "$ref": "#/definitions/BillingSubscriptionOperationStatus", "description": "The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "subscriptionId": { "type": "string", "description": "The ID of the subscription.", "readOnly": true }, "suspensionReasons": { "type": "array", "description": "The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.", "items": { "type": "string" }, "readOnly": true }, "suspensionReasonDetails": { "type": "array", "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", "items": { "$ref": "#/definitions/BillingSubscriptionStatusDetails" }, "readOnly": true, "x-ms-identifiers": [] } } }, "BillingSubscriptionSplitRequest": { "type": "object", "description": "Request parameters that are provided to split the billing subscription.", "properties": { "targetProductTypeId": { "type": "string", "description": "The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the product id to split into." }, "targetSkuId": { "type": "string", "description": "The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the sku id to split into." }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of the target product to which the subscription needs to be split into." }, "termDuration": { "type": "string", "description": "The term duration of the target in ISO8601 format product to which the subscription needs to be split into. Example: P1M, P1Y" }, "billingFrequency": { "type": "string", "description": "The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y\"" } } }, "BillingSubscriptionStatus": { "type": "string", "description": "The subscription status.", "enum": [ "Other", "Unknown", "Active", "Disabled", "Deleted", "Warned", "Expiring", "Expired", "AutoRenew", "Cancelled", "Suspended", "Failed" ], "x-ms-enum": { "name": "BillingSubscriptionStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "Warned", "value": "Warned", "description": "Warned" }, { "name": "Expiring", "value": "Expiring", "description": "Expiring" }, { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "AutoRenew", "value": "AutoRenew", "description": "AutoRenew" }, { "name": "Cancelled", "value": "Cancelled", "description": "Cancelled" }, { "name": "Suspended", "value": "Suspended", "description": "Suspended" }, { "name": "Failed", "value": "Failed", "description": "Failed" } ] } }, "BillingSubscriptionStatusDetails": { "type": "object", "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", "properties": { "effectiveDate": { "type": "string", "format": "date-time", "description": "The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts.", "readOnly": true }, "reason": { "$ref": "#/definitions/SubscriptionStatusReason", "description": "The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.", "readOnly": true } } }, "CancelSubscriptionRequest": { "type": "object", "description": "Request parameters for cancel customer subscription.", "properties": { "cancellationReason": { "$ref": "#/definitions/CancellationReason", "description": "Cancellation reason." }, "customerId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a customer." } }, "required": [ "cancellationReason" ] }, "Cancellation": { "type": "string", "description": "The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.", "enum": [ "NotAllowed", "Allowed" ], "x-ms-enum": { "name": "Cancellation", "modelAsString": true, "values": [ { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" } ] } }, "CancellationReason": { "type": "string", "description": "Cancellation reason.", "enum": [ "Other", "Compromise", "Dispute" ], "x-ms-enum": { "name": "CancellationReason", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Compromise", "value": "Compromise", "description": "Compromise" }, { "name": "Dispute", "value": "Dispute", "description": "Dispute" } ] } }, "Category": { "type": "string", "description": "The category of the agreement.", "enum": [ "Other", "AffiliatePurchaseTerms", "IndirectForGovernmentAgreement", "MicrosoftCustomerAgreement", "MicrosoftPartnerAgreement", "UKCloudComputeFramework" ], "x-ms-enum": { "name": "Category", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "AffiliatePurchaseTerms", "value": "AffiliatePurchaseTerms", "description": "AffiliatePurchaseTerms" }, { "name": "IndirectForGovernmentAgreement", "value": "IndirectForGovernmentAgreement", "description": "IndirectForGovernmentAgreement" }, { "name": "MicrosoftCustomerAgreement", "value": "MicrosoftCustomerAgreement", "description": "MicrosoftCustomerAgreement" }, { "name": "MicrosoftPartnerAgreement", "value": "MicrosoftPartnerAgreement", "description": "MicrosoftPartnerAgreement" }, { "name": "UKCloudComputeFramework", "value": "UKCloudComputeFramework", "description": "UKCloudComputeFramework" } ] } }, "CheckAccessRequest": { "type": "object", "description": "Request to check access.", "properties": { "actions": { "type": "array", "description": "List of actions passed in the request body against which the permissions will be checked.", "items": { "type": "string" } } } }, "CheckAccessResponse": { "type": "object", "description": "The properties of a check access response.", "properties": { "accessDecision": { "$ref": "#/definitions/AccessDecision", "description": "Access Decision, specifies access is allowed or not.", "readOnly": true }, "action": { "type": "string", "description": "Gets or sets an action.", "readOnly": true } } }, "Commitment": { "type": "object", "description": "Commitment towards the benefit.", "properties": { "grain": { "$ref": "#/definitions/CommitmentGrain", "description": "Commitment grain." } }, "allOf": [ { "$ref": "#/definitions/Price" } ] }, "CommitmentGrain": { "type": "string", "description": "Commitment grain.", "enum": [ "Hourly" ], "x-ms-enum": { "name": "CommitmentGrain", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly", "description": "Hourly" } ] } }, "CreditType": { "type": "string", "description": "The credit type of the transaction. Applies only to credited transactions.", "enum": [ "Other", "AzureFreeCredit", "AzureCreditOffer", "ServiceInterruption", "Refund" ], "x-ms-enum": { "name": "CreditType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "AzureFreeCredit", "value": "AzureFreeCredit", "description": "AzureFreeCredit" }, { "name": "AzureCreditOffer", "value": "AzureCreditOffer", "description": "AzureCreditOffer" }, { "name": "ServiceInterruption", "value": "ServiceInterruption", "description": "ServiceInterruption" }, { "name": "Refund", "value": "Refund", "description": "Refund" } ] } }, "Customer": { "type": "object", "description": "A partner's customer.", "properties": { "properties": { "$ref": "#/definitions/CustomerProperties", "description": "A partner's customer." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "CustomerListResult": { "type": "object", "description": "Paged collection of Customer items", "properties": { "value": { "type": "array", "description": "The Customer items on this page", "items": { "$ref": "#/definitions/Customer" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CustomerPolicy": { "type": "object", "description": "A policy at customer scope.", "properties": { "properties": { "$ref": "#/definitions/CustomerPolicyProperties", "description": "A policy at customer scope." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "CustomerPolicyProperties": { "type": "object", "description": "A policy at customer scope.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "viewCharges": { "$ref": "#/definitions/ViewChargesPolicy", "description": "The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices." }, "policies": { "type": "array", "description": "List of all policies defined at the billing scope.", "items": { "$ref": "#/definitions/PolicySummary" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "viewCharges" ] }, "CustomerProperties": { "type": "object", "description": "A partner's customer.", "properties": { "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile.", "readOnly": true }, "displayName": { "type": "string", "description": "The name of the customer.", "readOnly": true }, "systemId": { "type": "string", "description": "The system generated unique identifier for a customer.", "readOnly": true }, "status": { "$ref": "#/definitions/CustomerStatus", "description": "Identifies the status of an customer. This is an upcoming property that will be populated in the future.", "readOnly": true }, "enabledAzurePlans": { "type": "array", "description": "Azure plans enabled for the customer.", "items": { "$ref": "#/definitions/AzurePlan" }, "x-ms-identifiers": [] }, "resellers": { "type": "array", "description": "The list of resellers for which an Azure plan is enabled for the customer.", "items": { "$ref": "#/definitions/Reseller" }, "x-ms-identifiers": [] }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } } }, "CustomerStatus": { "type": "string", "description": "Identifies the status of an customer. This is an upcoming property that will be populated in the future.", "enum": [ "Other", "Active", "Pending", "Disabled", "Warned", "Deleted", "UnderReview" ], "x-ms-enum": { "name": "CustomerStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Warned", "value": "Warned", "description": "Warned" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "UnderReview", "value": "UnderReview", "description": "UnderReview" } ] } }, "DeleteBillingProfileEligibilityCode": { "type": "string", "description": "Code of the delete invoice section eligibility response.", "enum": [ "None", "ActiveCredits", "ActiveCreditCard", "LastBillingProfile", "NotSupported", "OutstandingCharges", "PendingCharges", "ReservedInstances", "ActiveBillingSubscriptions" ], "x-ms-enum": { "name": "DeleteBillingProfileEligibilityCode", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "ActiveCredits", "value": "ActiveCredits", "description": "ActiveCredits" }, { "name": "ActiveCreditCard", "value": "ActiveCreditCard", "description": "ActiveCreditCard" }, { "name": "LastBillingProfile", "value": "LastBillingProfile", "description": "LastBillingProfile" }, { "name": "NotSupported", "value": "NotSupported", "description": "NotSupported" }, { "name": "OutstandingCharges", "value": "OutstandingCharges", "description": "OutstandingCharges" }, { "name": "PendingCharges", "value": "PendingCharges", "description": "PendingCharges" }, { "name": "ReservedInstances", "value": "ReservedInstances", "description": "ReservedInstances" }, { "name": "ActiveBillingSubscriptions", "value": "ActiveBillingSubscriptions", "description": "ActiveBillingSubscriptions" } ] } }, "DeleteBillingProfileEligibilityDetail": { "type": "object", "description": "Validation details of delete billing profile eligibility.", "properties": { "code": { "$ref": "#/definitions/DeleteBillingProfileEligibilityCode", "description": "Code of the delete invoice section eligibility response." }, "message": { "type": "string", "description": "Validation message." } } }, "DeleteBillingProfileEligibilityResult": { "type": "object", "description": "Eligibility to delete a billing profile result.", "properties": { "eligibilityStatus": { "$ref": "#/definitions/DeleteBillingProfileEligibilityStatus", "description": "Status describing if billing profile is eligible to be deleted." }, "eligibilityDetails": { "type": "array", "description": "Validation details of delete billing profile eligibility.", "items": { "$ref": "#/definitions/DeleteBillingProfileEligibilityDetail" }, "x-ms-identifiers": [] } } }, "DeleteBillingProfileEligibilityStatus": { "type": "string", "description": "Status describing if billing profile is eligible to be deleted.", "enum": [ "Allowed", "NotAllowed" ], "x-ms-enum": { "name": "DeleteBillingProfileEligibilityStatus", "modelAsString": true, "values": [ { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "DeleteInvoiceSectionEligibilityCode": { "type": "string", "description": "Code for the delete invoice section validation.", "enum": [ "Other", "LastInvoiceSection", "ActiveAzurePlans", "ReservedInstances", "ActiveBillingSubscriptions" ], "x-ms-enum": { "name": "DeleteInvoiceSectionEligibilityCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "LastInvoiceSection", "value": "LastInvoiceSection", "description": "LastInvoiceSection" }, { "name": "ActiveAzurePlans", "value": "ActiveAzurePlans", "description": "ActiveAzurePlans" }, { "name": "ReservedInstances", "value": "ReservedInstances", "description": "ReservedInstances" }, { "name": "ActiveBillingSubscriptions", "value": "ActiveBillingSubscriptions", "description": "ActiveBillingSubscriptions" } ] } }, "DeleteInvoiceSectionEligibilityDetail": { "type": "object", "description": "The details of delete invoice section eligibility result.", "properties": { "code": { "$ref": "#/definitions/DeleteInvoiceSectionEligibilityCode", "description": "Code for the delete invoice section validation." }, "message": { "type": "string", "description": "Validation message." } } }, "DeleteInvoiceSectionEligibilityResult": { "type": "object", "description": "Eligibility to delete an invoice section result.", "properties": { "eligibilityStatus": { "$ref": "#/definitions/DeleteInvoiceSectionEligibilityStatus", "description": "Status describing if invoice section is eligible to be deleted." }, "eligibilityDetails": { "type": "array", "description": "A list of delete invoice section eligibility result details.", "items": { "$ref": "#/definitions/DeleteInvoiceSectionEligibilityDetail" }, "x-ms-identifiers": [] } } }, "DeleteInvoiceSectionEligibilityStatus": { "type": "string", "description": "Status describing if invoice section is eligible to be deleted.", "enum": [ "Allowed", "NotAllowed" ], "x-ms-enum": { "name": "DeleteInvoiceSectionEligibilityStatus", "modelAsString": true, "values": [ { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "Department": { "type": "object", "description": "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.", "properties": { "properties": { "$ref": "#/definitions/DepartmentProperties", "description": "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "DepartmentListResult": { "type": "object", "description": "Paged collection of Department items", "properties": { "value": { "type": "array", "description": "The Department items on this page", "items": { "$ref": "#/definitions/Department" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DepartmentProperties": { "type": "object", "description": "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.", "properties": { "costCenter": { "type": "string", "description": "The cost center associated with the department." }, "displayName": { "type": "string", "description": "The name of the department." }, "id": { "type": "string", "description": "The ID that uniquely identifies the department.", "readOnly": true }, "status": { "type": "string", "description": "The status of the department.", "readOnly": true } } }, "DetailedTransferStatus": { "type": "object", "description": "Detailed transfer status.", "properties": { "productType": { "$ref": "#/definitions/ProductType", "description": "Type of product that is transferred.", "readOnly": true }, "productId": { "type": "string", "description": "The ID of the product that is transferred.", "readOnly": true }, "productName": { "type": "string", "description": "The name of the product that is transferred.", "readOnly": true }, "skuDescription": { "type": "string", "description": "The SKU of the product that is transferred.", "readOnly": true }, "transferStatus": { "$ref": "#/definitions/ProductTransferStatus", "description": "Transfer status.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/TransferError", "description": "Error details for transfer execution." } } }, "DocumentDownloadRequest": { "type": "object", "description": "A list of download details for individual documents.", "properties": { "documentName": { "type": "string", "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. If omitted, the most recent invoice PDF for the invoice will be returned." }, "invoiceName": { "type": "string", "description": "The ID that uniquely identifies an invoice." } } }, "DocumentDownloadResult": { "type": "object", "description": "A secure URL that can be used to download a an entity until the URL expires.", "properties": { "expiryTime": { "type": "string", "description": "The time in UTC when the download URL will expire.", "readOnly": true }, "url": { "type": "string", "description": "The URL to the PDF or .zip file.", "readOnly": true } } }, "DocumentSource": { "type": "string", "description": "The source of the document. ENF for Brazil and DRS for rest of the world.", "enum": [ "Other", "DRS", "ENF" ], "x-ms-enum": { "name": "DocumentSource", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "DRS", "value": "DRS", "description": "DRS" }, { "name": "ENF", "value": "ENF", "description": "ENF" } ] } }, "EligibleProductType": { "type": "string", "description": "Type of the products that can be transferred.", "enum": [ "DevTestAzureSubscription", "StandardAzureSubscription", "AzureReservation" ], "x-ms-enum": { "name": "EligibleProductType", "modelAsString": true, "values": [ { "name": "DevTestAzureSubscription", "value": "DevTestAzureSubscription", "description": "DevTestAzureSubscription" }, { "name": "StandardAzureSubscription", "value": "StandardAzureSubscription", "description": "StandardAzureSubscription" }, { "name": "AzureReservation", "value": "AzureReservation", "description": "AzureReservation" } ] } }, "EnrollmentAccount": { "type": "object", "description": "It is an organizational hierarchy within a billing account to administer and manage azure costs.", "properties": { "properties": { "$ref": "#/definitions/EnrollmentAccountProperties", "description": "It is an organizational hierarchy within a billing account to administer and manage azure costs." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "EnrollmentAccountListResult": { "type": "object", "description": "Paged collection of EnrollmentAccount items", "properties": { "value": { "type": "array", "description": "The EnrollmentAccount items on this page", "items": { "$ref": "#/definitions/EnrollmentAccount" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "EnrollmentAccountOwnerViewCharges": { "type": "string", "description": "The policy that controls whether account owner can view charges.", "enum": [ "Other", "Allowed", "Disabled", "NotAllowed" ], "x-ms-enum": { "name": "EnrollmentAccountOwnerViewCharges", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "EnrollmentAccountProperties": { "type": "object", "description": "It is an organizational hierarchy within a billing account to administer and manage azure costs.", "properties": { "costCenter": { "type": "string", "description": "The cost center associated with the enrollment account." }, "displayName": { "type": "string", "description": "The name of the enrollment account." }, "departmentDisplayName": { "type": "string", "description": "The name of the department under which the enrollment account exists.", "readOnly": true }, "departmentId": { "type": "string", "description": "The ID that uniquely identifies the department.", "readOnly": true }, "isDevTestEnabled": { "type": "boolean", "description": "Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates." }, "accountOwner": { "type": "string", "description": "The owner of the enrollment account.", "readOnly": true }, "authType": { "type": "string", "description": "The authorization type of the enrollment account.", "readOnly": true }, "status": { "type": "string", "description": "The status of the enrollment account.", "readOnly": true }, "startDate": { "type": "string", "format": "date-time", "description": "The date from which the enrollment account became valid and functional.", "readOnly": true }, "endDate": { "type": "string", "format": "date-time", "description": "The date of expiration of the enrollment account.", "readOnly": true } } }, "EnrollmentAccountSubscriptionDetails": { "type": "object", "description": "The billing properties that can be modified. Available only for the Enterprise Agreement Type.", "properties": { "enrollmentAccountStartDate": { "type": "string", "format": "date-time", "description": "The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type.", "readOnly": true }, "subscriptionEnrollmentAccountStatus": { "$ref": "#/definitions/SubscriptionEnrollmentAccountStatus", "description": "The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.", "readOnly": true } } }, "EnrollmentAuthLevelState": { "type": "string", "description": "The state showing the enrollment auth level.", "enum": [ "Other", "MicrosoftAccountOnly", "MixedAccount", "OrganizationalAccountCrossTenant", "OrganizationalAccountOnly" ], "x-ms-enum": { "name": "EnrollmentAuthLevelState", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "MicrosoftAccountOnly", "value": "MicrosoftAccountOnly", "description": "MicrosoftAccountOnly" }, { "name": "MixedAccount", "value": "MixedAccount", "description": "MixedAccount" }, { "name": "OrganizationalAccountCrossTenant", "value": "OrganizationalAccountCrossTenant", "description": "OrganizationalAccountCrossTenant" }, { "name": "OrganizationalAccountOnly", "value": "OrganizationalAccountOnly", "description": "OrganizationalAccountOnly" } ] } }, "EnrollmentDepartmentAdminViewCharges": { "type": "string", "description": "The policy that controls whether department admin can view charges.", "enum": [ "Other", "Allowed", "Disabled", "NotAllowed" ], "x-ms-enum": { "name": "EnrollmentDepartmentAdminViewCharges", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "EnrollmentDetails": { "type": "object", "description": "The properties of an enrollment.", "properties": { "startDate": { "type": "string", "format": "date-time", "description": "The start date of the enrollment." }, "endDate": { "type": "string", "format": "date-time", "description": "The end date of the enrollment." }, "currency": { "type": "string", "description": "The billing currency for the enrollment.", "readOnly": true }, "channel": { "type": "string", "description": "The channel type of the enrollment.", "readOnly": true }, "language": { "type": "string", "description": "The language for the enrollment.", "readOnly": true }, "countryCode": { "type": "string", "description": "The country code of the enrollment.", "readOnly": true }, "billingCycle": { "type": "string", "description": "The billing cycle for the enrollment.", "readOnly": true }, "extendedTermOption": { "$ref": "#/definitions/ExtendedTermOption", "description": "The billing account extension opted by the company.", "readOnly": true }, "supportLevel": { "$ref": "#/definitions/SupportLevel", "description": "The support level offer associated with an enrollment.", "readOnly": true }, "supportCoverage": { "type": "string", "description": "The support coverage period for the enrollment.", "readOnly": true }, "cloud": { "type": "string", "description": "The cloud of the enrollment.", "readOnly": true }, "poNumber": { "type": "string", "description": "The purchase order number of the enrollment." }, "markupStatus": { "$ref": "#/definitions/MarkupStatus", "description": "Markup status of enrollment, applicable only for indirect enrollments.", "readOnly": true }, "indirectRelationshipInfo": { "$ref": "#/definitions/EnrollmentDetailsIndirectRelationshipInfo", "description": "The properties of an enrollment which are applicable only for indirect enrollments." }, "invoiceRecipient": { "type": "string", "description": "The contact who receives invoices of the enrollment.", "readOnly": true } } }, "EnrollmentDetailsIndirectRelationshipInfo": { "type": "object", "description": "The properties of an enrollment which are applicable only for indirect enrollments.", "allOf": [ { "$ref": "#/definitions/IndirectRelationshipInfo" } ] }, "EnterpriseAgreementPolicies": { "type": "object", "description": "The policies for Enterprise Agreement enrollments.", "properties": { "authenticationType": { "$ref": "#/definitions/EnrollmentAuthLevelState", "description": "The state showing the enrollment auth level." }, "accountOwnerViewCharges": { "$ref": "#/definitions/EnrollmentAccountOwnerViewCharges", "description": "The policy that controls whether account owner can view charges." }, "departmentAdminViewCharges": { "$ref": "#/definitions/EnrollmentDepartmentAdminViewCharges", "description": "The policy that controls whether department admin can view charges." } } }, "ExtendedStatusDefinitionProperties": { "type": "object", "description": "Extended status definition properties", "properties": { "subscriptionId": { "type": "string", "description": "Subscription Id" } } }, "ExtendedStatusInfo": { "type": "object", "description": "Extended status information", "properties": { "statusCode": { "type": "string", "description": "Status code providing additional information." }, "message": { "type": "string", "description": "The message giving detailed information about the status code." }, "properties": { "$ref": "#/definitions/ExtendedStatusInfoProperties", "description": "Properties specific to credit line check failure", "x-ms-client-flatten": true } } }, "ExtendedStatusInfoProperties": { "type": "object", "description": "Properties specific to credit line check failure", "properties": { "subscriptionId": { "type": "string", "description": "The subscription that has failed credit line check." } } }, "ExtendedTermOption": { "type": "string", "description": "The billing account extension opted by the company.", "enum": [ "Other", "Opted-In", "Opted-Out" ], "x-ms-enum": { "name": "ExtendedTermOption", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Opted-In", "value": "Opted-In", "description": "Opted-In" }, { "name": "Opted-Out", "value": "Opted-Out", "description": "Opted-Out" } ] } }, "FailedPayment": { "type": "object", "description": "A failed payment.", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date when the payment was attempted.", "readOnly": true }, "failedPaymentReason": { "$ref": "#/definitions/FailedPaymentReason", "description": "The reason that the payment failed.", "readOnly": true } } }, "FailedPaymentReason": { "type": "string", "description": "The reason that the payment failed.", "enum": [ "Other", "BankDeclined", "CardExpired", "IncorrectCardDetails" ], "x-ms-enum": { "name": "FailedPaymentReason", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "BankDeclined", "value": "BankDeclined", "description": "BankDeclined" }, { "name": "CardExpired", "value": "CardExpired", "description": "CardExpired" }, { "name": "IncorrectCardDetails", "value": "IncorrectCardDetails", "description": "IncorrectCardDetails" } ] } }, "IndirectRelationshipInfo": { "type": "object", "description": "Identifies the billing profile that is linked to another billing profile in indirect purchase motion.", "properties": { "billingAccountName": { "type": "string", "description": "The billing account name of the partner or the customer for an indirect motion." }, "billingProfileName": { "type": "string", "description": "The billing profile name of the partner or the customer for an indirect motion." }, "displayName": { "type": "string", "description": "The display name of the partner or customer for an indirect motion." } } }, "InitiateTransferProperties": { "type": "object", "description": "Request parameters to initiate transfer.", "properties": { "recipientEmailId": { "type": "string", "description": "The email ID of the recipient to whom the transfer request is sent." } } }, "InitiateTransferRequest": { "type": "object", "description": "Request parameters to initiate transfer.", "properties": { "properties": { "$ref": "#/definitions/InitiateTransferProperties", "description": "Request parameters to initiate transfer.", "x-ms-client-flatten": true } } }, "InitiatorCustomerType": { "type": "string", "description": "The type of customer of the transfer initiator.", "enum": [ "Partner", "EA" ], "x-ms-enum": { "name": "InitiatorCustomerType", "modelAsString": true, "values": [ { "name": "Partner", "value": "Partner", "description": "Partner" }, { "name": "EA", "value": "EA", "description": "EA" } ] } }, "InstanceFlexibility": { "type": "string", "description": "Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.", "enum": [ "On", "Off" ], "x-ms-enum": { "name": "InstanceFlexibility", "modelAsString": true, "values": [ { "name": "On", "value": "On", "description": "On" }, { "name": "Off", "value": "Off", "description": "Off" } ] } }, "Invoice": { "type": "object", "description": "An invoice.", "properties": { "properties": { "$ref": "#/definitions/InvoiceProperties", "description": "An invoice." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "InvoiceDocument": { "type": "object", "description": "The properties of a document.", "properties": { "documentNumbers": { "type": "array", "description": "The document numbers for the invoice document.", "items": { "type": "string" }, "readOnly": true }, "externalUrl": { "type": "string", "description": "The URL to download the invoice document if the source is external to Microsoft.Billing.", "readOnly": true }, "kind": { "$ref": "#/definitions/InvoiceDocumentType", "description": "The type of the document.", "readOnly": true }, "name": { "type": "string", "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt.", "readOnly": true }, "url": { "type": "string", "description": "The URL to download the invoice document if the source is internal to Microsoft.Billing.", "readOnly": true }, "source": { "$ref": "#/definitions/DocumentSource", "description": "The source of the document. ENF for Brazil and DRS for rest of the world.", "readOnly": true } } }, "InvoiceDocumentType": { "type": "string", "description": "The type of the document.", "enum": [ "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", "Transactions" ], "x-ms-enum": { "name": "InvoiceDocumentType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Invoice", "value": "Invoice", "description": "Invoice" }, { "name": "VoidNote", "value": "VoidNote", "description": "VoidNote" }, { "name": "TaxReceipt", "value": "TaxReceipt", "description": "TaxReceipt" }, { "name": "CreditNote", "value": "CreditNote", "description": "CreditNote" }, { "name": "Summary", "value": "Summary", "description": "Summary" }, { "name": "Transactions", "value": "Transactions", "description": "Transactions" } ] } }, "InvoiceListResult": { "type": "object", "description": "Paged collection of Invoice items", "properties": { "value": { "type": "array", "description": "The Invoice items on this page", "items": { "$ref": "#/definitions/Invoice" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "InvoiceProperties": { "type": "object", "description": "An invoice.", "properties": { "amountDue": { "$ref": "#/definitions/InvoicePropertiesAmountDue", "description": "The amount due as of now." }, "azurePrepaymentApplied": { "$ref": "#/definitions/InvoicePropertiesAzurePrepaymentApplied", "description": "The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement." }, "billedAmount": { "$ref": "#/definitions/InvoicePropertiesBilledAmount", "description": "The total charges for the invoice billing period." }, "billedDocumentId": { "type": "string", "description": "The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only.", "readOnly": true }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile for which the invoice is generated.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "The ID of the billing profile for which the invoice is generated.", "readOnly": true }, "creditAmount": { "$ref": "#/definitions/InvoicePropertiesCreditAmount", "description": "The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement." }, "creditForDocumentId": { "type": "string", "description": "The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only.", "readOnly": true }, "documents": { "type": "array", "description": "List of documents available to download and view such as invoice, credit note, or tax receipt.", "items": { "$ref": "#/definitions/InvoiceDocument" }, "readOnly": true, "x-ms-identifiers": [] }, "documentType": { "$ref": "#/definitions/InvoiceDocumentType", "description": "The type of the document.", "readOnly": true }, "dueDate": { "type": "string", "format": "date-time", "description": "The due date for the invoice.", "readOnly": true }, "failedPayments": { "type": "array", "description": "List of failed payments.", "items": { "$ref": "#/definitions/FailedPayment" }, "readOnly": true, "x-ms-identifiers": [] }, "freeAzureCreditApplied": { "$ref": "#/definitions/InvoicePropertiesFreeAzureCreditApplied", "description": "The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement." }, "invoiceDate": { "type": "string", "format": "date-time", "description": "The date when the invoice was generated.", "readOnly": true }, "invoicePeriodEndDate": { "type": "string", "format": "date-time", "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "readOnly": true }, "invoicePeriodStartDate": { "type": "string", "format": "date-time", "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", "readOnly": true }, "invoiceType": { "$ref": "#/definitions/InvoiceType", "description": "Invoice type.", "readOnly": true }, "isMonthlyInvoice": { "type": "boolean", "description": "Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", "readOnly": true }, "payments": { "type": "array", "description": "List of payments.", "items": { "$ref": "#/definitions/Payment" }, "readOnly": true, "x-ms-identifiers": [] }, "purchaseOrderNumber": { "type": "string", "description": "An optional purchase order number for the invoice.", "readOnly": true }, "rebillDetails": { "$ref": "#/definitions/InvoicePropertiesRebillDetails", "description": "Rebill details for an invoice." }, "status": { "$ref": "#/definitions/InvoiceStatus", "description": "The current status of the invoice.", "readOnly": true }, "subscriptionDisplayName": { "type": "string", "description": "The name of the billing subscription for which the invoice is generated.", "readOnly": true }, "subscriptionId": { "type": "string", "description": "The ID of the subscription for which the invoice is generated.", "readOnly": true }, "specialTaxationType": { "$ref": "#/definitions/SpecialTaxationType", "description": "Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.", "readOnly": true }, "subTotal": { "$ref": "#/definitions/InvoicePropertiesSubTotal", "description": "The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement." }, "taxAmount": { "$ref": "#/definitions/InvoicePropertiesTaxAmount", "description": "The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement." }, "totalAmount": { "$ref": "#/definitions/InvoicePropertiesTotalAmount", "description": "The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement." }, "refundDetails": { "$ref": "#/definitions/InvoicePropertiesRefundDetails", "description": "The details of a refund request." } } }, "InvoicePropertiesAmountDue": { "type": "object", "description": "The amount due as of now.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoicePropertiesAzurePrepaymentApplied": { "type": "object", "description": "The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoicePropertiesBilledAmount": { "type": "object", "description": "The total charges for the invoice billing period.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoicePropertiesCreditAmount": { "type": "object", "description": "The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoicePropertiesFreeAzureCreditApplied": { "type": "object", "description": "The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoicePropertiesRebillDetails": { "type": "object", "description": "Rebill details for an invoice.", "allOf": [ { "$ref": "#/definitions/RebillDetails" } ] }, "InvoicePropertiesRefundDetails": { "type": "object", "description": "The details of a refund request.", "allOf": [ { "$ref": "#/definitions/RefundDetailsSummary" } ] }, "InvoicePropertiesSubTotal": { "type": "object", "description": "The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoicePropertiesTaxAmount": { "type": "object", "description": "The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoicePropertiesTotalAmount": { "type": "object", "description": "The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "InvoiceSection": { "type": "object", "description": "An invoice section.", "properties": { "properties": { "$ref": "#/definitions/InvoiceSectionProperties", "description": "An invoice section." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "InvoiceSectionLabelManagementPolicy": { "type": "string", "description": "The policy that controls invoice section label management at invoice section scope. This is allowed by default.", "enum": [ "Other", "Allowed", "NotAllowed" ], "x-ms-enum": { "name": "InvoiceSectionLabelManagementPolicy", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "InvoiceSectionListResult": { "type": "object", "description": "Paged collection of InvoiceSection items", "properties": { "value": { "type": "array", "description": "The InvoiceSection items on this page", "items": { "$ref": "#/definitions/InvoiceSection" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "InvoiceSectionProperties": { "type": "object", "description": "An invoice section.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "displayName": { "type": "string", "description": "The name of the invoice section." }, "state": { "$ref": "#/definitions/InvoiceSectionState", "description": "Identifies the status of an invoice section." }, "reasonCode": { "$ref": "#/definitions/InvoiceSectionStateReasonCode", "description": "Reason for the specified invoice section status." }, "systemId": { "type": "string", "description": "The system generated unique identifier for an invoice section.", "readOnly": true }, "targetCloud": { "type": "string", "description": "Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } } }, "InvoiceSectionState": { "type": "string", "description": "Identifies the status of an invoice section.", "enum": [ "Other", "Active", "Deleted", "Disabled", "UnderReview", "Warned", "Restricted" ], "x-ms-enum": { "name": "InvoiceSectionState", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "UnderReview", "value": "UnderReview", "description": "UnderReview" }, { "name": "Warned", "value": "Warned", "description": "Warned" }, { "name": "Restricted", "value": "Restricted", "description": "Restricted" } ] } }, "InvoiceSectionStateReasonCode": { "type": "string", "description": "Reason for the specified invoice section status.", "enum": [ "Other", "PastDue", "UnusualActivity", "SpendingLimitReached", "SpendingLimitExpired" ], "x-ms-enum": { "name": "InvoiceSectionStateReasonCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "PastDue", "value": "PastDue", "description": "PastDue" }, { "name": "UnusualActivity", "value": "UnusualActivity", "description": "UnusualActivity" }, { "name": "SpendingLimitReached", "value": "SpendingLimitReached", "description": "SpendingLimitReached" }, { "name": "SpendingLimitExpired", "value": "SpendingLimitExpired", "description": "SpendingLimitExpired" } ] } }, "InvoiceSectionWithCreateSubPermission": { "type": "object", "description": "Invoice section properties with create subscription permission.", "properties": { "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile.", "readOnly": true }, "billingProfileSystemId": { "type": "string", "description": "The system generated unique identifier for a billing profile.", "readOnly": true }, "billingProfileStatus": { "$ref": "#/definitions/BillingProfileStatus", "description": "The status of the billing profile.", "readOnly": true }, "billingProfileStatusReasonCode": { "$ref": "#/definitions/BillingProfileStatusReasonCode", "description": "Reason for the specified billing profile status.", "readOnly": true }, "billingProfileSpendingLimit": { "$ref": "#/definitions/SpendingLimit", "description": "The billing profile spending limit.", "readOnly": true }, "enabledAzurePlans": { "type": "array", "description": "Enabled azure plans for the associated billing profile.", "items": { "$ref": "#/definitions/AzurePlan" }, "readOnly": true, "x-ms-identifiers": [] }, "invoiceSectionDisplayName": { "type": "string", "description": "The name of the invoice section.", "readOnly": true }, "invoiceSectionId": { "type": "string", "description": "The fully qualified ID that uniquely identifies an invoice section.", "readOnly": true }, "invoiceSectionSystemId": { "type": "string", "description": "The system generated unique identifier for an invoice section.", "readOnly": true } } }, "InvoiceSectionWithCreateSubPermissionListResult": { "type": "object", "description": "A container for a list of resources", "properties": { "value": { "type": "array", "description": "The InvoiceSectionWithCreateSubPermission items on this page", "items": { "$ref": "#/definitions/InvoiceSectionWithCreateSubPermission" }, "readOnly": true, "x-ms-identifiers": [ "invoiceSectionId" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "InvoiceStatus": { "type": "string", "description": "The current status of the invoice.", "enum": [ "Other", "Due", "OverDue", "Paid", "Void", "Locked" ], "x-ms-enum": { "name": "InvoiceStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Due", "value": "Due", "description": "Due" }, { "name": "OverDue", "value": "OverDue", "description": "OverDue" }, { "name": "Paid", "value": "Paid", "description": "Paid" }, { "name": "Void", "value": "Void", "description": "Void" }, { "name": "Locked", "value": "Locked", "description": "Locked" } ] } }, "InvoiceType": { "type": "string", "description": "Invoice type.", "enum": [ "Other", "AzureServices", "AzureMarketplace", "AzureSupport" ], "x-ms-enum": { "name": "InvoiceType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "AzureServices", "value": "AzureServices", "description": "AzureServices" }, { "name": "AzureMarketplace", "value": "AzureMarketplace", "description": "AzureMarketplace" }, { "name": "AzureSupport", "value": "AzureSupport", "description": "AzureSupport" } ] } }, "MarketplacePurchasesPolicy": { "type": "string", "description": "The policy that controls whether Azure marketplace purchases are allowed.", "enum": [ "Other", "AllAllowed", "Disabled", "NotAllowed", "OnlyFreeAllowed" ], "x-ms-enum": { "name": "MarketplacePurchasesPolicy", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "AllAllowed", "value": "AllAllowed", "description": "AllAllowed" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" }, { "name": "OnlyFreeAllowed", "value": "OnlyFreeAllowed", "description": "OnlyFreeAllowed" } ] } }, "MarkupStatus": { "type": "string", "description": "Markup status of enrollment, applicable only for indirect enrollments.", "enum": [ "Other", "Disabled", "Preview", "Published", "Locked" ], "x-ms-enum": { "name": "MarkupStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Preview", "value": "Preview", "description": "Preview" }, { "name": "Published", "value": "Published", "description": "Published" }, { "name": "Locked", "value": "Locked", "description": "Locked" } ] } }, "MoveBillingSubscriptionEligibilityResult": { "type": "object", "description": "Result of the transfer eligibility validation.", "properties": { "isMoveEligible": { "type": "boolean", "description": "Specifies whether the subscription is eligible to be transferred.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/MoveBillingSubscriptionErrorDetails", "description": "Error details of the transfer eligibility validation." } } }, "MoveBillingSubscriptionErrorDetails": { "type": "object", "description": "Error details of the transfer eligibility validation.", "properties": { "code": { "$ref": "#/definitions/SubscriptionTransferValidationErrorCode", "description": "Error code of the transfer validation response." }, "message": { "type": "string", "description": "The error message." }, "details": { "type": "string", "description": "Detailed error message explaining the error." } } }, "MoveBillingSubscriptionRequest": { "type": "object", "description": "Request parameters to transfer billing subscription.", "properties": { "destinationInvoiceSectionId": { "type": "string", "description": "The destination invoice section id." }, "destinationEnrollmentAccountId": { "type": "string", "description": "The destination enrollment account id." } } }, "MoveProductEligibilityResult": { "type": "object", "description": "Result of the transfer eligibility validation.", "properties": { "isMoveEligible": { "type": "boolean", "description": "Specifies whether the subscription is eligible to be transferred." }, "errorDetails": { "$ref": "#/definitions/MoveProductEligibilityResultErrorDetails", "description": "Error details of the transfer eligibility validation." } } }, "MoveProductEligibilityResultErrorDetails": { "type": "object", "description": "Error details of the transfer eligibility validation.", "allOf": [ { "$ref": "#/definitions/MoveProductErrorDetails" } ] }, "MoveProductErrorDetails": { "type": "object", "description": "Error details of the transfer eligibility validation.", "properties": { "code": { "$ref": "#/definitions/MoveValidationErrorCode", "description": "Error code for the product transfer validation.", "readOnly": true }, "message": { "type": "string", "description": "The error message.", "readOnly": true }, "details": { "type": "string", "description": "Error details of the transfer eligibility validation.", "readOnly": true } } }, "MoveProductRequest": { "type": "object", "description": "The properties of the product to initiate a transfer.", "properties": { "destinationInvoiceSectionId": { "type": "string", "description": "The destination invoice section id.", "minLength": 1 } }, "required": [ "destinationInvoiceSectionId" ] }, "MoveValidationErrorCode": { "type": "string", "description": "Error code for the product transfer validation.", "enum": [ "Other", "BillingAccountInactive", "DestinationBillingProfileInactive", "DestinationBillingProfileNotFound", "DestinationBillingProfilePastDue", "DestinationInvoiceSectionInactive", "DestinationInvoiceSectionNotFound", "InsufficientPermissionOnDestination", "InsufficientPermissionOnSource", "InvalidDestination", "InvalidSource", "MarketplaceNotEnabledOnDestination", "ProductInactive", "ProductNotFound", "ProductTypeNotSupported", "SourceBillingProfilePastDue", "SourceInvoiceSectionInactive" ], "x-ms-enum": { "name": "MoveValidationErrorCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "BillingAccountInactive", "value": "BillingAccountInactive", "description": "BillingAccountInactive" }, { "name": "DestinationBillingProfileInactive", "value": "DestinationBillingProfileInactive", "description": "DestinationBillingProfileInactive" }, { "name": "DestinationBillingProfileNotFound", "value": "DestinationBillingProfileNotFound", "description": "DestinationBillingProfileNotFound" }, { "name": "DestinationBillingProfilePastDue", "value": "DestinationBillingProfilePastDue", "description": "DestinationBillingProfilePastDue" }, { "name": "DestinationInvoiceSectionInactive", "value": "DestinationInvoiceSectionInactive", "description": "DestinationInvoiceSectionInactive" }, { "name": "DestinationInvoiceSectionNotFound", "value": "DestinationInvoiceSectionNotFound", "description": "DestinationInvoiceSectionNotFound" }, { "name": "InsufficientPermissionOnDestination", "value": "InsufficientPermissionOnDestination", "description": "InsufficientPermissionOnDestination" }, { "name": "InsufficientPermissionOnSource", "value": "InsufficientPermissionOnSource", "description": "InsufficientPermissionOnSource" }, { "name": "InvalidDestination", "value": "InvalidDestination", "description": "InvalidDestination" }, { "name": "InvalidSource", "value": "InvalidSource", "description": "InvalidSource" }, { "name": "MarketplaceNotEnabledOnDestination", "value": "MarketplaceNotEnabledOnDestination", "description": "MarketplaceNotEnabledOnDestination" }, { "name": "ProductInactive", "value": "ProductInactive", "description": "ProductInactive" }, { "name": "ProductNotFound", "value": "ProductNotFound", "description": "ProductNotFound" }, { "name": "ProductTypeNotSupported", "value": "ProductTypeNotSupported", "description": "ProductTypeNotSupported" }, { "name": "SourceBillingProfilePastDue", "value": "SourceBillingProfilePastDue", "description": "SourceBillingProfilePastDue" }, { "name": "SourceInvoiceSectionInactive", "value": "SourceInvoiceSectionInactive", "description": "SourceInvoiceSectionInactive" } ] } }, "NextBillingCycleDetails": { "type": "object", "description": "Billing cycle details of the product.", "properties": { "billingFrequency": { "type": "string", "description": "Billing frequency of the product under the subscription.", "readOnly": true } } }, "Operation": { "type": "object", "description": "Details of a REST API operation, returned from the Resource Provider Operations API.", "properties": { "name": { "type": "string", "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\".", "readOnly": true }, "isDataAction": { "type": "boolean", "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", "readOnly": true }, "display": { "$ref": "#/definitions/OperationDisplay", "description": "Localized display information for this particular operation." } } }, "OperationDisplay": { "type": "object", "description": "Localized display information for this particular operation.", "properties": { "description": { "type": "string", "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", "readOnly": true }, "operation": { "type": "string", "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", "readOnly": true }, "provider": { "type": "string", "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", "readOnly": true }, "resource": { "type": "string", "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", "readOnly": true } } }, "OperationListResult": { "type": "object", "description": "Result of the request to list billing operations. It contains a list of operations and a URL link to get the next set of results.", "properties": { "value": { "type": "array", "description": "List of billing operations supported by the Microsoft.Billing resource provider.", "items": { "$ref": "#/definitions/Operation" }, "readOnly": true, "x-ms-identifiers": [ "name" ] }, "nextLink": { "type": "string", "format": "uri", "description": "URL to get the next set of operation list results if there are any.", "readOnly": true } } }, "Participant": { "type": "object", "description": "Billing account name. Available for a specific type of agreement.", "properties": { "email": { "type": "string", "description": "The email address of the participant.", "readOnly": true }, "status": { "type": "string", "description": "The acceptance status of the participant.", "readOnly": true }, "statusDate": { "type": "string", "format": "date-time", "description": "The date when the status got changed.", "readOnly": true } } }, "PartnerInitiateTransferProperties": { "type": "object", "description": "Request parameters to initiate transfer.", "properties": { "recipientEmailId": { "type": "string", "description": "The email ID of the recipient to whom the transfer request is sent." }, "resellerId": { "type": "string", "description": "Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account." } } }, "PartnerInitiateTransferRequest": { "type": "object", "description": "Request parameters to initiate partner transfer.", "properties": { "properties": { "$ref": "#/definitions/PartnerInitiateTransferProperties", "description": "Request parameters to initiate partner transfer.", "x-ms-client-flatten": true } } }, "PartnerTransferDetails": { "type": "object", "description": "Details of the transfer.", "properties": { "properties": { "$ref": "#/definitions/PartnerTransferProperties", "description": "Details of the transfer.", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PartnerTransferDetailsListResult": { "type": "object", "description": "Paged collection of PartnerTransferDetails items", "properties": { "value": { "type": "array", "description": "The PartnerTransferDetails items on this page", "items": { "$ref": "#/definitions/PartnerTransferDetails" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PartnerTransferProperties": { "type": "object", "description": "Transfer Details.", "properties": { "expirationTime": { "type": "string", "format": "date-time", "description": "The time at which the transfer request expires.", "readOnly": true }, "transferStatus": { "$ref": "#/definitions/TransferStatus", "description": "Overall transfer status.", "readOnly": true }, "recipientEmailId": { "type": "string", "description": "The email ID of the user to whom the transfer request was sent.", "readOnly": true }, "initiatorCustomerType": { "$ref": "#/definitions/InitiatorCustomerType", "description": "The type of customer who sent the transfer request.", "readOnly": true }, "initiatorEmailId": { "type": "string", "description": "The email ID of the user who sent the transfer request.", "readOnly": true }, "resellerId": { "type": "string", "description": "Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account.", "readOnly": true }, "resellerName": { "type": "string", "description": "Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account.", "readOnly": true }, "canceledBy": { "type": "string", "description": "The email ID of the user who canceled the transfer request.", "readOnly": true }, "detailedTransferStatus": { "type": "array", "description": "Detailed transfer status.", "items": { "$ref": "#/definitions/DetailedTransferStatus" }, "readOnly": true, "x-ms-identifiers": [] } } }, "Patch": { "type": "object", "description": "The request for reservation patch", "properties": { "properties": { "$ref": "#/definitions/PatchProperties", "description": "Properties for reservation patch", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/ReservationSkuProperty", "description": "The sku information associated to this reservation" }, "tags": { "type": "object", "description": "Tags for this reservation", "additionalProperties": { "type": "string" } } } }, "PatchProperties": { "type": "object", "description": "Properties for reservation patch", "properties": { "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopeProperties": { "$ref": "#/definitions/ReservationAppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup" }, "instanceFlexibility": { "$ref": "#/definitions/InstanceFlexibility", "description": "Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type." }, "displayName": { "type": "string", "description": "Display name of the reservation" }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "renewProperties": { "$ref": "#/definitions/PatchPropertiesRenewProperties", "x-ms-client-flatten": true }, "reviewDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the Azure hybrid benefit needs to be reviewed." } } }, "PatchPropertiesRenewProperties": { "type": "object", "properties": { "purchaseProperties": { "$ref": "#/definitions/ReservationPurchaseRequest", "description": "The request for reservation purchase" } } }, "Payment": { "type": "object", "description": "An invoice payment.", "properties": { "amount": { "$ref": "#/definitions/PaymentAmount", "description": "The paid amount." }, "date": { "type": "string", "format": "date-time", "description": "The date when the payment was made.", "readOnly": true }, "paymentMethodId": { "type": "string", "description": "The ID that uniquely identifies the payment method used for the invoice.", "readOnly": true }, "paymentMethodFamily": { "$ref": "#/definitions/PaymentMethodFamily", "description": "The family of payment method.", "readOnly": true }, "paymentMethodType": { "type": "string", "description": "The type of payment method.", "readOnly": true }, "paymentType": { "type": "string", "description": "The type of payment.", "readOnly": true } } }, "PaymentAmount": { "type": "object", "description": "The paid amount.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "PaymentDetail": { "type": "object", "description": "Information about payment related to a savings plan order.", "properties": { "dueDate": { "type": "string", "format": "date", "description": "Date when the payment needs to be done." }, "paymentDate": { "type": "string", "format": "date", "description": "Date when the transaction is completed. Null when it is scheduled." }, "pricingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount in pricing currency. Tax not included." }, "billingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount charged in Billing currency. Tax not included. Is null for future payments" }, "status": { "$ref": "#/definitions/PaymentStatus", "description": "Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future." }, "extendedStatusInfo": { "$ref": "#/definitions/ExtendedStatusInfo", "description": "Extended status information", "readOnly": true } } }, "PaymentMethod": { "type": "object", "description": "A payment method.", "properties": { "properties": { "$ref": "#/definitions/PaymentMethodProperties", "description": "Payment method properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PaymentMethodFamily": { "type": "string", "description": "Payment on Account type.", "enum": [ "Other", "None", "CreditCard", "Credits", "CheckWire", "EWallet", "TaskOrder", "DirectDebit" ], "x-ms-enum": { "name": "PaymentMethodFamily", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "None", "value": "None", "description": "None" }, { "name": "CreditCard", "value": "CreditCard", "description": "CreditCard" }, { "name": "Credits", "value": "Credits", "description": "Credits" }, { "name": "CheckWire", "value": "CheckWire", "description": "CheckWire" }, { "name": "EWallet", "value": "EWallet", "description": "EWallet" }, { "name": "TaskOrder", "value": "TaskOrder", "description": "TaskOrder" }, { "name": "DirectDebit", "value": "DirectDebit", "description": "DirectDebit" } ] } }, "PaymentMethodLink": { "type": "object", "description": "A payment method link.", "properties": { "properties": { "$ref": "#/definitions/PaymentMethodLinkProperties", "description": "Payment method link properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PaymentMethodLinkProperties": { "type": "object", "description": "The properties of a payment method link.", "properties": { "accountHolderName": { "type": "string", "description": "The account holder name for the payment method. This is only supported for payment methods with family CreditCard.", "readOnly": true }, "displayName": { "type": "string", "description": "The display name of the payment method.", "readOnly": true }, "expiration": { "type": "string", "description": "The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard.", "readOnly": true }, "family": { "$ref": "#/definitions/PaymentMethodFamily", "description": "The family of payment method.", "readOnly": true }, "lastFourDigits": { "type": "string", "description": "Last four digits of payment method.", "readOnly": true }, "logos": { "type": "array", "description": "The list of logos for the payment method.", "items": { "$ref": "#/definitions/PaymentMethodLogo" }, "readOnly": true, "x-ms-identifiers": [] }, "paymentMethod": { "$ref": "#/definitions/PaymentMethodProperties", "description": "Projection of a payment method. Will not be returned in this or future versions." }, "paymentMethodId": { "type": "string", "description": "Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0" }, "paymentMethodType": { "type": "string", "description": "The type of payment method.", "readOnly": true }, "status": { "$ref": "#/definitions/PaymentMethodStatus", "description": "Status of the payment method.", "readOnly": true } } }, "PaymentMethodLinksListResult": { "type": "object", "description": "The response of a PaymentMethodLink list operation.", "properties": { "value": { "type": "array", "description": "The PaymentMethodLink items on this page", "items": { "$ref": "#/definitions/PaymentMethodLink" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PaymentMethodLogo": { "type": "object", "description": "Logo of payment method.", "properties": { "mimeType": { "type": "string", "description": "MIME type of the logo.", "readOnly": true }, "url": { "type": "string", "description": "Public URL of image of the logo.", "readOnly": true } } }, "PaymentMethodProperties": { "type": "object", "description": "The properties of a payment method.", "properties": { "id": { "type": "string", "description": "Id of payment method.", "readOnly": true }, "accountHolderName": { "type": "string", "description": "The account holder name for the payment method. This is only supported for payment methods with family CreditCard.", "readOnly": true }, "displayName": { "type": "string", "description": "The display name of the payment method.", "readOnly": true }, "expiration": { "type": "string", "description": "The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard.", "readOnly": true }, "family": { "$ref": "#/definitions/PaymentMethodFamily", "description": "The family of payment method." }, "lastFourDigits": { "type": "string", "description": "Last four digits of payment method.", "readOnly": true }, "logos": { "type": "array", "description": "The list of logos for the payment method.", "items": { "$ref": "#/definitions/PaymentMethodLogo" }, "x-ms-identifiers": [] }, "paymentMethodType": { "type": "string", "description": "The type of payment method.", "readOnly": true }, "status": { "$ref": "#/definitions/PaymentMethodStatus", "description": "Status of the payment method." } } }, "PaymentMethodStatus": { "type": "string", "description": "Status of the payment method.", "enum": [ "active", "inactive" ], "x-ms-enum": { "name": "PaymentMethodStatus", "modelAsString": true, "values": [ { "name": "active", "value": "active", "description": "active" }, { "name": "inactive", "value": "inactive", "description": "inactive" } ] } }, "PaymentMethodsListResult": { "type": "object", "description": "The response of a PaymentMethod list operation.", "properties": { "value": { "type": "array", "description": "The PaymentMethod items on this page", "items": { "$ref": "#/definitions/PaymentMethod" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PaymentOnAccount": { "type": "object", "description": "A Payment on Account.", "properties": { "amount": { "$ref": "#/definitions/PaymentOnAccountAmount", "description": "Payment on Account amount." }, "billingProfileId": { "type": "string", "description": "The ID of the billing profile for the payments on account.", "readOnly": true }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile for the payments on account.", "readOnly": true }, "invoiceId": { "type": "string", "description": "The ID of the invoice for which the payments on account was generated.", "readOnly": true }, "invoiceName": { "type": "string", "description": "The name of the invoice for the payments on account.", "readOnly": true }, "date": { "type": "string", "format": "date-time", "description": "The date of the payments on account.", "readOnly": true }, "paymentMethodType": { "$ref": "#/definitions/PaymentMethodFamily", "description": "Payment on Account type.", "readOnly": true } } }, "PaymentOnAccountAmount": { "type": "object", "description": "Payment on Account amount.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "PaymentStatus": { "type": "string", "description": "Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future.", "enum": [ "Succeeded", "Failed", "Scheduled", "Cancelled", "Completed", "Pending" ], "x-ms-enum": { "name": "PaymentStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Scheduled", "value": "Scheduled", "description": "Scheduled" }, { "name": "Cancelled", "value": "Cancelled", "description": "Cancelled" }, { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "Pending", "value": "Pending", "description": "Pending" } ] } }, "PaymentTerm": { "type": "object", "description": "The properties of payment term.", "properties": { "term": { "type": "string", "description": "Represents duration in netXX format. Always in days." }, "startDate": { "type": "string", "format": "date-time", "description": "The date on when the defined 'Payment Term' will be effective from and is always in UTC." }, "endDate": { "type": "string", "format": "date-time", "description": "The date on when the defined 'Payment Term' will end and is always in UTC." }, "isDefault": { "type": "boolean", "description": "Indicates payment term is the standard payment term.", "readOnly": true } } }, "PaymentTermsEligibilityCode": { "type": "string", "description": "Indicates the reason for the ineligibility of the payment terms.", "enum": [ "Other", "OverlappingPaymentTerms", "InvalidDateFormat", "InvalidDateRange", "InactiveBillingAccount", "InvalidBillingAccountType", "NullOrEmptyPaymentTerms", "BillingAccountNotFound", "IneligibleBillingAccountStatus", "InvalidTerms" ], "x-ms-enum": { "name": "PaymentTermsEligibilityCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "OverlappingPaymentTerms", "value": "OverlappingPaymentTerms", "description": "OverlappingPaymentTerms" }, { "name": "InvalidDateFormat", "value": "InvalidDateFormat", "description": "InvalidDateFormat" }, { "name": "InvalidDateRange", "value": "InvalidDateRange", "description": "InvalidDateRange" }, { "name": "InactiveBillingAccount", "value": "InactiveBillingAccount", "description": "InactiveBillingAccount" }, { "name": "InvalidBillingAccountType", "value": "InvalidBillingAccountType", "description": "InvalidBillingAccountType" }, { "name": "NullOrEmptyPaymentTerms", "value": "NullOrEmptyPaymentTerms", "description": "NullOrEmptyPaymentTerms" }, { "name": "BillingAccountNotFound", "value": "BillingAccountNotFound", "description": "BillingAccountNotFound" }, { "name": "IneligibleBillingAccountStatus", "value": "IneligibleBillingAccountStatus", "description": "IneligibleBillingAccountStatus" }, { "name": "InvalidTerms", "value": "InvalidTerms", "description": "InvalidTerms" } ] } }, "PaymentTermsEligibilityDetail": { "type": "object", "description": "Details of the payment terms eligibility.", "properties": { "code": { "$ref": "#/definitions/PaymentTermsEligibilityCode", "description": "Indicates the reason for the ineligibility of the payment terms." }, "message": { "type": "string", "description": "Indicates the message for the ineligibility of the payment terms." } } }, "PaymentTermsEligibilityResult": { "type": "object", "description": "Result of the payment terms eligibility.", "properties": { "eligibilityStatus": { "$ref": "#/definitions/PaymentTermsEligibilityStatus", "description": "Indicates the eligibility status of the payment terms." }, "eligibilityDetails": { "type": "array", "description": "Details of the payment terms eligibility.", "items": { "$ref": "#/definitions/PaymentTermsEligibilityDetail" }, "x-ms-identifiers": [] } } }, "PaymentTermsEligibilityStatus": { "type": "string", "description": "Indicates the eligibility status of the payment terms.", "enum": [ "Other", "Valid", "Invalid" ], "x-ms-enum": { "name": "PaymentTermsEligibilityStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Valid", "value": "Valid", "description": "Valid" }, { "name": "Invalid", "value": "Invalid", "description": "Invalid" } ] } }, "PolicySummary": { "type": "object", "description": "The summary of the policy.", "properties": { "name": { "type": "string", "description": "The name of the policy." }, "value": { "type": "string", "description": "The value of the policy." }, "policyType": { "$ref": "#/definitions/PolicyType", "description": "The type of the policy." }, "scope": { "type": "string", "description": "The scope at which the policy is defined." } } }, "PolicyType": { "type": "string", "description": "The type of the policy.", "enum": [ "Other", "UserControlled", "SystemControlled" ], "x-ms-enum": { "name": "PolicyType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "UserControlled", "value": "UserControlled", "description": "UserControlled" }, { "name": "SystemControlled", "value": "SystemControlled", "description": "SystemControlled" } ] } }, "Price": { "type": "object", "description": "The price.", "properties": { "currencyCode": { "type": "string", "description": "The ISO 4217 3-letter currency code for the currency used by this purchase record." }, "amount": { "type": "number", "format": "double" } } }, "Principal": { "type": "object", "description": "A principal who has interacted with a billing entity.", "properties": { "tenantId": { "type": "string", "description": "The tenant id of the principal who has interacted with a billing entity." }, "objectId": { "type": "string", "description": "The object id of the principal who has interacted with a billing entity." }, "upn": { "type": "string", "description": "The user principal name of the principal who has interacted with a billing entity." } } }, "PrincipalType": { "type": "string", "description": "The type of a role Assignment.", "enum": [ "Unknown", "None", "User", "Group", "DirectoryRole", "ServicePrincipal", "Everyone" ], "x-ms-enum": { "name": "PrincipalType", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "None", "value": "None", "description": "None" }, { "name": "User", "value": "User", "description": "User" }, { "name": "Group", "value": "Group", "description": "Group" }, { "name": "DirectoryRole", "value": "DirectoryRole", "description": "DirectoryRole" }, { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "Everyone", "value": "Everyone", "description": "Everyone" } ] } }, "Product": { "type": "object", "description": "A product.", "properties": { "properties": { "$ref": "#/definitions/ProductProperties", "description": "A product." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ProductDetails": { "type": "object", "description": "Details of the product that is transferred.", "properties": { "productType": { "$ref": "#/definitions/ProductType", "description": "Type of the product that is transferred." }, "productId": { "type": "string", "description": "The ID of the product that is transferred." } } }, "ProductListResult": { "type": "object", "description": "Paged collection of Product items", "properties": { "value": { "type": "array", "description": "The Product items on this page", "items": { "$ref": "#/definitions/Product" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ProductPatch": { "type": "object", "description": "A product.", "properties": { "properties": { "$ref": "#/definitions/ProductProperties", "description": "A product." } }, "allOf": [ { "$ref": "#/definitions/ProxyResourceWithTags" } ] }, "ProductProperties": { "type": "object", "description": "A product.", "properties": { "autoRenew": { "$ref": "#/definitions/AutoRenew", "description": "Indicates whether auto renewal is turned on or off for a product." }, "availabilityId": { "type": "string", "description": "The availability of the product.", "readOnly": true }, "billingFrequency": { "type": "string", "description": "The frequency at which the product will be billed.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "The ID of the billing profile to which the product is billed.", "readOnly": true }, "billingProfileDisplayName": { "type": "string", "description": "The name of the billing profile to which the product is billed.", "readOnly": true }, "customerId": { "type": "string", "description": "The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", "readOnly": true }, "customerDisplayName": { "type": "string", "description": "The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", "readOnly": true }, "displayName": { "type": "string", "description": "The display name of the product.", "readOnly": true }, "endDate": { "type": "string", "description": "The date when the product will be renewed or canceled.", "readOnly": true }, "invoiceSectionId": { "type": "string", "description": "The ID of the invoice section to which the product is billed.", "readOnly": true }, "invoiceSectionDisplayName": { "type": "string", "description": "The name of the invoice section to which the product is billed.", "readOnly": true }, "lastCharge": { "$ref": "#/definitions/ProductPropertiesLastCharge", "description": "The last month charges." }, "lastChargeDate": { "type": "string", "description": "The date of the last charge.", "readOnly": true }, "productType": { "type": "string", "description": "The description of the type of product.", "readOnly": true }, "productTypeId": { "type": "string", "description": "The ID of the type of product.", "readOnly": true }, "skuId": { "type": "string", "description": "The sku ID of the product.", "readOnly": true }, "skuDescription": { "type": "string", "description": "The sku description of the product.", "readOnly": true }, "purchaseDate": { "type": "string", "description": "The date when the product was purchased.", "readOnly": true }, "quantity": { "type": "integer", "format": "int64", "description": "The quantity purchased for the product.", "readOnly": true }, "status": { "$ref": "#/definitions/ProductStatus", "description": "The status of the product.", "readOnly": true }, "tenantId": { "type": "string", "description": "The id of the tenant in which the product is used.", "readOnly": true }, "reseller": { "$ref": "#/definitions/ProductPropertiesReseller", "description": "Reseller for this product. The fields is not available for Microsoft Partner Agreement products." } } }, "ProductPropertiesLastCharge": { "type": "object", "description": "The last month charges.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "ProductPropertiesReseller": { "type": "object", "description": "Reseller for this product. The fields is not available for Microsoft Partner Agreement products.", "allOf": [ { "$ref": "#/definitions/Reseller" } ] }, "ProductStatus": { "type": "string", "description": "The status of the product.", "enum": [ "Other", "Active", "Disabled", "Deleted", "PastDue", "Expiring", "Expired", "AutoRenew", "Canceled", "Suspended" ], "x-ms-enum": { "name": "ProductStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "PastDue", "value": "PastDue", "description": "PastDue" }, { "name": "Expiring", "value": "Expiring", "description": "Expiring" }, { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "AutoRenew", "value": "AutoRenew", "description": "AutoRenew" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Suspended", "value": "Suspended", "description": "Suspended" } ] } }, "ProductTransferStatus": { "type": "string", "description": "The status of a transfer.", "enum": [ "NotStarted", "InProgress", "Completed", "Failed" ], "x-ms-enum": { "name": "ProductTransferStatus", "modelAsString": true, "values": [ { "name": "NotStarted", "value": "NotStarted", "description": "NotStarted" }, { "name": "InProgress", "value": "InProgress", "description": "InProgress" }, { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "Failed", "value": "Failed", "description": "Failed" } ] } }, "ProductType": { "type": "string", "description": "The type of product that is transferred.", "enum": [ "AzureSubscription", "AzureReservation", "Department", "SavingsPlan", "SAAS" ], "x-ms-enum": { "name": "ProductType", "modelAsString": true, "values": [ { "name": "AzureSubscription", "value": "AzureSubscription", "description": "AzureSubscription" }, { "name": "AzureReservation", "value": "AzureReservation", "description": "AzureReservation" }, { "name": "Department", "value": "Department", "description": "Department" }, { "name": "SavingsPlan", "value": "SavingsPlan", "description": "SavingsPlan" }, { "name": "SAAS", "value": "SAAS", "description": "SAAS" } ] } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of the resource during a long-running operation.", "enum": [ "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", "Expired" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "New", "value": "New", "description": "New" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "Provisioning", "value": "Provisioning", "description": "Provisioning" }, { "name": "PendingBilling", "value": "PendingBilling", "description": "PendingBilling" }, { "name": "ConfirmedBilling", "value": "ConfirmedBilling", "description": "ConfirmedBilling" }, { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "Created", "value": "Created", "description": "Created" }, { "name": "Expired", "value": "Expired", "description": "Expired" } ] } }, "ProvisioningTenantState": { "type": "string", "description": "The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request.", "enum": [ "Other", "NotRequested", "Active", "Pending", "BillingRequestExpired", "BillingRequestDeclined", "Revoked" ], "x-ms-enum": { "name": "ProvisioningTenantState", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "NotRequested", "value": "NotRequested", "description": "NotRequested" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "BillingRequestExpired", "value": "BillingRequestExpired", "description": "BillingRequestExpired" }, { "name": "BillingRequestDeclined", "value": "BillingRequestDeclined", "description": "BillingRequestDeclined" }, { "name": "Revoked", "value": "Revoked", "description": "Revoked" } ] } }, "ProxyResourceWithTags": { "type": "object", "description": "Common fields that are returned in the response for all Azure Resource Manager resources.", "properties": { "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PurchaseRequest": { "type": "object", "description": "Purchase request.", "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "The SKU to be applied for this resource" }, "properties": { "$ref": "#/definitions/PurchaseRequestProperties", "description": "Purchase request properties.", "x-ms-client-flatten": true } } }, "PurchaseRequestProperties": { "type": "object", "description": "Purchase request properties.", "properties": { "displayName": { "type": "string", "description": "Friendly name of the savings plan" }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing SavingsPlan" }, "term": { "$ref": "#/definitions/SavingsPlanTerm", "description": "Represents the Savings plan term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly purchases." }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "commitment": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." } } }, "RebillDetails": { "type": "object", "description": "The rebill details of an invoice.", "properties": { "invoiceDocumentId": { "type": "string", "description": "The ID of invoice.", "readOnly": true }, "creditNoteDocumentId": { "type": "string", "description": "The ID of credit note.", "readOnly": true }, "rebillDetails": { "$ref": "#/definitions/RebillDetails", "description": "The rebill details of an invoice.", "readOnly": true } } }, "RecipientTransferDetails": { "type": "object", "description": "Details of the transfer.", "properties": { "properties": { "$ref": "#/definitions/RecipientTransferProperties", "description": "Details of the transfer.", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "RecipientTransferDetailsListResult": { "type": "object", "description": "Paged collection of RecipientTransferDetails items", "properties": { "value": { "type": "array", "description": "The RecipientTransferDetails items on this page", "items": { "$ref": "#/definitions/RecipientTransferDetails" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecipientTransferProperties": { "type": "object", "description": "Transfer Details.", "properties": { "expirationTime": { "type": "string", "format": "date-time", "description": "The time at which the transfer request expires.", "readOnly": true }, "allowedProductType": { "type": "array", "description": "Type of subscriptions that can be transferred.", "items": { "$ref": "#/definitions/EligibleProductType" }, "readOnly": true }, "transferStatus": { "$ref": "#/definitions/TransferStatus", "description": "Overall transfer status.", "readOnly": true }, "recipientEmailId": { "type": "string", "description": "The email ID of the user to whom the transfer request was sent.", "readOnly": true }, "initiatorEmailId": { "type": "string", "description": "The email ID of the user who sent the transfer request.", "readOnly": true }, "resellerId": { "type": "string", "description": "Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account.", "readOnly": true }, "resellerName": { "type": "string", "description": "Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account.", "readOnly": true }, "initiatorCustomerType": { "$ref": "#/definitions/InitiatorCustomerType", "description": "The type of customer who sent the transfer request.", "readOnly": true }, "canceledBy": { "type": "string", "description": "The email ID of the user who canceled the transfer request.", "readOnly": true }, "detailedTransferStatus": { "type": "array", "description": "Detailed transfer status.", "items": { "$ref": "#/definitions/DetailedTransferStatus" }, "readOnly": true, "x-ms-identifiers": [] }, "customerTenantId": { "type": "string", "description": "The customer tenant id.", "readOnly": true }, "supportedAccounts": { "type": "array", "description": "List of supported account types.", "items": { "$ref": "#/definitions/SupportedAccountType" }, "readOnly": true } } }, "RefundDetailsSummary": { "type": "object", "description": "The details of refund request.", "properties": { "requestedOn": { "type": "string", "format": "date-time", "description": "Date when the refund was requested.", "readOnly": true }, "approvedOn": { "type": "string", "format": "date-time", "description": "Date when the refund was approved.", "readOnly": true }, "completedOn": { "type": "string", "format": "date-time", "description": "Date when the refund was completed.", "readOnly": true }, "amountRequested": { "$ref": "#/definitions/RefundDetailsSummaryAmountRequested", "description": "The amount of refund requested." }, "amountRefunded": { "$ref": "#/definitions/RefundDetailsSummaryAmountRefunded", "description": "The amount refunded." }, "rebillInvoiceId": { "type": "string", "description": "The invoice ID of the rebill invoice for a refund.", "readOnly": true }, "transactionCount": { "type": "integer", "format": "int32", "description": "The number of transactions refunded.", "readOnly": true }, "refundStatus": { "$ref": "#/definitions/RefundStatus", "description": "The status of refund request.", "readOnly": true }, "refundOperationId": { "type": "string", "description": "The ID of refund operation.", "readOnly": true }, "refundReason": { "$ref": "#/definitions/RefundReasonCode", "description": "The reason for refund.", "readOnly": true } } }, "RefundDetailsSummaryAmountRefunded": { "type": "object", "description": "The amount refunded.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "RefundDetailsSummaryAmountRequested": { "type": "object", "description": "The amount of refund requested.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "RefundReasonCode": { "type": "string", "description": "The reason for refund.", "enum": [ "Other", "AccidentalConversion", "UnclearPricing", "AccidentalPurchase", "ForgotToCancel", "UnclearDocumentation" ], "x-ms-enum": { "name": "RefundReasonCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "AccidentalConversion", "value": "AccidentalConversion", "description": "AccidentalConversion" }, { "name": "UnclearPricing", "value": "UnclearPricing", "description": "UnclearPricing" }, { "name": "AccidentalPurchase", "value": "AccidentalPurchase", "description": "AccidentalPurchase" }, { "name": "ForgotToCancel", "value": "ForgotToCancel", "description": "ForgotToCancel" }, { "name": "UnclearDocumentation", "value": "UnclearDocumentation", "description": "UnclearDocumentation" } ] } }, "RefundStatus": { "type": "string", "description": "The status of refund request.", "enum": [ "Other", "Pending", "Approved", "Declined", "Cancelled", "Completed", "Expired" ], "x-ms-enum": { "name": "RefundStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "Approved", "value": "Approved", "description": "Approved" }, { "name": "Declined", "value": "Declined", "description": "Declined" }, { "name": "Cancelled", "value": "Cancelled", "description": "Cancelled" }, { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "Expired", "value": "Expired", "description": "Expired" } ] } }, "RefundTransactionDetails": { "type": "object", "description": "The refund details of a transaction.", "properties": { "amountRequested": { "$ref": "#/definitions/RefundTransactionDetailsAmountRequested", "description": "The amount of refund requested." }, "amountRefunded": { "$ref": "#/definitions/RefundTransactionDetailsAmountRefunded", "description": "The amount refunded." }, "refundOperationId": { "type": "string", "description": "The ID of refund operation." } } }, "RefundTransactionDetailsAmountRefunded": { "type": "object", "description": "The amount refunded.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "RefundTransactionDetailsAmountRequested": { "type": "object", "description": "The amount of refund requested.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "RegistrationNumber": { "type": "object", "description": "Describes the registration number of the organization linked with the billing account.", "properties": { "id": { "type": "string", "description": "The unique identification number of the organization linked with the billing account." }, "required": { "type": "boolean", "description": "Identifies if the registration number is required for the billing account.", "readOnly": true }, "type": { "type": "array", "description": "The types of registration number allowed based on the country of the billing account.", "items": { "type": "string" }, "readOnly": true } } }, "RenewProperties": { "type": "object", "description": "Properties specific to renew.", "properties": { "purchaseProperties": { "$ref": "#/definitions/PurchaseRequest", "description": "Purchase request." } } }, "RenewPropertiesResponse": { "type": "object", "description": "The renew properties for a reservation.", "properties": { "purchaseProperties": { "$ref": "#/definitions/ReservationPurchaseRequest", "description": "The request for reservation purchase" }, "pricingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry." }, "billingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included." } } }, "RenewalTermDetails": { "type": "object", "description": "Details for the next renewal term of a subscription.", "properties": { "billingFrequency": { "type": "string", "description": "The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y", "readOnly": true }, "productId": { "type": "string", "description": "Id of the product for which the subscription is purchased.", "readOnly": true }, "productTypeId": { "type": "string", "description": "Type Id of the product for which the subscription is purchased.", "readOnly": true }, "skuId": { "type": "string", "description": "The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.", "readOnly": true }, "termDuration": { "type": "string", "description": "The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y", "readOnly": true }, "quantity": { "type": "integer", "format": "int64", "description": "The quantity of licenses or fulfillment units for the subscription." }, "termEndDate": { "type": "string", "format": "date-time", "description": "End date of the term in UTC time.", "readOnly": true } } }, "Reseller": { "type": "object", "description": "Details of the reseller.", "properties": { "resellerId": { "type": "string", "description": "The MPN ID of the reseller.", "readOnly": true }, "description": { "type": "string", "description": "The name of the reseller.", "readOnly": true } } }, "Reservation": { "type": "object", "description": "The definition of the reservation.", "properties": { "properties": { "$ref": "#/definitions/ReservationProperty", "description": "The properties associated to this reservation", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The location of the reservation.", "x-ms-mutability": [ "read", "create" ] }, "etag": { "type": "integer", "format": "int32" }, "tags": { "type": "object", "description": "Tags for this reservation", "additionalProperties": { "type": "string" } }, "sku": { "$ref": "#/definitions/ReservationSkuProperty", "description": "The sku information associated to this reservation" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ReservationAppliedScopeProperties": { "type": "object", "description": "Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup", "properties": { "tenantId": { "type": "string", "description": "Tenant ID where the reservation should apply benefit." }, "managementGroupId": { "type": "string", "description": "Fully-qualified identifier of the management group where the benefit must be applied." }, "subscriptionId": { "type": "string", "description": "Fully-qualified identifier of the subscription." }, "resourceGroupId": { "type": "string", "description": "Fully-qualified identifier of the resource group." }, "displayName": { "type": "string", "description": "Display name" } } }, "ReservationBillingPlan": { "type": "string", "description": "Represent the billing plans.", "enum": [ "Upfront", "Monthly" ], "x-ms-enum": { "name": "ReservationBillingPlan", "modelAsString": true, "values": [ { "name": "Upfront", "value": "Upfront", "description": "Upfront" }, { "name": "Monthly", "value": "Monthly", "description": "Monthly" } ] } }, "ReservationExtendedStatusInfo": { "type": "object", "description": "Extended status information for the reservation.", "properties": { "statusCode": { "$ref": "#/definitions/ReservationStatusCode", "description": "The status of the reservation." }, "message": { "type": "string", "description": "The message giving detailed information about the status code." }, "properties": { "$ref": "#/definitions/ExtendedStatusDefinitionProperties", "description": "Properties for extended status information" } } }, "ReservationList": { "type": "object", "description": "List of `Reservations`", "properties": { "value": { "type": "array", "description": "The Reservation items on this page", "items": { "$ref": "#/definitions/Reservation" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ReservationMergeProperties": { "type": "object", "description": "Properties of reservation merge", "properties": { "mergeDestination": { "type": "string", "description": "Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" }, "mergeSources": { "type": "array", "description": "Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}", "items": { "type": "string" } } } }, "ReservationOrder": { "type": "object", "description": "Details of a reservation order being returned.", "properties": { "properties": { "$ref": "#/definitions/ReservationOrderProperty", "description": "The properties associated to this reservation order", "x-ms-client-flatten": true }, "etag": { "type": "integer", "format": "int32" }, "tags": { "type": "object", "description": "Tags for this reservation", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ReservationOrderBillingPlanInformation": { "type": "object", "description": "Information describing the type of billing plan for this reservation order.", "properties": { "pricingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount of money to be paid for the Order. Tax is not included." }, "startDate": { "type": "string", "format": "date", "description": "Date when the billing plan has started." }, "nextPaymentDueDate": { "type": "string", "format": "date", "description": "For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off." }, "transactions": { "type": "array", "items": { "$ref": "#/definitions/ReservationPaymentDetail" }, "x-ms-identifiers": [] } } }, "ReservationOrderList": { "type": "object", "description": "List of ReservationOrders", "properties": { "value": { "type": "array", "description": "The ReservationOrder items on this page", "items": { "$ref": "#/definitions/ReservationOrder" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ReservationOrderProperty": { "type": "object", "description": "Properties of a reservation order.", "properties": { "displayName": { "type": "string", "description": "Friendly name for user to easily identified the reservation order." }, "enrollmentId": { "type": "string", "description": "Enrollment id of the reservation order." }, "customerId": { "type": "string", "description": "Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers." }, "billingProfileId": { "type": "string", "description": "Billing profile Id associated to this reservation order." }, "billingAccountId": { "type": "string", "description": "Billing account Id associated to this reservation order." }, "requestDateTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the reservation order was initially requested for purchase." }, "createdDateTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the reservation order was created." }, "expiryDate": { "type": "string", "format": "date", "description": "This is the date when the reservation order will expire." }, "expiryDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the reservation order will expire." }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the reservation benefit started." }, "originalQuantity": { "type": "integer", "format": "int32", "description": "Total original quantity of the skus purchased in the reservation order." }, "term": { "type": "string", "description": "The term of the reservation, e.g. P1Y", "readOnly": true }, "provisioningState": { "type": "string", "description": "The provisioning state of the reservation, e.g. Succeeded", "readOnly": true }, "billingPlan": { "$ref": "#/definitions/ReservationBillingPlan", "description": "Represent the billing plans." }, "planInformation": { "$ref": "#/definitions/ReservationOrderBillingPlanInformation", "description": "Information describing the type of billing plan for this reservation order." }, "reservations": { "type": "array", "items": { "$ref": "#/definitions/Reservation" } }, "reviewDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the Azure Hybrid Benefit needs to be reviewed." }, "extendedStatusInfo": { "$ref": "#/definitions/ReservationExtendedStatusInfo", "description": "Extended status information for the reservation." }, "productCode": { "type": "string", "description": "Represents UPN" } } }, "ReservationPaymentDetail": { "type": "object", "description": "Information about payment related to a reservation order.", "properties": { "dueDate": { "type": "string", "format": "date", "description": "Date when the payment needs to be done." }, "paymentDate": { "type": "string", "format": "date", "description": "Date when the transaction is completed. Is null when it is scheduled." }, "pricingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount in pricing currency. Tax not included." }, "billingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount charged in Billing currency. Tax not included. Is null for future payments" }, "billingAccount": { "type": "string", "description": "Shows the Account that is charged for this payment." }, "status": { "$ref": "#/definitions/PaymentStatus", "description": "Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future." }, "extendedStatusInfo": { "$ref": "#/definitions/ReservationExtendedStatusInfo", "description": "Extended status information for the reservation." } } }, "ReservationProperty": { "type": "object", "description": "The property of reservation object.", "properties": { "reservedResourceType": { "type": "string", "description": "The reserved source type of the reservation, e.g. virtual machine.", "readOnly": true }, "instanceFlexibility": { "$ref": "#/definitions/InstanceFlexibility", "description": "Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility." }, "displayName": { "type": "string", "description": "The display name of the reservation", "readOnly": true }, "appliedScopes": { "type": "array", "description": "The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope", "items": { "type": "string" } }, "appliedScopeType": { "type": "string", "description": "The applied scope type of the reservation.", "readOnly": true }, "archived": { "type": "boolean", "description": "Indicates if the reservation is archived" }, "capabilities": { "type": "string", "description": "Capabilities of the reservation" }, "quantity": { "type": "number", "format": "float", "description": "The number of the reservation.", "readOnly": true }, "provisioningState": { "type": "string", "description": "The provisioning state of the reservation, e.g. Succeeded", "readOnly": true }, "effectiveDateTime": { "type": "string", "format": "date-time", "description": "The effective date time of the reservation", "readOnly": true }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the reservation benefit started." }, "lastUpdatedDateTime": { "type": "string", "format": "date-time", "description": "DateTime of the last time the reservation was updated.", "readOnly": true }, "expiryDate": { "type": "string", "description": "The expiry date of the reservation", "readOnly": true }, "expiryDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the reservation will expire." }, "reviewDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the Azure Hybrid Benefit needs to be reviewed." }, "skuDescription": { "type": "string", "description": "The sku description of the reservation", "readOnly": true }, "extendedStatusInfo": { "$ref": "#/definitions/ReservationExtendedStatusInfo", "description": "The message giving detailed information about the status code." }, "billingPlan": { "$ref": "#/definitions/ReservationBillingPlan", "description": "The billing plan options available for this sku." }, "displayProvisioningState": { "type": "string", "description": "The provisioning state of the reservation for display, e.g. Succeeded", "readOnly": true }, "provisioningSubState": { "type": "string", "description": "The provisioning state of the reservation, e.g. Succeeded", "readOnly": true }, "purchaseDate": { "type": "string", "format": "date", "description": "This is the date when the reservation was purchased." }, "purchaseDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the reservation was purchased." }, "splitProperties": { "$ref": "#/definitions/ReservationSplitProperties", "description": "Properties of reservation split" }, "mergeProperties": { "$ref": "#/definitions/ReservationMergeProperties", "description": "Properties of reservation merge" }, "swapProperties": { "$ref": "#/definitions/ReservationSwapProperties", "description": "Properties of reservation swap" }, "appliedScopeProperties": { "$ref": "#/definitions/ReservationAppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup" }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing reservation or savings plan", "readOnly": true }, "renew": { "type": "boolean", "description": "The renew state of the reservation", "readOnly": true }, "renewSource": { "type": "string", "description": "The renew source of the reservation", "readOnly": true }, "renewDestination": { "type": "string", "description": "Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}." }, "renewProperties": { "$ref": "#/definitions/RenewPropertiesResponse", "description": "The renew properties for a reservation." }, "term": { "type": "string", "description": "The term of the reservation, e.g. P1Y", "readOnly": true }, "userFriendlyAppliedScopeType": { "type": "string", "description": "The applied scope type of the reservation for display, e.g. Shared", "readOnly": true }, "userFriendlyRenewState": { "type": "string", "description": "The renew state of the reservation for display, e.g. On", "readOnly": true }, "utilization": { "$ref": "#/definitions/ReservationPropertyUtilization", "description": "Reservation utilization", "readOnly": true, "x-ms-client-flatten": true }, "productCode": { "type": "string", "description": "Represents UPN" } } }, "ReservationPropertyUtilization": { "type": "object", "description": "Reservation utilization", "properties": { "trend": { "type": "string", "description": "last 7 day utilization trend for a reservation", "readOnly": true }, "aggregates": { "type": "array", "description": "The array of aggregates of a reservation's utilization", "items": { "$ref": "#/definitions/ReservationUtilizationAggregates" }, "x-ms-identifiers": [] } } }, "ReservationPurchaseRequest": { "type": "object", "description": "The request for reservation purchase", "properties": { "sku": { "$ref": "#/definitions/SkuName", "description": "The name of sku" }, "location": { "type": "string", "description": "The Azure region where the reserved resource lives.", "x-ms-mutability": [ "read", "create" ] }, "properties": { "$ref": "#/definitions/ReservationPurchaseRequestProperties", "description": "Properties of reservation purchase request", "x-ms-client-flatten": true } } }, "ReservationPurchaseRequestProperties": { "type": "object", "description": "Properties of reservation purchase request", "properties": { "reservedResourceType": { "type": "string", "description": "The reserved source type of the reservation, e.g. virtual machine.", "readOnly": true }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing reservation or savings plan", "readOnly": true }, "term": { "type": "string", "description": "The term of the reservation, e.g. P1Y", "readOnly": true }, "billingPlan": { "$ref": "#/definitions/ReservationBillingPlan", "description": "Represent the billing plans." }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity of the skus that are part of the reservation. Must be greater than zero." }, "displayName": { "type": "string", "description": "Friendly name of the reservation" }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopes": { "type": "array", "description": "List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared.", "items": { "type": "string" } }, "appliedScopeProperties": { "$ref": "#/definitions/ReservationAppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup" }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "reservedResourceProperties": { "$ref": "#/definitions/ReservationPurchaseRequestPropertiesReservedResourceProperties", "description": "Properties specific to each reserved resource type. Not required if not applicable.", "x-ms-client-flatten": true }, "instanceFlexibility": { "$ref": "#/definitions/InstanceFlexibility", "description": "Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility." }, "reviewDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the Azure hybrid benefit needs to be reviewed." } } }, "ReservationPurchaseRequestPropertiesReservedResourceProperties": { "type": "object", "description": "Properties specific to each reserved resource type. Not required if not applicable.", "properties": { "instanceFlexibility": { "$ref": "#/definitions/InstanceFlexibility", "description": "Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type." } } }, "ReservationPurchasesPolicy": { "type": "string", "description": "The policy that controls whether Azure reservation purchases are allowed.", "enum": [ "Other", "Allowed", "Disabled", "NotAllowed" ], "x-ms-enum": { "name": "ReservationPurchasesPolicy", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "ReservationSkuProperty": { "type": "object", "description": "The property of reservation sku object.", "properties": { "name": { "type": "string", "description": "The name of the reservation sku.", "readOnly": true } } }, "ReservationSplitProperties": { "type": "object", "description": "Properties of reservation split", "properties": { "splitDestinations": { "type": "array", "description": "List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}", "items": { "type": "string" } }, "splitSource": { "type": "string", "description": "Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" } } }, "ReservationStatusCode": { "type": "string", "description": "The status of the reservation.", "enum": [ "None", "Pending", "Processing", "Active", "PurchaseError", "PaymentInstrumentError", "Split", "Merged", "Expired", "Succeeded", "CapacityError", "CapacityRestricted", "Exchanged", "UnknownError", "RiskCheckFailed", "CreditLineCheckFailed", "Warning", "NoBenefitDueToSubscriptionTransfer", "NoBenefitDueToSubscriptionDeletion", "NoBenefit" ], "x-ms-enum": { "name": "ReservationStatusCode", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "Processing", "value": "Processing", "description": "Processing" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "PurchaseError", "value": "PurchaseError", "description": "PurchaseError" }, { "name": "PaymentInstrumentError", "value": "PaymentInstrumentError", "description": "PaymentInstrumentError" }, { "name": "Split", "value": "Split", "description": "Split" }, { "name": "Merged", "value": "Merged", "description": "Merged" }, { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "CapacityError", "value": "CapacityError", "description": "CapacityError" }, { "name": "CapacityRestricted", "value": "CapacityRestricted", "description": "CapacityRestricted" }, { "name": "Exchanged", "value": "Exchanged", "description": "Exchanged" }, { "name": "UnknownError", "value": "UnknownError", "description": "UnknownError" }, { "name": "RiskCheckFailed", "value": "RiskCheckFailed", "description": "RiskCheckFailed" }, { "name": "CreditLineCheckFailed", "value": "CreditLineCheckFailed", "description": "CreditLineCheckFailed" }, { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "NoBenefitDueToSubscriptionTransfer", "value": "NoBenefitDueToSubscriptionTransfer", "description": "NoBenefitDueToSubscriptionTransfer" }, { "name": "NoBenefitDueToSubscriptionDeletion", "value": "NoBenefitDueToSubscriptionDeletion", "description": "NoBenefitDueToSubscriptionDeletion" }, { "name": "NoBenefit", "value": "NoBenefit", "description": "NoBenefit" } ] } }, "ReservationSummary": { "type": "object", "description": "The roll up count summary of reservations in each state", "properties": { "cancelledCount": { "type": "number", "format": "float", "description": "The number of reservation in Cancelled state", "readOnly": true }, "expiredCount": { "type": "number", "format": "float", "description": "The number of reservation in Expired state", "readOnly": true }, "expiringCount": { "type": "number", "format": "float", "description": "The number of reservation in Expiring state", "readOnly": true }, "failedCount": { "type": "number", "format": "float", "description": "The number of reservation in Failed state", "readOnly": true }, "pendingCount": { "type": "number", "format": "float", "description": "The number of reservation in Pending state", "readOnly": true }, "succeededCount": { "type": "number", "format": "float", "description": "The number of reservation in Succeeded state", "readOnly": true }, "noBenefitCount": { "type": "number", "format": "float", "description": "The number of reservation in 'No Benefit' state", "readOnly": true }, "warningCount": { "type": "number", "format": "float", "description": "The number of reservation in Warning state", "readOnly": true }, "processingCount": { "type": "number", "format": "float", "description": "The number of reservation in Processing state", "readOnly": true } } }, "ReservationSwapProperties": { "type": "object", "description": "Properties of reservation swap", "properties": { "swapSource": { "type": "string", "description": "Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" }, "swapDestination": { "type": "string", "description": "Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" } } }, "ReservationUtilizationAggregates": { "type": "object", "description": "The aggregate values of reservation utilization", "properties": { "grain": { "type": "number", "format": "float", "description": "The grain of the aggregate", "readOnly": true }, "grainUnit": { "type": "string", "description": "The grain unit of the aggregate", "readOnly": true }, "value": { "type": "number", "format": "float", "description": "The aggregate value", "readOnly": true }, "valueUnit": { "type": "string", "description": "The aggregate value unit", "readOnly": true } } }, "ReservationsListResult": { "type": "object", "description": "The list of reservations and summary of roll out count of reservations in each state.", "properties": { "nextLink": { "type": "string", "format": "uri", "description": "The link (url) to the next page of results.", "readOnly": true }, "summary": { "$ref": "#/definitions/ReservationSummary", "description": "The roll out count summary of the reservations" }, "value": { "type": "array", "description": "The list of reservations.", "items": { "$ref": "#/definitions/Reservation" }, "readOnly": true } } }, "SavingsPlanModel": { "type": "object", "description": "Savings plan", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanModelProperties", "description": "Savings plan properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } }, "sku": { "$ref": "#/definitions/Sku", "description": "Savings plan SKU" } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SavingsPlanModelList": { "type": "object", "description": "List of savings plans", "properties": { "value": { "type": "array", "description": "The SavingsPlanModel items on this page", "items": { "$ref": "#/definitions/SavingsPlanModel" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SavingsPlanModelListResult": { "type": "object", "description": "List of savings plans", "properties": { "summary": { "$ref": "#/definitions/SavingsPlanSummaryCount", "description": "The roll out count summary of the savings plans" } }, "required": [ "summary" ], "allOf": [ { "$ref": "#/definitions/SavingsPlanModelList" } ] }, "SavingsPlanModelProperties": { "type": "object", "description": "Savings plan properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "displayProvisioningState": { "type": "string", "description": "The provisioning state of the savings plan for display, e.g. Succeeded", "readOnly": true }, "userFriendlyAppliedScopeType": { "type": "string", "description": "The applied scope type of the savings plan for display, e.g. Shared", "readOnly": true }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing SavingsPlan" }, "billingProfileId": { "type": "string", "description": "Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.", "readOnly": true }, "customerId": { "type": "string", "description": "Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.", "readOnly": true }, "billingAccountId": { "type": "string", "description": "Fully-qualified identifier of the billing account where the savings plan is applied.", "readOnly": true }, "term": { "$ref": "#/definitions/SavingsPlanTerm", "description": "Represents the Savings plan term in ISO 8601 format." }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "renewSource": { "type": "string", "description": "SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed." }, "renewDestination": { "type": "string", "description": "SavingsPlan Id of the SavingsPlan which is purchased because of renew." }, "renewProperties": { "$ref": "#/definitions/RenewProperties", "description": "Properties specific to renew." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly purchases." }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." }, "commitment": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." }, "effectiveDateTime": { "type": "string", "format": "date-time", "description": "DateTime of the savings plan starting when this version is effective from.", "readOnly": true }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the savings plan benefit starts.", "readOnly": true }, "expiryDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the savings plan will expire.", "readOnly": true }, "purchaseDateTime": { "type": "string", "format": "date-time", "description": "Date time when the savings plan was purchased.", "readOnly": true }, "utilization": { "$ref": "#/definitions/Utilization", "description": "Savings plan utilization", "readOnly": true }, "extendedStatusInfo": { "$ref": "#/definitions/ExtendedStatusInfo", "description": "Extended status information", "readOnly": true }, "productCode": { "type": "string", "description": "Represents UPN" } } }, "SavingsPlanOrderModel": { "type": "object", "description": "Savings plan order", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanOrderModelProperties", "description": "Savings plan order properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } }, "sku": { "$ref": "#/definitions/Sku", "description": "Savings plan SKU" } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SavingsPlanOrderModelList": { "type": "object", "description": "List of savings plan orders", "properties": { "value": { "type": "array", "description": "The SavingsPlanOrderModel items on this page", "items": { "$ref": "#/definitions/SavingsPlanOrderModel" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SavingsPlanOrderModelProperties": { "type": "object", "description": "Savings plan order properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "provisioningState": { "type": "string", "description": "The provisioning state of the savings plan, e.g. Succeeded", "readOnly": true }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing SavingsPlan" }, "billingProfileId": { "type": "string", "description": "Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.", "readOnly": true }, "customerId": { "type": "string", "description": "Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.", "readOnly": true }, "billingAccountId": { "type": "string", "description": "Fully-qualified identifier of the billing account where the savings plan is applied.", "readOnly": true }, "term": { "$ref": "#/definitions/SavingsPlanTerm", "description": "Represents the Savings plan term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly purchases." }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "DateTime when the savings plan benefit started.", "readOnly": true }, "expiryDateTime": { "type": "string", "format": "date-time", "description": "DateTime when the savings plan will expire.", "readOnly": true }, "planInformation": { "$ref": "#/definitions/BillingPlanInformation", "description": "Information describing the type of billing plan for this savings plan." }, "savingsPlans": { "type": "array", "items": { "type": "string" } }, "extendedStatusInfo": { "$ref": "#/definitions/ExtendedStatusInfo", "description": "Extended status information", "readOnly": true }, "productCode": { "type": "string", "description": "Represents UPN" } } }, "SavingsPlanPurchasesPolicy": { "type": "string", "description": "The policy that controls whether users with Azure savings plan purchase are allowed.", "enum": [ "Other", "Allowed", "Disabled", "NotAllowed" ], "x-ms-enum": { "name": "SavingsPlanPurchasesPolicy", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "SavingsPlanSummaryCount": { "type": "object", "description": "The roll up count summary of savings plans in each state", "properties": { "succeededCount": { "type": "number", "format": "float", "description": "The number of savings plans in Succeeded state", "readOnly": true }, "failedCount": { "type": "number", "format": "float", "description": "The number of savings plans in Failed state", "readOnly": true }, "expiringCount": { "type": "number", "format": "float", "description": "The number of savings plans in Expiring state", "readOnly": true }, "expiredCount": { "type": "number", "format": "float", "description": "The number of savings plans in Expired state", "readOnly": true }, "pendingCount": { "type": "number", "format": "float", "description": "The number of savings plans in Pending state", "readOnly": true }, "cancelledCount": { "type": "number", "format": "float", "description": "The number of savings plans in Cancelled state", "readOnly": true }, "processingCount": { "type": "number", "format": "float", "description": "The number of savings plans in Processing state", "readOnly": true }, "noBenefitCount": { "type": "number", "format": "float", "description": "The number of savings plans in No Benefit state", "readOnly": true }, "warningCount": { "type": "number", "format": "float", "description": "The number of savings plans in Warning state", "readOnly": true } } }, "SavingsPlanTerm": { "type": "string", "description": "Represents the Savings plan term in ISO 8601 format.", "enum": [ "P1Y", "P3Y", "P5Y" ], "x-ms-enum": { "name": "SavingsPlanTerm", "modelAsString": true, "values": [ { "name": "P1Y", "value": "P1Y", "description": "P1Y" }, { "name": "P3Y", "value": "P3Y", "description": "P3Y" }, { "name": "P5Y", "value": "P5Y", "description": "P5Y" } ] } }, "SavingsPlanUpdateRequest": { "type": "object", "description": "Savings plan patch request", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanUpdateRequestProperties", "description": "Savings plan patch request" }, "sku": { "$ref": "#/definitions/Sku", "description": "The SKU to be applied for this resource" }, "tags": { "type": "object", "description": "Tags for this reservation", "additionalProperties": { "type": "string" } } } }, "SavingsPlanUpdateRequestProperties": { "type": "object", "description": "Savings plan patch request", "properties": { "displayName": { "type": "string", "description": "Display name" }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "renewProperties": { "$ref": "#/definitions/RenewProperties", "description": "Properties specific to renew." } } }, "SavingsPlanUpdateValidateRequest": { "type": "object", "description": "Savings plan update validate request.", "properties": { "benefits": { "type": "array", "description": "The benefits of a savings plan.", "items": { "$ref": "#/definitions/SavingsPlanUpdateRequestProperties" }, "x-ms-identifiers": [] } } }, "SavingsPlanValidResponseProperty": { "type": "object", "description": "Benefit scope response property", "properties": { "valid": { "type": "boolean", "description": "Indicates if the provided input is valid" }, "reasonCode": { "type": "string", "description": "Failure reason code if the provided input is invalid" }, "reason": { "type": "string", "description": "Failure reason if the provided input is invalid" } } }, "SavingsPlanValidateResponse": { "type": "object", "description": "Savings plan update validate response.", "properties": { "benefits": { "type": "array", "items": { "$ref": "#/definitions/SavingsPlanValidResponseProperty" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "Url to get the next page." } } }, "Sku": { "type": "object", "description": "The SKU to be applied for this resource", "properties": { "name": { "type": "string", "description": "Name of the SKU to be applied" } } }, "SkuName": { "type": "object", "description": "The name of sku", "properties": { "name": { "type": "string" } } }, "SpecialTaxationType": { "type": "string", "description": "Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.", "enum": [ "SubtotalLevel", "InvoiceLevel" ], "x-ms-enum": { "name": "SpecialTaxationType", "modelAsString": true, "values": [ { "name": "SubtotalLevel", "value": "SubtotalLevel", "description": "SubtotalLevel" }, { "name": "InvoiceLevel", "value": "InvoiceLevel", "description": "InvoiceLevel" } ] } }, "SpendingLimit": { "type": "string", "description": "The billing profile spending limit.", "enum": [ "Off", "On" ], "x-ms-enum": { "name": "SpendingLimit", "modelAsString": true, "values": [ { "name": "Off", "value": "Off", "description": "Off" }, { "name": "On", "value": "On", "description": "On" } ] } }, "SpendingLimitDetails": { "type": "object", "description": "The billing profile spending limit.", "properties": { "amount": { "type": "number", "format": "float", "description": "The initial amount for the billing profile." }, "currency": { "type": "string", "description": "The currency in which the charges for the billing profile are billed." }, "startDate": { "type": "string", "format": "date-time", "description": "The date when this spending limit goes into effect." }, "endDate": { "type": "string", "format": "date-time", "description": "The date when this spending limit is no longer in effect." }, "type": { "$ref": "#/definitions/SpendingLimitType", "description": "The type of spending limit." }, "status": { "$ref": "#/definitions/SpendingLimitStatus", "description": "The status of current spending limit." } } }, "SpendingLimitStatus": { "type": "string", "description": "The status of current spending limit.", "enum": [ "Other", "None", "Active", "Expired", "LimitReached", "LimitRemoved" ], "x-ms-enum": { "name": "SpendingLimitStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "None", "value": "None", "description": "None" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "LimitReached", "value": "LimitReached", "description": "LimitReached" }, { "name": "LimitRemoved", "value": "LimitRemoved", "description": "LimitRemoved" } ] } }, "SpendingLimitType": { "type": "string", "description": "The type of spending limit.", "enum": [ "Other", "None", "FreeAccount", "Sandbox", "AzureForStudents", "AcademicSponsorship", "AzureConsumptionCredit", "AzurePassSponsorship", "MpnSponsorship", "MSDN", "NonProfitSponsorship", "Sponsorship", "StartupSponsorship", "AzureForStudentsStarter", "VisualStudio" ], "x-ms-enum": { "name": "SpendingLimitType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "None", "value": "None", "description": "None" }, { "name": "FreeAccount", "value": "FreeAccount", "description": "FreeAccount" }, { "name": "Sandbox", "value": "Sandbox", "description": "Sandbox" }, { "name": "AzureForStudents", "value": "AzureForStudents", "description": "AzureForStudents" }, { "name": "AcademicSponsorship", "value": "AcademicSponsorship", "description": "AcademicSponsorship" }, { "name": "AzureConsumptionCredit", "value": "AzureConsumptionCredit", "description": "AzureConsumptionCredit" }, { "name": "AzurePassSponsorship", "value": "AzurePassSponsorship", "description": "AzurePassSponsorship" }, { "name": "MpnSponsorship", "value": "MpnSponsorship", "description": "MpnSponsorship" }, { "name": "MSDN", "value": "MSDN", "description": "MSDN" }, { "name": "NonProfitSponsorship", "value": "NonProfitSponsorship", "description": "NonProfitSponsorship" }, { "name": "Sponsorship", "value": "Sponsorship", "description": "Sponsorship" }, { "name": "StartupSponsorship", "value": "StartupSponsorship", "description": "StartupSponsorship" }, { "name": "AzureForStudentsStarter", "value": "AzureForStudentsStarter", "description": "AzureForStudentsStarter" }, { "name": "VisualStudio", "value": "VisualStudio", "description": "VisualStudio" } ] } }, "SubscriptionBillingType": { "type": "string", "description": "The type of billing subscription.", "enum": [ "None", "Benefit", "Free", "Paid", "PrePaid" ], "x-ms-enum": { "name": "SubscriptionBillingType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Benefit", "value": "Benefit", "description": "Benefit" }, { "name": "Free", "value": "Free", "description": "Free" }, { "name": "Paid", "value": "Paid", "description": "Paid" }, { "name": "PrePaid", "value": "PrePaid", "description": "PrePaid" } ] } }, "SubscriptionEnrollmentAccountStatus": { "type": "string", "description": "The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.", "enum": [ "Active", "Cancelled", "Expired", "Deleted", "TransferredOut", "Transferring", "Inactive" ], "x-ms-enum": { "name": "SubscriptionEnrollmentAccountStatus", "modelAsString": true, "values": [ { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Cancelled", "value": "Cancelled", "description": "Cancelled" }, { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "TransferredOut", "value": "TransferredOut", "description": "TransferredOut" }, { "name": "Transferring", "value": "Transferring", "description": "Transferring" }, { "name": "Inactive", "value": "Inactive", "description": "Inactive" } ] } }, "SubscriptionEnrollmentDetails": { "type": "object", "description": "The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.", "properties": { "departmentDisplayName": { "type": "string", "description": "The name of the department" }, "departmentId": { "type": "string", "description": "The ID that uniquely identifies the department." }, "enrollmentAccountStatus": { "type": "string", "description": "The status of the enrollment account." }, "enrollmentAccountDisplayName": { "type": "string", "description": "The name of the enrollment account." }, "enrollmentAccountId": { "type": "string", "description": "The ID that uniquely identifies an enrollment account." } } }, "SubscriptionPolicy": { "type": "object", "description": "A policy at subscription scope.", "properties": { "properties": { "$ref": "#/definitions/SubscriptionPolicyProperties", "description": "A policy at subscription scope." }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SubscriptionPolicyProperties": { "type": "object", "description": "A policy at subscription scope.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the resource during a long-running operation.", "readOnly": true }, "policies": { "type": "array", "description": "List of all policies defined at the billing scope.", "items": { "$ref": "#/definitions/PolicySummary" }, "x-ms-identifiers": [ "name" ] } } }, "SubscriptionStatusReason": { "type": "string", "description": "The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.", "enum": [ "None", "Cancelled", "PastDue", "SuspiciousActivity", "Other", "Transferred", "PolicyViolation", "SpendingLimitReached", "Expired" ], "x-ms-enum": { "name": "SubscriptionStatusReason", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Cancelled", "value": "Cancelled", "description": "Cancelled" }, { "name": "PastDue", "value": "PastDue", "description": "PastDue" }, { "name": "SuspiciousActivity", "value": "SuspiciousActivity", "description": "SuspiciousActivity" }, { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Transferred", "value": "Transferred", "description": "Transferred" }, { "name": "PolicyViolation", "value": "PolicyViolation", "description": "PolicyViolation" }, { "name": "SpendingLimitReached", "value": "SpendingLimitReached", "description": "SpendingLimitReached" }, { "name": "Expired", "value": "Expired", "description": "Expired" } ] } }, "SubscriptionTransferValidationErrorCode": { "type": "string", "description": "Error code of the transfer validation response.", "enum": [ "Other", "BillingAccountInactive", "DestinationBillingProfileInactive", "DestinationBillingProfileNotFound", "DestinationBillingProfilePastDue", "DestinationInvoiceSectionInactive", "DestinationInvoiceSectionNotFound", "InsufficientPermissionOnDestination", "InsufficientPermissionOnSource", "InvalidDestination", "InvalidSource", "MarketplaceNotEnabledOnDestination", "ProductInactive", "ProductNotFound", "ProductTypeNotSupported", "SourceBillingProfilePastDue", "SourceInvoiceSectionInactive", "AccountIsLocked", "AssetHasCap", "AssetNotActive", "BillingProfilePastDue", "CrossBillingAccountNotAllowed", "NoActiveAzurePlan", "None", "SubscriptionNotActive", "SubscriptionHasReservations", "SubscriptionTypeNotSupported", "InvoiceSectionIsRestricted" ], "x-ms-enum": { "name": "SubscriptionTransferValidationErrorCode", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "BillingAccountInactive", "value": "BillingAccountInactive", "description": "BillingAccountInactive" }, { "name": "DestinationBillingProfileInactive", "value": "DestinationBillingProfileInactive", "description": "DestinationBillingProfileInactive" }, { "name": "DestinationBillingProfileNotFound", "value": "DestinationBillingProfileNotFound", "description": "DestinationBillingProfileNotFound" }, { "name": "DestinationBillingProfilePastDue", "value": "DestinationBillingProfilePastDue", "description": "DestinationBillingProfilePastDue" }, { "name": "DestinationInvoiceSectionInactive", "value": "DestinationInvoiceSectionInactive", "description": "DestinationInvoiceSectionInactive" }, { "name": "DestinationInvoiceSectionNotFound", "value": "DestinationInvoiceSectionNotFound", "description": "DestinationInvoiceSectionNotFound" }, { "name": "InsufficientPermissionOnDestination", "value": "InsufficientPermissionOnDestination", "description": "InsufficientPermissionOnDestination" }, { "name": "InsufficientPermissionOnSource", "value": "InsufficientPermissionOnSource", "description": "InsufficientPermissionOnSource" }, { "name": "InvalidDestination", "value": "InvalidDestination", "description": "InvalidDestination" }, { "name": "InvalidSource", "value": "InvalidSource", "description": "InvalidSource" }, { "name": "MarketplaceNotEnabledOnDestination", "value": "MarketplaceNotEnabledOnDestination", "description": "MarketplaceNotEnabledOnDestination" }, { "name": "ProductInactive", "value": "ProductInactive", "description": "ProductInactive" }, { "name": "ProductNotFound", "value": "ProductNotFound", "description": "ProductNotFound" }, { "name": "ProductTypeNotSupported", "value": "ProductTypeNotSupported", "description": "ProductTypeNotSupported" }, { "name": "SourceBillingProfilePastDue", "value": "SourceBillingProfilePastDue", "description": "SourceBillingProfilePastDue" }, { "name": "SourceInvoiceSectionInactive", "value": "SourceInvoiceSectionInactive", "description": "SourceInvoiceSectionInactive" }, { "name": "AccountIsLocked", "value": "AccountIsLocked", "description": "AccountIsLocked" }, { "name": "AssetHasCap", "value": "AssetHasCap", "description": "AssetHasCap" }, { "name": "AssetNotActive", "value": "AssetNotActive", "description": "AssetNotActive" }, { "name": "BillingProfilePastDue", "value": "BillingProfilePastDue", "description": "BillingProfilePastDue" }, { "name": "CrossBillingAccountNotAllowed", "value": "CrossBillingAccountNotAllowed", "description": "CrossBillingAccountNotAllowed" }, { "name": "NoActiveAzurePlan", "value": "NoActiveAzurePlan", "description": "NoActiveAzurePlan" }, { "name": "None", "value": "None", "description": "None" }, { "name": "SubscriptionNotActive", "value": "SubscriptionNotActive", "description": "SubscriptionNotActive" }, { "name": "SubscriptionHasReservations", "value": "SubscriptionHasReservations", "description": "SubscriptionHasReservations" }, { "name": "SubscriptionTypeNotSupported", "value": "SubscriptionTypeNotSupported", "description": "SubscriptionTypeNotSupported" }, { "name": "InvoiceSectionIsRestricted", "value": "InvoiceSectionIsRestricted", "description": "InvoiceSectionIsRestricted" } ] } }, "SubscriptionWorkloadType": { "type": "string", "description": "The Azure workload type of the subscription.", "enum": [ "None", "Production", "DevTest", "Internal" ], "x-ms-enum": { "name": "SubscriptionWorkloadType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Production", "value": "Production", "description": "Production" }, { "name": "DevTest", "value": "DevTest", "description": "DevTest" }, { "name": "Internal", "value": "Internal", "description": "Internal" } ] } }, "SupportLevel": { "type": "string", "description": "The support level offer associated with an enrollment.", "enum": [ "Other", "Standard", "Pro-Direct", "Developer" ], "x-ms-enum": { "name": "SupportLevel", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Pro-Direct", "value": "Pro-Direct", "description": "Pro-Direct" }, { "name": "Developer", "value": "Developer", "description": "Developer" } ] } }, "SupportedAccountType": { "type": "string", "description": "The supported account types.", "enum": [ "None", "Partner", "Individual", "Enterprise" ], "x-ms-enum": { "name": "SupportedAccountType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Partner", "value": "Partner", "description": "Partner" }, { "name": "Individual", "value": "Individual", "description": "Individual" }, { "name": "Enterprise", "value": "Enterprise", "description": "Enterprise" } ] } }, "SystemOverrides": { "type": "object", "description": "System imposed policies that regulate behavior of the subscription.", "properties": { "cancellation": { "$ref": "#/definitions/Cancellation", "description": "The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.", "readOnly": true }, "cancellationAllowedEndDate": { "type": "string", "format": "date-time", "description": "The end date in UTC time by when the self-serve cancellation ends.", "readOnly": true } } }, "TaxIdentifier": { "type": "object", "description": "A tax identifier for the billing account.", "properties": { "id": { "type": "string", "description": "The id of the tax identifier." }, "type": { "$ref": "#/definitions/TaxIdentifierType", "description": "The type of the tax identifier." }, "scope": { "type": "string", "description": "The scope of the tax identifier." }, "country": { "type": "string", "description": "The country of the tax identifier." }, "status": { "$ref": "#/definitions/TaxIdentifierStatus", "description": "The status of the tax identifier." } } }, "TaxIdentifierStatus": { "type": "string", "description": "The status of the tax identifier.", "enum": [ "Other", "Valid", "Invalid" ], "x-ms-enum": { "name": "TaxIdentifierStatus", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Valid", "value": "Valid", "description": "Valid" }, { "name": "Invalid", "value": "Invalid", "description": "Invalid" } ] } }, "TaxIdentifierType": { "type": "string", "description": "The type of the tax identifier.", "enum": [ "Other", "BrazilCcmId", "BrazilCnpjId", "BrazilCpfId", "CanadianFederalExempt", "CanadianProvinceExempt", "ExternalTaxation", "IndiaFederalTanId", "IndiaFederalServiceTaxId", "IndiaPanId", "IndiaStateCstId", "IndiaStateGstINId", "IndiaStateVatId", "IntlExempt", "USExempt", "VatId", "LoveCode", "MobileBarCode", "NationalIdentificationNumber", "PublicSectorId" ], "x-ms-enum": { "name": "TaxIdentifierType", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "BrazilCcmId", "value": "BrazilCcmId", "description": "BrazilCcmId" }, { "name": "BrazilCnpjId", "value": "BrazilCnpjId", "description": "BrazilCnpjId" }, { "name": "BrazilCpfId", "value": "BrazilCpfId", "description": "BrazilCpfId" }, { "name": "CanadianFederalExempt", "value": "CanadianFederalExempt", "description": "CanadianFederalExempt" }, { "name": "CanadianProvinceExempt", "value": "CanadianProvinceExempt", "description": "CanadianProvinceExempt" }, { "name": "ExternalTaxation", "value": "ExternalTaxation", "description": "ExternalTaxation" }, { "name": "IndiaFederalTanId", "value": "IndiaFederalTanId", "description": "IndiaFederalTanId" }, { "name": "IndiaFederalServiceTaxId", "value": "IndiaFederalServiceTaxId", "description": "IndiaFederalServiceTaxId" }, { "name": "IndiaPanId", "value": "IndiaPanId", "description": "IndiaPanId" }, { "name": "IndiaStateCstId", "value": "IndiaStateCstId", "description": "IndiaStateCstId" }, { "name": "IndiaStateGstINId", "value": "IndiaStateGstINId", "description": "IndiaStateGstINId" }, { "name": "IndiaStateVatId", "value": "IndiaStateVatId", "description": "IndiaStateVatId" }, { "name": "IntlExempt", "value": "IntlExempt", "description": "IntlExempt" }, { "name": "USExempt", "value": "USExempt", "description": "USExempt" }, { "name": "VatId", "value": "VatId", "description": "VatId" }, { "name": "LoveCode", "value": "LoveCode", "description": "LoveCode" }, { "name": "MobileBarCode", "value": "MobileBarCode", "description": "MobileBarCode" }, { "name": "NationalIdentificationNumber", "value": "NationalIdentificationNumber", "description": "NationalIdentificationNumber" }, { "name": "PublicSectorId", "value": "PublicSectorId", "description": "PublicSectorId" } ] } }, "Transaction": { "type": "object", "description": "A transaction.", "properties": { "properties": { "$ref": "#/definitions/TransactionProperties", "description": "A transaction." } }, "allOf": [ { "$ref": "#/definitions/ProxyResourceWithTags" } ] }, "TransactionKind": { "type": "string", "description": "Type of the transaction, billed or unbilled.", "enum": [ "Other", "All", "Reservation" ], "x-ms-enum": { "name": "TransactionKind", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "All", "value": "All", "description": "All" }, { "name": "Reservation", "value": "Reservation", "description": "Reservation" } ] } }, "TransactionListResult": { "type": "object", "description": "Paged collection of Transaction items", "properties": { "value": { "type": "array", "description": "The Transaction items on this page", "items": { "$ref": "#/definitions/Transaction" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TransactionProperties": { "type": "object", "description": "A transaction.", "properties": { "azureCreditApplied": { "$ref": "#/definitions/TransactionPropertiesAzureCreditApplied", "description": "The amount of any Azure credits automatically applied to this transaction." }, "azurePlan": { "type": "string", "description": "Details of the Azure plan." }, "billingCurrency": { "type": "string", "description": "The ISO 4217 code for the currency in which this transaction is billed." }, "billingProfileDisplayName": { "description": "The name of the billing profile." }, "billingProfileId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a billing profile." }, "consumptionCommitmentDecremented": { "$ref": "#/definitions/TransactionPropertiesConsumptionCommitmentDecremented", "description": "The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction." }, "customerDisplayName": { "type": "string", "description": "The name of the customer." }, "customerId": { "type": "string", "description": "The fully qualified ID that uniquely identifies a customer." }, "creditType": { "$ref": "#/definitions/CreditType", "description": "The credit type of the transaction. Applies only to credited transactions." }, "date": { "type": "string", "format": "date-time", "description": "The date of transaction." }, "discount": { "type": "number", "format": "float", "description": "The percentage discount, if any, applied to this transaction." }, "effectivePrice": { "$ref": "#/definitions/TransactionPropertiesEffectivePrice", "description": "The price of the product after applying any discounts." }, "exchangeRate": { "type": "number", "format": "float", "description": "The exchange rate used to convert charged amount to billing currency, if applicable." }, "invoice": { "type": "string", "description": "Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed." }, "invoiceId": { "type": "string", "description": "The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed." }, "invoiceSectionDisplayName": { "type": "string", "description": "The name of the invoice section." }, "invoiceSectionId": { "type": "string", "description": "The fully qualified ID that uniquely identifies an invoice section." }, "isThirdParty": { "type": "boolean", "description": "Whether or not the transaction is third party." }, "kind": { "$ref": "#/definitions/TransactionKind", "description": "Type of the transaction, billed or unbilled." }, "marketPrice": { "$ref": "#/definitions/TransactionPropertiesMarketPrice", "description": "The retail price of the product." }, "partNumber": { "type": "string", "description": "The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices." }, "pricingCurrency": { "type": "string", "description": "The ISO 4217 code for the currency in which the product is priced." }, "productDescription": { "type": "string", "description": "The description of the product for which the transaction took place." }, "productFamily": { "type": "string", "description": "The family of the product for which the transaction took place." }, "productTypeId": { "type": "string", "description": "The ID of the product type for which the transaction took place." }, "productType": { "type": "string", "description": "The type of the product for which the transaction took place." }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity purchased in the transaction." }, "reasonCode": { "type": "string", "description": "There reason code for the transaction." }, "servicePeriodStartDate": { "type": "string", "format": "date-time", "description": "The date of the purchase of the product, or the start date of the month in which usage started." }, "servicePeriodEndDate": { "type": "string", "format": "date-time", "description": "The end date of the product term, or the end date of the month in which usage ended." }, "subTotal": { "$ref": "#/definitions/TransactionPropertiesSubTotal", "description": "The pre-tax charged amount for the transaction." }, "tax": { "$ref": "#/definitions/TransactionPropertiesTax", "description": "The tax amount applied to the transaction." }, "transactionAmount": { "$ref": "#/definitions/TransactionPropertiesTransactionAmount", "description": "The charge associated with the transaction." }, "transactionType": { "type": "string", "description": "The type of transaction." }, "units": { "type": "number", "format": "float", "description": "The number of units used for a given product." }, "unitOfMeasure": { "type": "string", "description": "The unit of measure used to bill for the product. For example, compute services are billed per hour." }, "unitType": { "type": "string", "description": "The description for the unit of measure for a given product." }, "specialTaxationType": { "$ref": "#/definitions/SpecialTaxationType", "description": "Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic." }, "refundTransactionDetails": { "$ref": "#/definitions/TransactionPropertiesRefundTransactionDetails", "description": "The refund details of a transaction." } } }, "TransactionPropertiesAzureCreditApplied": { "type": "object", "description": "The amount of any Azure credits automatically applied to this transaction.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "TransactionPropertiesConsumptionCommitmentDecremented": { "type": "object", "description": "The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "TransactionPropertiesEffectivePrice": { "type": "object", "description": "The price of the product after applying any discounts.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "TransactionPropertiesMarketPrice": { "type": "object", "description": "The retail price of the product.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "TransactionPropertiesRefundTransactionDetails": { "type": "object", "description": "The refund details of a transaction.", "allOf": [ { "$ref": "#/definitions/RefundTransactionDetails" } ] }, "TransactionPropertiesSubTotal": { "type": "object", "description": "The pre-tax charged amount for the transaction.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "TransactionPropertiesTax": { "type": "object", "description": "The tax amount applied to the transaction.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "TransactionPropertiesTransactionAmount": { "type": "object", "description": "The charge associated with the transaction.", "allOf": [ { "$ref": "#/definitions/Amount" } ] }, "TransactionSummary": { "type": "object", "description": "A transaction summary.", "properties": { "azureCreditApplied": { "type": "number", "format": "float", "description": "The total amount of any Azure credits applied.", "readOnly": true }, "billingCurrency": { "type": "string", "description": "The ISO 4217 code for the currency in which the transactions are billed.", "readOnly": true }, "consumptionCommitmentDecremented": { "type": "number", "format": "float", "description": "The total Microsoft Azure Consumption Commitment (MACC) decrement through the invoice.", "readOnly": true }, "subTotal": { "type": "number", "format": "float", "description": "The total pre-tax charged amount.", "readOnly": true }, "tax": { "type": "number", "format": "float", "description": "The total tax amount applied.", "readOnly": true }, "total": { "type": "number", "format": "float", "description": "The total charges.", "readOnly": true } } }, "TransferDetails": { "type": "object", "description": "Details of the transfer.", "properties": { "properties": { "$ref": "#/definitions/TransferProperties", "description": "Details of the transfer.", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "TransferDetailsListResult": { "type": "object", "description": "Paged collection of TransferDetails items", "properties": { "value": { "type": "array", "description": "The TransferDetails items on this page", "items": { "$ref": "#/definitions/TransferDetails" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TransferError": { "type": "object", "description": "Error details for transfer execution.", "properties": { "code": { "type": "string", "description": "Error code.", "readOnly": true }, "message": { "type": "string", "description": "Error message.", "readOnly": true } } }, "TransferProperties": { "type": "object", "description": "Transfer details", "properties": { "expirationTime": { "type": "string", "format": "date-time", "description": "The time at which the transfer request expires.", "readOnly": true }, "transferStatus": { "$ref": "#/definitions/TransferStatus", "description": "Overall transfer status.", "readOnly": true }, "recipientEmailId": { "type": "string", "description": "The email ID of the user to whom the transfer request was sent.", "readOnly": true }, "initiatorEmailId": { "type": "string", "description": "The email ID of the user who sent the transfer request.", "readOnly": true }, "canceledBy": { "type": "string", "description": "The email ID of the user who canceled the transfer request.", "readOnly": true }, "detailedTransferStatus": { "type": "array", "description": "Detailed transfer status.", "items": { "$ref": "#/definitions/DetailedTransferStatus" }, "readOnly": true, "x-ms-identifiers": [] } } }, "TransferStatus": { "type": "string", "description": "The status of a transfer.", "enum": [ "Expired", "Pending", "InProgress", "Completed", "CompletedWithErrors", "Failed", "Canceled", "Declined" ], "x-ms-enum": { "name": "TransferStatus", "modelAsString": true, "values": [ { "name": "Expired", "value": "Expired", "description": "Expired" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "InProgress", "value": "InProgress", "description": "InProgress" }, { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "CompletedWithErrors", "value": "CompletedWithErrors", "description": "CompletedWithErrors" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Declined", "value": "Declined", "description": "Declined" } ] } }, "TransitionDetails": { "type": "object", "description": "The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.", "properties": { "transitionDate": { "type": "string", "format": "date-time", "description": "The transition completion date.", "readOnly": true }, "anniversaryDay": { "type": "integer", "format": "int32", "description": "The anniversary day of the pre-transitioned account of type Microsoft Online Services Program.", "readOnly": true } } }, "Utilization": { "type": "object", "description": "Savings plan utilization", "properties": { "trend": { "type": "string", "description": "The trend for a savings plan's utilization", "readOnly": true }, "aggregates": { "type": "array", "description": "The array of aggregates of a savings plan's utilization", "items": { "$ref": "#/definitions/UtilizationAggregates" }, "x-ms-identifiers": [] } } }, "UtilizationAggregates": { "type": "object", "description": "The aggregate values of savings plan utilization", "properties": { "grain": { "type": "number", "format": "float", "description": "The grain of the aggregate", "readOnly": true }, "grainUnit": { "type": "string", "description": "The grain unit of the aggregate", "readOnly": true }, "value": { "type": "number", "format": "float", "description": "The aggregate value", "readOnly": true }, "valueUnit": { "type": "string", "description": "The aggregate value unit", "readOnly": true } } }, "ValidateTransferListResponse": { "type": "object", "description": "Result of transfer validation.", "properties": { "value": { "type": "array", "description": "The list of transfer validation results.", "items": { "$ref": "#/definitions/ValidateTransferResponse" }, "readOnly": true, "x-ms-identifiers": [] } } }, "ValidateTransferResponse": { "type": "object", "description": "Transfer validation response.", "properties": { "properties": { "$ref": "#/definitions/ValidateTransferResponseProperties", "description": "The properties of transfer validation response.", "x-ms-client-flatten": true } } }, "ValidateTransferResponseProperties": { "type": "object", "description": "The properties of transfer validation response.", "properties": { "status": { "type": "string", "description": "The status of validation", "readOnly": true }, "productId": { "type": "string", "description": "The product id for which this result applies.", "readOnly": true }, "results": { "type": "array", "description": "The array of validation results.", "items": { "$ref": "#/definitions/ValidationResultProperties" }, "x-ms-identifiers": [] } } }, "ValidationResultProperties": { "type": "object", "description": "The properties of the validation result.", "properties": { "level": { "type": "string", "description": "Result Level.", "readOnly": true }, "code": { "type": "string", "description": "Result Code.", "readOnly": true }, "message": { "type": "string", "description": "The validation message.", "readOnly": true } } }, "ViewChargesPolicy": { "type": "string", "description": "The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices.", "enum": [ "Other", "Allowed", "NotAllowed" ], "x-ms-enum": { "name": "ViewChargesPolicy", "modelAsString": true, "values": [ { "name": "Other", "value": "Other", "description": "Other" }, { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } } }, "parameters": {} }