diff --git a/specification/billing/cspell.yaml b/specification/billing/cspell.yaml index 855068deecbf..5f0b7d68786a 100644 --- a/specification/billing/cspell.yaml +++ b/specification/billing/cspell.yaml @@ -15,4 +15,8 @@ overrides: - cnpj - mosp - resellee + - filename: '**/specification/billing/**/*.tsp' + words: + - cnpj + - resellee diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/Agreement.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/Agreement.tsp new file mode 100644 index 000000000000..34803114aacc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/Agreement.tsp @@ -0,0 +1,69 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * An agreement. + */ +@tenantResource +@parentResource(BillingAccount) +model Agreement is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = Agreement, + KeyName = "agreementName", + SegmentName = "agreements", + NamePattern = "^[a-fA-F0-9]{1,12}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface Agreements { + /** + * Gets an agreement by ID. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Agreement") + get is ArmResourceRead< + Agreement, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the agreements for a billing account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Agreement") + listByBillingAccount is ArmResourceListByParent< + Agreement, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * May be used to expand the participants. + */ + @query("expand") + expand?: string; + }, + Response = ArmResponse + >; +} + +@@doc(Agreement.name, "The ID that uniquely identifies an agreement."); +@@doc(Agreement.properties, "An agreement."); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/AssociatedTenant.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/AssociatedTenant.tsp new file mode 100644 index 000000000000..367f7ff98e35 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/AssociatedTenant.tsp @@ -0,0 +1,135 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * An associated tenant. + */ +@tenantResource +@parentResource(BillingAccount) +model AssociatedTenant + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = AssociatedTenant, + KeyName = "associatedTenantName", + SegmentName = "associatedTenants", + NamePattern = "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface AssociatedTenants { + /** + * Gets an associated tenant by ID. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("AssociatedTenant") + get is ArmResourceRead< + AssociatedTenant, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Create or update an associated tenant for the billing account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("AssociatedTenant") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + AssociatedTenant, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * Deletes an associated tenant for a billing account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("AssociatedTenant") + delete is ArmResourceDeleteWithoutOkAsync< + AssociatedTenant, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("AssociatedTenant") + listByBillingAccount is ArmResourceListByParent< + AssociatedTenant, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = AssociatedTenantsListByBillingAccountParameters, + Response = ArmResponse + >; +} + +alias AssociatedTenantsListByBillingAccountParameters = { + /** + * Can be used to get revoked associated tenants. + */ + @query("includeRevoked") + includeRevoked?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +@@doc(AssociatedTenant.name, "The ID that uniquely identifies a tenant."); +@@doc(AssociatedTenant.properties, "An associated tenant."); +@@doc(AssociatedTenants.createOrUpdate::parameters.resource, + "An associated tenant." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/AvailableBalance.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/AvailableBalance.tsp new file mode 100644 index 000000000000..893884fd2494 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/AvailableBalance.tsp @@ -0,0 +1,122 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices. + */ +@singleton("default") +@tenantResource +@parentResource(BillingAccount) +model AvailableBalance + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = AvailableBalance, + KeyName = "availableBalance", + SegmentName = "availableBalance", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias AvailableBalanceOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + }, + {}, + { + /** undefined */ + @path + @segment("availableBalance") + @key + default: "default"; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface AvailableBalances { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("AvailableBalance") + getByBillingAccount is AvailableBalanceOps.Read; +} +alias AvailableBalanceOperationGroupOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + }, + {}, + { + /** undefined */ + @path + @segment("availableBalance") + @key + default: "default"; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface AvailableBalanceOperationGroup { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("AvailableBalance") + getByBillingProfile is AvailableBalanceOperationGroupOps.Read; +} + +@@doc(AvailableBalance.name, ""); +@@doc(AvailableBalance.properties, + "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingAccount.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingAccount.tsp new file mode 100644 index 000000000000..94f93c18a58e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingAccount.tsp @@ -0,0 +1,493 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A billing account. + */ +@tenantResource +model BillingAccount + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingAccount, + KeyName = "billingAccountName", + SegmentName = "billingAccounts", + NamePattern = "^([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})?)$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface BillingAccounts { + /** + * Gets a billing account by its ID. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + get is ArmResourceRead< + BillingAccount, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-patch" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync< + BillingAccount, + PatchModel = BillingAccountPatch, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the billing accounts that a user has access to. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + list is ArmResourceListByParent< + BillingAccount, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = BillingAccountsListParameters, + Response = ArmResponse + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + addPaymentTerms is ArmResourceActionAsync< + BillingAccount, + PaymentTerm[], + BillingAccount, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + cancelPaymentTerms is ArmResourceActionAsync< + BillingAccount, + utcDateTime, + BillingAccount, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + confirmTransition is ArmResourceActionSync< + BillingAccount, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + @list + @action("listInvoiceSectionsWithCreateSubscriptionPermission") + listInvoiceSectionsByCreateSubscriptionPermission is ArmResourceActionSync< + BillingAccount, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + } + >; + + /** + * Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + validatePaymentTerms is ArmResourceActionSync< + BillingAccount, + PaymentTerm[], + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the billing permissions the caller has on a billing account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @list + @get + @action("billingPermissions") + listByBillingAccount is ArmResourceActionSync< + BillingAccount, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Provides a list of check access response objects for a billing account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @action("checkAccess") + checkAccessByBillingAccount is ArmResourceActionSync< + BillingAccount, + CheckAccessRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * The list of billing requests submitted for the billing account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRequest") + @list + @get + @action("billingRequests") + billingRequestsListByBillingAccount is ArmResourceActionSync< + BillingAccount, + void, + Response = ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("createBillingRoleAssignment") + createByBillingAccount is ArmResourceActionAsync< + BillingAccount, + BillingRoleAssignmentProperties, + BillingRoleAssignment, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("resolveBillingRoleAssignments") + resolveByBillingAccount is ArmResourceActionAsync< + BillingAccount, + void, + BillingRoleAssignmentListResult, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = BillingRoleAssignmentsResolveByBillingAccountParameters + >; + + /** + * List savings plans by billing account. + */ + @tag("Savings plan") + @list + @get + @action("savingsPlans") + savingsPlansListByBillingAccount is ArmResourceActionSync< + BillingAccount, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * The number of savings plans to skip from the list before returning results + */ + @query("skiptoken") + skiptoken?: float32; + + /** + * The number of savings plans to return + */ + @query("take") + take?: float32; + + /** + * The selected provisioning state + */ + @query("selectedState") + selectedState?: string; + + /** + * To indicate whether to refresh the roll up counts of the savings plans group by provisioning states + */ + @query("refreshSummary") + refreshSummary?: string; + } + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + @action("downloadDocuments") + downloadDocumentsByBillingAccount is ArmResourceActionAsyncBase< + BillingAccount, + DocumentDownloadRequest[], + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResponse | ArmAcceptedLroResponse< + "Resource operation accepted.", + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + > + >; + + /** + * Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states. + */ + @tag("Reservations") + @list + @get + @action("reservations") + reservationsListByBillingAccount is ArmResourceActionSync< + BillingAccount, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * The number of reservations to skip from the list before returning results + */ + @query("skiptoken") + skiptoken?: float32; + + /** + * To indicate whether to refresh the roll up counts of the reservations group by provisioning states + */ + @query("refreshSummary") + refreshSummary?: string; + + /** + * The selected provisioning state + */ + @query("selectedState") + selectedState?: string; + + /** + * The number of reservations to return in API response. + */ + @query("take") + take?: float32; + } + >; +} + +alias BillingAccountsListParameters = { + /** + * 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. + */ + @query("includeAll") + includeAll?: boolean = false; + + /** + * 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. + */ + @query("includeAllWithoutBillingProfiles") + includeAllWithoutBillingProfiles?: boolean = false; + + /** + * When true, results will include any billing accounts in a deleted state. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * Includes billing accounts with agreement pending signature that the user has access to. + */ + @query("includePendingAgreement") + includePendingAgreement?: boolean = false; + + /** + * Includes the customer's billing account of Microsoft Partner Agreement that the user has access to. + */ + @query("includeResellee") + includeResellee?: boolean = false; + + /** + * Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @query("legalOwnerTID") + legalOwnerTID?: string; + + /** + * Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @query("legalOwnerOID") + legalOwnerOID?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * Expand is allowed for SoldTo and EnrollmentDetails/PONumber. + */ + @query("expand") + expand?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +alias BillingRoleAssignmentsResolveByBillingAccountParameters = { + /** + * Resolves the scope display name for each of the role assignments. + */ + @query("resolveScopeDisplayNames") + resolveScopeDisplayNames?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; +}; + +@@doc(BillingAccount.name, + "The ID that uniquely identifies a billing account." +); +@@doc(BillingAccount.properties, "A billing account."); +@@doc(BillingAccounts.update::parameters.properties, "A billing account."); +@@doc(BillingAccounts.addPaymentTerms::parameters.body, + "The properties of payment term." +); +@@doc(BillingAccounts.cancelPaymentTerms::parameters.body, + "Date after which any payment terms that needs to be cancelled." +); +@@doc(BillingAccounts.validatePaymentTerms::parameters.body, + "The properties of payment term." +); +@@doc(BillingAccounts.checkAccessByBillingAccount::parameters.body, + "The request object against which access of the caller will be checked." +); +@@doc(BillingAccounts.createByBillingAccount::parameters.body, + "The properties of the billing role assignment." +); +@@doc(BillingAccounts.downloadDocumentsByBillingAccount::parameters.body, + "A list of download details for individual documents." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingAccountPolicy.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingAccountPolicy.tsp new file mode 100644 index 000000000000..e09d7b117e0d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingAccountPolicy.tsp @@ -0,0 +1,69 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A policy at billing account scope. + */ +@singleton("default") +@tenantResource +@parentResource(BillingAccount) +model BillingAccountPolicy + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingAccountPolicy, + KeyName = "policy", + SegmentName = "policies", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations(#{ omitTags: true }) +interface BillingAccountPolicies { + /** + * Get the policies for a billing account of Enterprise Agreement type. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + getByBillingAccount is ArmResourceRead< + BillingAccountPolicy, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Update the policies for a billing account of Enterprise Agreement type. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + createOrUpdateByBillingAccount is ArmResourceCreateOrReplaceAsync< + BillingAccountPolicy, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; +} + +@@doc(BillingAccountPolicy.name, ""); +@@doc(BillingAccountPolicy.properties, "A policy at billing account scope."); +@@doc(BillingAccountPolicies.createOrUpdateByBillingAccount::parameters.resource, + "A policy at billing account scope." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProfile.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProfile.tsp new file mode 100644 index 000000000000..43e74625566b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProfile.tsp @@ -0,0 +1,525 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A billing profile. + */ +@tenantResource +@parentResource(BillingAccount) +model BillingProfile + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingProfile, + KeyName = "billingProfileName", + SegmentName = "billingProfiles", + NamePattern = "^[a-zA-Z\\d-_]{1,128}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface BillingProfiles { + /** + * Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingProfile") + get is ArmResourceRead< + BillingProfile, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingProfile") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + BillingProfile, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResourceUpdatedResponse | ArmResourceCreatedResponse< + BillingProfile, + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + > | ArmAcceptedLroResponse + >; + + /** + * Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingProfile") + delete is ArmResourceDeleteWithoutOkAsync< + BillingProfile, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingProfile") + listByBillingAccount is ArmResourceListByParent< + BillingProfile, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = BillingProfilesListByBillingAccountParameters, + Response = ArmResponse + >; + + /** + * Lists the billing permissions the caller has on a billing profile. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @list + @get + @action("billingPermissions") + listByBillingProfile is ArmResourceActionSync< + BillingProfile, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Provides a list of check access response objects for a billing profile. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @action("checkAccess") + checkAccessByBillingProfile is ArmResourceActionSync< + BillingProfile, + CheckAccessRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingProfile") + validateDeleteEligibility is ArmResourceActionSync< + BillingProfile, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * The list of billing requests submitted for the billing profile. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRequest") + @list + @get + @action("billingRequests") + billingRequestsListByBillingProfile is ArmResourceActionSync< + BillingProfile, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("createBillingRoleAssignment") + createByBillingProfile is ArmResourceActionAsync< + BillingProfile, + BillingRoleAssignmentProperties, + BillingRoleAssignment, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("resolveBillingRoleAssignments") + resolveByBillingProfile is ArmResourceActionAsync< + BillingProfile, + void, + BillingRoleAssignmentListResult, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = BillingRoleAssignmentsResolveByBillingProfileParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + @list + @get + @action("invoices") + invoicesListByBillingProfile is ArmResourceActionSync< + BillingProfile, + void, + InvoiceListResult, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @query("periodStartDate") + periodStartDate?: plainDate; + + /** + * The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @query("periodEndDate") + periodEndDate?: plainDate; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + @list + @get + @action("products") + productsListByBillingProfile is ArmResourceActionSync< + BillingProfile, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + + /** + * Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state. + */ + @tag("Reservations") + @list + @get + @action("reservations") + reservationsListByBillingProfile is ArmResourceActionSync< + BillingProfile, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * The number of reservations to skip from the list before returning results + */ + @query("skiptoken") + skiptoken?: float32; + + /** + * To indicate whether to refresh the roll up counts of the reservations group by provisioning states + */ + @query("refreshSummary") + refreshSummary?: string; + + /** + * The selected provisioning state + */ + @query("selectedState") + selectedState?: string; + + /** + * The number of reservations to return in API response. + */ + @query("take") + take?: float32; + } + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Transaction") + @list + @get + @action("transactions") + transactionsListByBillingProfile is ArmResourceActionSync< + BillingProfile, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. + */ + @query("periodStartDate") + periodStartDate: plainDate; + + /** + * The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. + */ + @query("periodEndDate") + periodEndDate: plainDate; + + /** + * The type of transaction. + */ + @query("type") + type: TransactionType; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; +} + +alias BillingProfilesListByBillingAccountParameters = { + /** + * Can be used to get deleted billing profiles. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +alias BillingRoleAssignmentsResolveByBillingProfileParameters = { + /** + * Resolves the scope display name for each of the role assignments. + */ + @query("resolveScopeDisplayNames") + resolveScopeDisplayNames?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; +}; + +@@doc(BillingProfile.name, + "The ID that uniquely identifies a billing profile." +); +@@doc(BillingProfile.properties, "A billing profile."); +@@doc(BillingProfiles.createOrUpdate::parameters.resource, + "A billing profile." +); +@@doc(BillingProfiles.checkAccessByBillingProfile::parameters.body, + "The request object against which access of the caller will be checked." +); +@@doc(BillingProfiles.createByBillingProfile::parameters.body, + "The properties of the billing role assignment." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProfilePolicy.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProfilePolicy.tsp new file mode 100644 index 000000000000..7528541fa506 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProfilePolicy.tsp @@ -0,0 +1,69 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingProfile.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A policy at billing profile scope. + */ +@singleton("default") +@tenantResource +@parentResource(BillingProfile) +model BillingProfilePolicy + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingProfilePolicy, + KeyName = "policy", + SegmentName = "policies", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations(#{ omitTags: true }) +interface BillingProfilePolicies { + /** + * Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + getByBillingProfile is ArmResourceRead< + BillingProfilePolicy, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + createOrUpdateByBillingProfile is ArmResourceCreateOrReplaceAsync< + BillingProfilePolicy, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; +} + +@@doc(BillingProfilePolicy.name, ""); +@@doc(BillingProfilePolicy.properties, "A policy at billing profile scope."); +@@doc(BillingProfilePolicies.createOrUpdateByBillingProfile::parameters.resource, + "A policy at billing profile scope." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProperty.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProperty.tsp new file mode 100644 index 000000000000..31b270e986bc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingProperty.tsp @@ -0,0 +1,79 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A billing property. + */ +@singleton("default") +@subscriptionResource +model BillingProperty + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingProperty, + KeyName = "billingProperty", + SegmentName = "billingProperty", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface BillingProperties { + /** + * Gets the billing properties for a subscription + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingProperty") + get is ArmResourceRead< + BillingProperty, + BaseParameters = Azure.ResourceManager.Foundations.SubscriptionBaseParameters, + Parameters = BillingPropertyGetParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingProperty") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + BillingProperty, + PatchModel = BillingProperty, + BaseParameters = Azure.ResourceManager.Foundations.SubscriptionBaseParameters + >; +} + +alias BillingPropertyGetParameters = { + /** + * A flag that specifies whether or not to include billing country. + */ + @query("includeBillingCountry") + includeBillingCountry?: boolean = false; + + /** + * A flag that specifies whether or not to include transition status for billing accounts with agreement type Microsoft Customer Agreement. + */ + @query("includeTransitionStatus") + includeTransitionStatus?: boolean = false; +}; + +@@doc(BillingProperty.name, ""); +@@doc(BillingProperty.properties, "A billing property."); +@@doc(BillingProperties.update::parameters.properties, "A billing property."); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRequest.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRequest.tsp new file mode 100644 index 000000000000..0c84d275588a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRequest.tsp @@ -0,0 +1,119 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. + */ +@tenantResource +model BillingRequest + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingRequest, + KeyName = "billingRequestName", + SegmentName = "billingRequests", + NamePattern = "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations(#{ omitTags: true }) +interface BillingRequests { + /** + * Gets a billing request by its ID. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRequest") + get is ArmResourceRead< + BillingRequest, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Create or update a billing request. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRequest") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + BillingRequest, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * The list of billing requests submitted by a user. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRequest") + listByUser is ArmResourceListByParent< + BillingRequest, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; +} + +@@doc(BillingRequest.name, + "The ID that uniquely identifies a billing request." +); +@@doc(BillingRequest.properties, + "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests." +); +@@doc(BillingRequests.createOrUpdate::parameters.resource, + "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRoleAssignment.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRoleAssignment.tsp new file mode 100644 index 000000000000..dbd371b5b565 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRoleAssignment.tsp @@ -0,0 +1,554 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingProfile.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * The properties of the billing role assignment. + */ +@tenantResource +@parentResource(BillingProfile) +model BillingRoleAssignment + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingRoleAssignment, + KeyName = "billingRoleAssignmentName", + SegmentName = "billingRoleAssignments", + NamePattern = "^[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})?$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias BillingRoleAssignmentOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + }, + {}, + { + /** The ID that uniquely identifies a role assignment. */ + @path + @segment("billingRoleAssignments") + @key + @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})?$") + billingRoleAssignmentName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleAssignments { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + getByBillingProfile is BillingRoleAssignmentOps.Read; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + deleteByBillingProfile is BillingRoleAssignmentOps.DeleteSync; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + listByBillingProfile is BillingRoleAssignmentOps.List< + BillingRoleAssignment, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + }, + Response = ArmResponse + >; +} +alias BillingRoleAssignmentByCustomerOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + customerName: string; + }, + {}, + { + /** The ID that uniquely identifies a role assignment. */ + @path + @segment("billingRoleAssignments") + @key + @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})?$") + billingRoleAssignmentName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleAssignmentByCustomer { + /** + * Gets a role assignment for the caller on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + getByCustomer is BillingRoleAssignmentByCustomerOps.Read; + + /** + * Deletes a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + deleteByCustomer is BillingRoleAssignmentByCustomerOps.DeleteSync; + + /** + * Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + listByCustomer is BillingRoleAssignmentByCustomerOps.List< + BillingRoleAssignment, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + }, + Response = ArmResponse + >; +} +alias BillingRoleAssignmentByInvoiceSectionOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + + /** The ID that uniquely identifies an invoice section. */ + @path + @segment("invoiceSections") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + invoiceSectionName: string; + }, + {}, + { + /** The ID that uniquely identifies a role assignment. */ + @path + @segment("billingRoleAssignments") + @key + @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})?$") + billingRoleAssignmentName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleAssignmentByInvoiceSection { + /** + * Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + getByInvoiceSection is BillingRoleAssignmentByInvoiceSectionOps.Read; + + /** + * Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + deleteByInvoiceSection is BillingRoleAssignmentByInvoiceSectionOps.DeleteSync; + + /** + * Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + listByInvoiceSection is BillingRoleAssignmentByInvoiceSectionOps.List< + BillingRoleAssignment, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + }, + Response = ArmResponse + >; +} +alias BillingRoleAssignmentByBillingAccountOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a role assignment. */ + @path + @segment("billingRoleAssignments") + @key + @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})?$") + billingRoleAssignmentName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleAssignmentByBillingAccount { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + getByBillingAccount is BillingRoleAssignmentByBillingAccountOps.Read; + + /** + * Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + createOrUpdateByBillingAccount is BillingRoleAssignmentByBillingAccountOps.CreateOrUpdateAsync< + BillingRoleAssignment, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + deleteByBillingAccount is BillingRoleAssignmentByBillingAccountOps.DeleteSync; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + listByBillingAccount is BillingRoleAssignmentByBillingAccountOps.List< + BillingRoleAssignment, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + }, + Response = ArmResponse + >; +} +alias BillingRoleAssignmentByDepartmentOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The name of the department. */ + @path + @segment("departments") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + departmentName: string; + }, + {}, + { + /** The ID that uniquely identifies a role assignment. */ + @path + @segment("billingRoleAssignments") + @key + @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})?$") + billingRoleAssignmentName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleAssignmentByDepartment { + /** + * Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + getByDepartment is BillingRoleAssignmentByDepartmentOps.Read; + + /** + * Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + createOrUpdateByDepartment is BillingRoleAssignmentByDepartmentOps.CreateOrUpdateAsync< + BillingRoleAssignment, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * Deletes a role assignment on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + deleteByDepartment is BillingRoleAssignmentByDepartmentOps.DeleteSync; + + /** + * Lists the role assignments for the caller on a department. The operation is supported for billing accounts of type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + listByDepartment is BillingRoleAssignmentByDepartmentOps.List< + BillingRoleAssignment, + Response = ArmResponse + >; +} +alias BillingRoleAssignmentByEnrollmentAccountOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The name of the enrollment account. */ + @path + @segment("enrollmentAccounts") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + enrollmentAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a role assignment. */ + @path + @segment("billingRoleAssignments") + @key + @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})?$") + billingRoleAssignmentName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleAssignmentByEnrollmentAccount { + /** + * Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + getByEnrollmentAccount is BillingRoleAssignmentByEnrollmentAccountOps.Read; + + /** + * Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + createOrUpdateByEnrollmentAccount is BillingRoleAssignmentByEnrollmentAccountOps.CreateOrUpdateAsync< + BillingRoleAssignment, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * Deletes a role assignment on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + deleteByEnrollmentAccount is BillingRoleAssignmentByEnrollmentAccountOps.DeleteSync; + + /** + * Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + listByEnrollmentAccount is BillingRoleAssignmentByEnrollmentAccountOps.List< + BillingRoleAssignment, + Response = ArmResponse + >; +} + +@@doc(BillingRoleAssignment.name, + "The ID that uniquely identifies a role assignment." +); +@@doc(BillingRoleAssignment.properties, + "The properties of the billing role assignment." +); +@@doc(BillingRoleAssignmentByBillingAccount.createOrUpdateByBillingAccount::parameters.resource, + "The properties of the billing role assignment." +); +@@doc(BillingRoleAssignmentByDepartment.createOrUpdateByDepartment::parameters.resource, + "The properties of the billing role assignment." +); +@@doc(BillingRoleAssignmentByEnrollmentAccount.createOrUpdateByEnrollmentAccount::parameters.resource, + "The properties of the billing role assignment." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRoleDefinition.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRoleDefinition.tsp new file mode 100644 index 000000000000..8d5a9a720ac4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingRoleDefinition.tsp @@ -0,0 +1,383 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingProfile.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * The properties of a role definition. + */ +@tenantResource +@parentResource(BillingProfile) +model BillingRoleDefinition + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingRoleDefinition, + KeyName = "roleDefinitionName", + SegmentName = "billingRoleDefinitions", + NamePattern = "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias BillingRoleDefinitionOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + }, + {}, + { + /** The ID that uniquely identifies a role definition. */ + @path + @segment("billingRoleDefinitions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + roleDefinitionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleDefinitions { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + getByBillingProfile is BillingRoleDefinitionOps.Read; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + listByBillingProfile is BillingRoleDefinitionOps.List< + BillingRoleDefinition, + Response = ArmResponse + >; +} +alias BillingRoleDefinitionByCustomerOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + customerName: string; + }, + {}, + { + /** The ID that uniquely identifies a role definition. */ + @path + @segment("billingRoleDefinitions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + roleDefinitionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleDefinitionByCustomer { + /** + * Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + getByCustomer is BillingRoleDefinitionByCustomerOps.Read; + + /** + * Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + listByCustomer is BillingRoleDefinitionByCustomerOps.List< + BillingRoleDefinition, + Response = ArmResponse + >; +} +alias BillingRoleDefinitionByInvoiceSectionOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + + /** The ID that uniquely identifies an invoice section. */ + @path + @segment("invoiceSections") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + invoiceSectionName: string; + }, + {}, + { + /** The ID that uniquely identifies a role definition. */ + @path + @segment("billingRoleDefinitions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + roleDefinitionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleDefinitionByInvoiceSection { + /** + * Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + getByInvoiceSection is BillingRoleDefinitionByInvoiceSectionOps.Read; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + listByInvoiceSection is BillingRoleDefinitionByInvoiceSectionOps.List< + BillingRoleDefinition, + Response = ArmResponse + >; +} +alias BillingRoleDefinitionByBillingAccountOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a role definition. */ + @path + @segment("billingRoleDefinitions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + roleDefinitionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleDefinitionByBillingAccount { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + getByBillingAccount is BillingRoleDefinitionByBillingAccountOps.Read; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + listByBillingAccount is BillingRoleDefinitionByBillingAccountOps.List< + BillingRoleDefinition, + Response = ArmResponse + >; +} +alias BillingRoleDefinitionByDepartmentOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The name of the department. */ + @path + @segment("departments") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + departmentName: string; + }, + {}, + { + /** The ID that uniquely identifies a role definition. */ + @path + @segment("billingRoleDefinitions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + roleDefinitionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleDefinitionByDepartment { + /** + * Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + getByDepartment is BillingRoleDefinitionByDepartmentOps.Read; + + /** + * List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + listByDepartment is BillingRoleDefinitionByDepartmentOps.List< + BillingRoleDefinition, + Response = ArmResponse + >; +} +alias BillingRoleDefinitionByEnrollmentAccountOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The name of the enrollment account. */ + @path + @segment("enrollmentAccounts") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + enrollmentAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a role definition. */ + @path + @segment("billingRoleDefinitions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + roleDefinitionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingRoleDefinitionByEnrollmentAccount { + /** + * Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + getByEnrollmentAccount is BillingRoleDefinitionByEnrollmentAccountOps.Read; + + /** + * List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleDefinition") + listByEnrollmentAccount is BillingRoleDefinitionByEnrollmentAccountOps.List< + BillingRoleDefinition, + Response = ArmResponse + >; +} + +@@doc(BillingRoleDefinition.name, + "The ID that uniquely identifies a role definition." +); +@@doc(BillingRoleDefinition.properties, "The properties of a role definition."); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingSubscription.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingSubscription.tsp new file mode 100644 index 000000000000..90712655a197 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingSubscription.tsp @@ -0,0 +1,374 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingProfile.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * The billing properties of a subscription. + */ +@tenantResource +@parentResource(BillingProfile) +model BillingSubscription + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingSubscription, + KeyName = "billingSubscriptionName", + SegmentName = "billingSubscriptions", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias BillingSubscriptionOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + billingProfileName: string; + }, + {}, + { + /** The ID that uniquely identifies a subscription. */ + @path + @segment("billingSubscriptions") + @key + billingSubscriptionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingSubscriptions { + /** + * Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + getByBillingProfile is BillingSubscriptionOps.Read< + BillingSubscription, + Parameters = { + /** + * Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` + */ + @query("expand") + expand?: string; + } + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + listByBillingProfile is BillingSubscriptionOps.List< + BillingSubscription, + Response = ArmResponse, + Parameters = BillingSubscriptionsListByBillingProfileParameters + >; +} +alias BillingSubscriptionOperationGroupOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a subscription. */ + @path + @segment("billingSubscriptions") + @key + billingSubscriptionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface BillingSubscriptionOperationGroup { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + get is BillingSubscriptionOperationGroupOps.Read< + BillingSubscription, + Parameters = { + /** + * Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` + */ + @query("expand") + expand?: string; + } + >; + + /** + * Updates the properties of a billing subscription. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-patch" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + @patch(#{ implicitOptionality: false }) + update is BillingSubscriptionOperationGroupOps.CustomPatchAsync< + BillingSubscription, + PatchModel = BillingSubscriptionPatch + >; + + /** + * Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + delete is BillingSubscriptionOperationGroupOps.DeleteWithoutOkAsync; + + /** + * Lists the subscriptions for a billing account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + listByBillingAccount is BillingSubscriptionOperationGroupOps.List< + BillingSubscription, + Response = ArmResponse, + Parameters = BillingSubscriptionsListByBillingAccountParameters + >; + + /** + * Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + cancel is BillingSubscriptionOperationGroupOps.ActionAsync< + BillingSubscription, + CancelSubscriptionRequest, + void, + Response = ArmAcceptedLroResponse + >; + + /** + * Merges the billing subscription provided in the request with a target billing subscription. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + merge is BillingSubscriptionOperationGroupOps.ActionAsync< + BillingSubscription, + BillingSubscriptionMergeRequest, + BillingSubscription + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + move is BillingSubscriptionOperationGroupOps.ActionAsync< + BillingSubscription, + MoveBillingSubscriptionRequest, + BillingSubscription + >; + + /** + * Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + split is BillingSubscriptionOperationGroupOps.ActionAsync< + BillingSubscription, + BillingSubscriptionSplitRequest, + BillingSubscription + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + validateMoveEligibility is BillingSubscriptionOperationGroupOps.ActionSync< + BillingSubscription, + MoveBillingSubscriptionRequest, + ArmResponse + >; +} + +alias BillingSubscriptionsListByBillingProfileParameters = { + /** + * Can be used to get deleted billing subscriptions. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` + */ + @query("expand") + expand?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +alias BillingSubscriptionsListByBillingAccountParameters = { + /** + * Can be used to get deleted billing subscriptions. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts. + */ + @query("includeTenantSubscriptions") + includeTenantSubscriptions?: boolean = false; + + /** + * Can be used to get failed billing subscriptions. + */ + @query("includeFailed") + includeFailed?: boolean = false; + + /** + * Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` + */ + @query("expand") + expand?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +@@doc(BillingSubscription.name, + "The ID that uniquely identifies a subscription." +); +@@doc(BillingSubscription.properties, + "The properties of a(n) BillingSubscription" +); +@@doc(BillingSubscriptionOperationGroup.update::parameters.properties, + "The billing properties of a subscription." +); +@@doc(BillingSubscriptionOperationGroup.cancel::parameters.body, + "Request parameters for cancel customer subscription." +); +@@doc(BillingSubscriptionOperationGroup.merge::parameters.body, + "Request parameters that are provided to merge the two billing subscriptions." +); +@@doc(BillingSubscriptionOperationGroup.move::parameters.body, + "Request parameters to transfer billing subscription." +); +@@doc(BillingSubscriptionOperationGroup.split::parameters.body, + "Request parameters that are provided to split the billing subscription." +); +@@doc(BillingSubscriptionOperationGroup.validateMoveEligibility::parameters.body, + "Request parameters to transfer billing subscription." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingSubscriptionAlias.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingSubscriptionAlias.tsp new file mode 100644 index 000000000000..3704b382382f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/BillingSubscriptionAlias.tsp @@ -0,0 +1,145 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A billing subscription alias. + */ +@tenantResource +@parentResource(BillingAccount) +model BillingSubscriptionAlias + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BillingSubscriptionAlias, + KeyName = "aliasName", + SegmentName = "billingSubscriptionAliases", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias BillingSubscriptionAliasOps = Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter; + ...Azure.ResourceManager.Legacy.Provider; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + }, + { + /** The ID that uniquely identifies a subscription alias. */ + @path + @segment("billingSubscriptionAliases") + @key + aliasName: string; + } +>; + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations(#{ omitTags: true }) +interface BillingSubscriptionAliases { + /** + * Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + get is BillingSubscriptionAliasOps.Read; + + /** + * Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + createOrUpdate is BillingSubscriptionAliasOps.CreateOrUpdateAsync< + BillingSubscriptionAlias, + Response = ArmResourceUpdatedResponse | ArmResourceCreatedResponse | ArmAcceptedLroResponse & + Azure.Core.Foundations.RetryAfterHeader> + >; + + /** + * Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + listByBillingAccount is BillingSubscriptionAliasOps.List< + BillingSubscriptionAlias, + Parameters = BillingSubscriptionAliasesListByBillingAccountParameters, + Response = ArmResponse + >; +} + +alias BillingSubscriptionAliasesListByBillingAccountParameters = { + /** + * Can be used to get deleted billing subscriptions. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +@@doc(BillingSubscriptionAlias.name, + "The ID that uniquely identifies a subscription alias." +); +@@doc(BillingSubscriptionAlias.properties, + "The properties of a(n) BillingSubscriptionAlias" +); +@@doc(BillingSubscriptionAliases.createOrUpdate::parameters.resource, + "A billing subscription alias." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/Customer.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/Customer.tsp new file mode 100644 index 000000000000..bea702dbb8c0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/Customer.tsp @@ -0,0 +1,710 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingProfile.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A partner's customer. + */ +@tenantResource +@parentResource(BillingProfile) +model Customer is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = Customer, + KeyName = "customerName", + SegmentName = "customers", + NamePattern = "^[a-zA-Z\\d-_]{1,128}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias CustomerOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + }, + {}, + { + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + customerName: string; + } +>; + +alias CustomerNoPatternOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + billingProfileName: string; + }, + {}, + { + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + customerName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface Customers { + /** + * Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Customer") + get is CustomerOps.Read; + + /** + * Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Customer") + listByBillingProfile is CustomerOps.List< + Customer, + Parameters = { + /** + * May be used to expand enabledAzurePlans and resellers + */ + @query("expand") + expand?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; + + /** + * Lists the billing permissions the caller has for a customer. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @list + @get + @action("billingPermissions") + listByCustomer is CustomerOps.ActionSync< + Customer, + void, + ArmResponse + >; + + /** + * Provides a list of check access response objects for a customer. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @action("checkAccess") + checkAccessByCustomer is CustomerOps.ActionSync< + Customer, + CheckAccessRequest, + ArmResponse + >; + + /** + * The list of billing requests submitted for the customer. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRequest") + @list + @get + @action("billingRequests") + billingRequestsListByCustomer is CustomerOps.ActionSync< + Customer, + void, + ArmResponse, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + + /** + * Adds a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("createBillingRoleAssignment") + createByCustomer is CustomerOps.ActionAsync< + Customer, + BillingRoleAssignmentProperties, + BillingRoleAssignment + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("resolveBillingRoleAssignments") + resolveByCustomer is CustomerOps.ActionAsync< + Customer, + void, + BillingRoleAssignmentListResult, + Parameters = BillingRoleAssignmentsResolveByCustomerParameters + >; + + /** + * Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + @list + @get + @action("billingSubscriptions") + billingSubscriptionsListByCustomer is CustomerNoPatternOps.ActionSync< + Customer, + void, + ArmResponse, + Parameters = BillingSubscriptionsListByCustomerParameters + >; + + /** + * Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + @put + @action("policies/default") + createOrUpdateByCustomer is CustomerOps.ActionAsync< + Customer, + CustomerPolicy, + CustomerPolicy, + Response = ArmResourceCreatedResponse< + CustomerPolicy, + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + > | ArmResponse + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Transaction") + @list + @get + @action("transactions") + transactionsListByCustomer is CustomerOps.ActionSync< + Customer, + void, + ArmResponse, + Parameters = { + /** + * The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. + */ + @query("periodStartDate") + periodStartDate: plainDate; + + /** + * The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. + */ + @query("periodEndDate") + periodEndDate: plainDate; + + /** + * The type of transaction. + */ + @query("type") + type: TransactionType; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; +} + +alias CustomerOperationGroupOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + customerName: string; + } +>; + +alias CustomerOperationGroupNoPatternOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + customerName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface CustomerOperationGroup { + /** + * Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Customer") + getByBillingAccount is CustomerOperationGroupOps.Read; + + /** + * Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Customer") + listByBillingAccount is CustomerOperationGroupOps.List< + Customer, + Parameters = { + /** + * May be used to expand enabledAzurePlans and resellers + */ + @query("expand") + expand?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; + + /** + * Lists the billing permissions the caller has for a customer at billing account level. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @list + @get + @action("billingPermissions") + listByCustomerAtBillingAccount is CustomerOperationGroupOps.ActionSync< + Customer, + void, + ArmResponse + >; + + /** + * Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + @list + @get + @action("billingSubscriptions") + billingSubscriptionsListByCustomerAtBillingAccount is CustomerOperationGroupNoPatternOps.ActionSync< + Customer, + void, + ArmResponse, + Parameters = BillingSubscriptionsListByCustomerAtBillingAccountParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + @list + @get + @action("products") + listByCustomer is CustomerOperationGroupOps.ActionSync< + Customer, + void, + ArmResponse, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; +} + +alias BillingRoleAssignmentsResolveByCustomerParameters = { + /** + * Resolves the scope display name for each of the role assignments. + */ + @query("resolveScopeDisplayNames") + resolveScopeDisplayNames?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; +}; + +alias BillingSubscriptionsListByCustomerParameters = { + /** + * Can be used to get deleted billing subscriptions. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` + */ + @query("expand") + expand?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +alias BillingSubscriptionsListByCustomerAtBillingAccountParameters = { + /** + * Can be used to get deleted billing subscriptions. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` + */ + @query("expand") + expand?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +@@doc(Customer.name, "The ID that uniquely identifies a customer."); +@@doc(Customer.properties, "A partner's customer."); +@@doc(Customers.checkAccessByCustomer::parameters.body, + "The request object against which access of the caller will be checked." +); +@@doc(Customers.createByCustomer::parameters.body, + "The properties of the billing role assignment." +); +@@doc(Customers.createOrUpdateByCustomer::parameters.body, + "A policy at customer scope." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/CustomerPolicy.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/CustomerPolicy.tsp new file mode 100644 index 000000000000..5a0b4e4579af --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/CustomerPolicy.tsp @@ -0,0 +1,152 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Customer.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A policy at customer scope. + */ +@tenantResource +@parentResource(Customer) +model CustomerPolicy + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = CustomerPolicy, + KeyName = "policyName", + SegmentName = "policies", + NamePattern = "", + Type = ServiceDefinedResourceName + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias CustomerPolicyOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + billingProfileName: string; + + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + customerName: string; + }, + {}, + { + /** Service-defined resource names such as 'default' which are reserved resource names. */ + @path + @segment("policies") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + policyName: ServiceDefinedResourceName; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface CustomerPolicies { + /** + * Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + getByCustomer is CustomerPolicyOps.Read; +} +alias PolicyOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The ID that uniquely identifies a customer. */ + @path + @segment("customers") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + customerName: string; + }, + {}, + { + /** undefined */ + @path + @segment("policies") + @key + default: "default"; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface Policies { + /** + * Lists the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + getByCustomerAtBillingAccount is PolicyOps.Read; + + /** + * Updates the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + createOrUpdateByCustomerAtBillingAccount is PolicyOps.CreateOrUpdateAsync< + CustomerPolicy, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; +} + +@@doc(CustomerPolicy.name, + "Service-defined resource names such as 'default' which are reserved resource names." +); +@@doc(CustomerPolicy.properties, "A policy at customer scope."); +@@doc(Policies.createOrUpdateByCustomerAtBillingAccount::parameters.resource, + "A policy at customer scope." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/Department.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/Department.tsp new file mode 100644 index 000000000000..821450f213e9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/Department.tsp @@ -0,0 +1,128 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets. + */ +@tenantResource +@parentResource(BillingAccount) +model Department is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = Department, + KeyName = "departmentName", + SegmentName = "departments", + NamePattern = "^[a-zA-Z\\d-_]{1,128}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface Departments { + /** + * Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Department") + get is ArmResourceRead< + Department, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the departments that a user has access to. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Department") + listByBillingAccount is ArmResourceListByParent< + Department, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; + + /** + * Lists the billing permissions the caller has for a department. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @list + @get + @action("billingPermissions") + listByDepartment is ArmResourceActionSync< + Department, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Provides a list of check access response objects for a department. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @action("checkAccess") + checkAccessByDepartment is ArmResourceActionSync< + Department, + CheckAccessRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; +} + +@@doc(Department.name, "The name of the department."); +@@doc(Department.properties, + "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets." +); +@@doc(Departments.checkAccessByDepartment::parameters.body, + "The request object against which access of the caller will be checked." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/EnrollmentAccount.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/EnrollmentAccount.tsp new file mode 100644 index 000000000000..ed6880db22a6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/EnrollmentAccount.tsp @@ -0,0 +1,330 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Department.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * It is an organizational hierarchy within a billing account to administer and manage azure costs. + */ +@tenantResource +@parentResource(Department) +model EnrollmentAccount + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = EnrollmentAccount, + KeyName = "enrollmentAccountName", + SegmentName = "enrollmentAccounts", + NamePattern = "^[a-zA-Z\\d-_]{1,128}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias EnrollmentAccountOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + + /** The name of the department. */ + @path + @segment("departments") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + departmentName: string; + }, + {}, + { + /** The name of the enrollment account. */ + @path + @segment("enrollmentAccounts") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + enrollmentAccountName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface EnrollmentAccounts { + /** + * Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("EnrollmentAccount") + getByDepartment is EnrollmentAccountOps.Read; + + /** + * Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("EnrollmentAccount") + listByDepartment is EnrollmentAccountOps.List< + EnrollmentAccount, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; +} + +alias EnrollmentAccountOperationGroupOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + }, + {}, + { + /** The name of the enrollment account. */ + @path + @segment("enrollmentAccounts") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + enrollmentAccountName: string; + } +>; + +alias EnrollmentAccountOperationGroupNoPatternOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + }, + {}, + { + /** The name of the enrollment account. */ + @path + @segment("enrollmentAccounts") + @key + @pattern("^[a-zA-Z\\d-_]{1,128}$") + enrollmentAccountName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface EnrollmentAccountOperationGroup { + /** + * Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("EnrollmentAccount") + get is EnrollmentAccountOperationGroupOps.Read; + + /** + * Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("EnrollmentAccount") + listByBillingAccount is EnrollmentAccountOperationGroupOps.List< + EnrollmentAccount, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; + + /** + * Lists the billing permissions the caller has for an enrollment account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @list + @get + @action("billingPermissions") + listByEnrollmentAccount is EnrollmentAccountOperationGroupOps.ActionSync< + EnrollmentAccount, + void, + ArmResponse + >; + + /** + * Provides a list of check access response objects for an enrollment account. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @action("checkAccess") + checkAccessByEnrollmentAccount is EnrollmentAccountOperationGroupOps.ActionSync< + EnrollmentAccount, + CheckAccessRequest, + ArmResponse + >; + + /** + * Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + @list + @get + @action("billingSubscriptions") + billingSubscriptionsListByEnrollmentAccount is EnrollmentAccountOperationGroupNoPatternOps.ActionSync< + EnrollmentAccount, + void, + ArmResponse, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; +} + +@@doc(EnrollmentAccount.name, "The name of the enrollment account."); +@@doc(EnrollmentAccount.properties, + "It is an organizational hierarchy within a billing account to administer and manage azure costs." +); +@@doc(EnrollmentAccountOperationGroup.checkAccessByEnrollmentAccount::parameters.body, + "The request object against which access of the caller will be checked." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/Invoice.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/Invoice.tsp new file mode 100644 index 000000000000..782c0bddf5ba --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/Invoice.tsp @@ -0,0 +1,435 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * An invoice. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/improper-subscription-list-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@tenantResource +@parentResource(BillingAccount) +model Invoice is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = Invoice, + KeyName = "invoiceName", + SegmentName = "invoices", + NamePattern = "^(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})$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias InvoiceOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + @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})?)$") + billingAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies an invoice. */ + @path + @segment("invoices") + @key + @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})$") + invoiceName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface Invoices { + /** + * Gets an invoice by billing account name and ID. The operation is supported for all billing account types. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + getByBillingAccount is InvoiceOps.Read; + + /** + * Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + listByBillingAccount is InvoiceOps.List< + Invoice, + Parameters = { + /** + * The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @query("periodStartDate") + periodStartDate?: plainDate; + + /** + * The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @query("periodEndDate") + periodEndDate?: plainDate; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; + + /** + * Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + amend is InvoiceOps.ActionAsync< + Invoice, + void, + Invoice, + Response = ArmAcceptedLroResponse + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + @action("download") + downloadByBillingAccount is InvoiceOps.ActionAsync< + Invoice, + void, + DocumentDownloadResult, + Parameters = { + /** + * 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. + */ + @query("documentName") + documentName?: string; + } + >; + + /** + * Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + @action("downloadSummary") + downloadSummaryByBillingAccount is InvoiceOps.ActionAsync< + Invoice, + void, + DocumentDownloadResult + >; + + /** + * Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Transaction") + @list + @get + @action("transactions") + listByInvoice is InvoiceOps.ActionSync< + Invoice, + void, + ArmResponse, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + + /** + * Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Transaction") + @action("transactionsDownload") + transactionsDownloadByInvoice is InvoiceOps.ActionAsync< + Invoice, + void, + DocumentDownloadResult + >; + + /** + * Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Transaction") + @get + @action("transactionSummary") + getTransactionSummaryByInvoice is InvoiceOps.ActionSync< + Invoice, + void, + ArmResponse, + Parameters = { + /** + * The filter query option allows clients to filter the line items that are aggregated to create the line item summary. + */ + @query("filter") + filter?: string; + + /** + * The search query option allows clients to filter the line items that are aggregated to create the line item summary. + */ + @query("search") + search?: string; + } + >; +} +alias InvoiceByBillingSubscriptionOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** undefined */ + @path + @segment("billingAccounts") + @key + default: "default"; + + /** The ID that uniquely identifies a billing subscription. */ + @path + @segment("billingSubscriptions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + subscriptionId: string; + }, + {}, + { + /** The ID that uniquely identifies an invoice. */ + @path + @segment("invoices") + @key + @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})$") + invoiceName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface InvoiceByBillingSubscription { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + getByBillingSubscription is InvoiceByBillingSubscriptionOps.Read; + + /** + * Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + listByBillingSubscription is InvoiceByBillingSubscriptionOps.List< + Invoice, + Parameters = { + /** + * The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @query("periodStartDate") + periodStartDate?: plainDate; + + /** + * The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @query("periodEndDate") + periodEndDate?: plainDate; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + @action("download") + downloadByBillingSubscription is InvoiceByBillingSubscriptionOps.ActionAsync< + Invoice, + void, + DocumentDownloadResult, + Parameters = { + /** + * 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. + */ + @query("documentName") + documentName?: string; + } + >; +} +alias InvoiceByIdOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** undefined */ + @path + @segment("billingAccounts") + @key + default: "default"; + }, + {}, + { + /** The ID that uniquely identifies an invoice. */ + @path + @segment("invoices") + @key + @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})$") + invoiceName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface InvoiceById { + /** + * Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + get is InvoiceByIdOps.Read; +} + +@@doc(Invoice.name, "The ID that uniquely identifies an invoice."); +@@doc(Invoice.properties, "An invoice."); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/InvoiceSection.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/InvoiceSection.tsp new file mode 100644 index 000000000000..1c901df88e9c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/InvoiceSection.tsp @@ -0,0 +1,501 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingProfile.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * An invoice section. + */ +@tenantResource +@parentResource(BillingProfile) +model InvoiceSection + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = InvoiceSection, + KeyName = "invoiceSectionName", + SegmentName = "invoiceSections", + NamePattern = "^[a-zA-Z\\d-_]{1,128}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias InvoiceSectionOps = Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter; + ...Azure.ResourceManager.Legacy.Provider; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + billingProfileName: string; + }, + { + /** The ID that uniquely identifies an invoice section. */ + @path + @segment("invoiceSections") + @key + invoiceSectionName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface InvoiceSections { + /** + * Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("InvoiceSection") + get is ArmResourceRead< + InvoiceSection, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("InvoiceSection") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + InvoiceSection, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResourceUpdatedResponse | ArmResourceCreatedResponse< + InvoiceSection, + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + > | ArmAcceptedLroResponse + >; + + /** + * Deletes an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("InvoiceSection") + delete is ArmResourceDeleteWithoutOkAsync< + InvoiceSection, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("InvoiceSection") + listByBillingProfile is ArmResourceListByParent< + InvoiceSection, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = InvoiceSectionsListByBillingProfileParameters, + Response = ArmResponse + >; + + /** + * Lists the billing permissions the caller has for an invoice section. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @list + @get + @action("billingPermissions") + listByInvoiceSection is ArmResourceActionSync< + InvoiceSection, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Provides a list of check access response objects for an invoice section. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingPermission") + @action("checkAccess") + checkAccessByInvoiceSection is ArmResourceActionSync< + InvoiceSection, + CheckAccessRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * The list of billing requests submitted for the invoice section. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRequest") + @list + @get + @action("billingRequests") + billingRequestsListByInvoiceSection is ArmResourceActionSync< + InvoiceSection, + void, + Response = ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + + /** + * Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("createBillingRoleAssignment") + createByInvoiceSection is ArmResourceActionAsync< + InvoiceSection, + BillingRoleAssignmentProperties, + BillingRoleAssignment, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingRoleAssignment") + @action("resolveBillingRoleAssignments") + resolveByInvoiceSection is ArmResourceActionAsync< + InvoiceSection, + void, + BillingRoleAssignmentListResult, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = BillingRoleAssignmentsResolveByInvoiceSectionParameters + >; + + /** + * Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingSubscription") + @list + @get + @action("billingSubscriptions") + billingSubscriptionsListByInvoiceSection is InvoiceSectionOps.ActionSync< + InvoiceSection, + void, + ArmResponse, + Parameters = BillingSubscriptionsListByInvoiceSectionParameters + >; + + /** + * Validates if the invoice section can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("InvoiceSection") + validateDeleteEligibility is ArmResourceActionSync< + InvoiceSection, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + @list + @get + @action("products") + productsListByInvoiceSection is ArmResourceActionSync< + InvoiceSection, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Transaction") + @list + @get + @action("transactions") + transactionsListByInvoiceSection is ArmResourceActionSync< + InvoiceSection, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. + */ + @query("periodStartDate") + periodStartDate: plainDate; + + /** + * The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. + */ + @query("periodEndDate") + periodEndDate: plainDate; + + /** + * The type of transaction. + */ + @query("type") + type: TransactionType; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + } + >; +} + +alias BillingRoleAssignmentsResolveByInvoiceSectionParameters = { + /** + * Resolves the scope display name for each of the role assignments. + */ + @query("resolveScopeDisplayNames") + resolveScopeDisplayNames?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; +}; + +alias BillingSubscriptionsListByInvoiceSectionParameters = { + /** + * Can be used to get deleted billing subscriptions. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` + */ + @query("expand") + expand?: string; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +alias InvoiceSectionsListByBillingProfileParameters = { + /** + * Can be used to get deleted invoice sections. + */ + @query("includeDeleted") + includeDeleted?: boolean = false; + + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; +}; + +@@doc(InvoiceSection.name, + "The ID that uniquely identifies an invoice section." +); +@@doc(InvoiceSection.properties, "An invoice section."); +@@doc(InvoiceSections.createOrUpdate::parameters.resource, + "An invoice section." +); +@@doc(InvoiceSections.checkAccessByInvoiceSection::parameters.body, + "The request object against which access of the caller will be checked." +); +@@doc(InvoiceSections.createByInvoiceSection::parameters.body, + "The properties of the billing role assignment." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/PartnerTransferDetails.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/PartnerTransferDetails.tsp new file mode 100644 index 000000000000..9a01d71fbb06 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/PartnerTransferDetails.tsp @@ -0,0 +1,87 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Customer.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * Details of the transfer. + */ +@tenantResource +@parentResource(Customer) +model PartnerTransferDetails + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PartnerTransferDetails, + KeyName = "transferName", + SegmentName = "transfers", + NamePattern = "^[a-z0-9]*$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations(#{ omitTags: true }) +interface PartnerTransfers { + /** + * Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + @tag("Transfers") + get is ArmResourceRead< + PartnerTransferDetails, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + @tag("Transfers") + initiate is Azure.ResourceManager.Legacy.CreateOrUpdateSync< + PartnerTransferDetails, + Request = PartnerInitiateTransferRequest, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + @tag("Transfers") + list is ArmResourceListByParent< + PartnerTransferDetails, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResponse + >; + + /** + * Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. + */ + @tag("Transfers") + cancel is ArmResourceActionSync< + PartnerTransferDetails, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; +} + +@@doc(PartnerTransferDetails.name, + "The ID that uniquely identifies a transfer request." +); +@@doc(PartnerTransferDetails.properties, "Details of the transfer."); +@@doc(PartnerTransfers.initiate::parameters.resource, + "Request parameters that are provided to the initiate transfer operation." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/PaymentMethod.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/PaymentMethod.tsp new file mode 100644 index 000000000000..8e34191669d1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/PaymentMethod.tsp @@ -0,0 +1,134 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A payment method. + */ +@tenantResource +@parentResource(BillingAccount) +model PaymentMethod + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PaymentMethod, + KeyName = "paymentMethodName", + SegmentName = "paymentMethods", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias PaymentMethodOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + }, + {}, + { + /** The ID that uniquely identifies a payment method. */ + @path + @segment("paymentMethods") + @key + paymentMethodName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface PaymentMethods { + /** + * Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("PaymentMethods") + getByBillingAccount is PaymentMethodOps.Read; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("PaymentMethods") + listByBillingAccount is PaymentMethodOps.List< + PaymentMethod, + Response = ArmResponse + >; +} +alias PaymentMethodOperationGroupOps = Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter; + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing"; + }, + {}, + { + /** The ID that uniquely identifies a payment method. */ + @path + @segment("paymentMethods") + @key + paymentMethodName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface PaymentMethodOperationGroup { + /** + * Gets a payment method owned by the caller. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("PaymentMethods") + getByUser is PaymentMethodOperationGroupOps.Read; + + /** + * Deletes a payment method owned by the caller. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("PaymentMethods") + deleteByUser is PaymentMethodOperationGroupOps.DeleteSync; + + /** + * Lists the payment methods owned by the caller. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("PaymentMethods") + listByUser is PaymentMethodOperationGroupOps.List< + PaymentMethod, + Response = ArmResponse + >; +} + +@@doc(PaymentMethod.name, "The ID that uniquely identifies a payment method."); +@@doc(PaymentMethod.properties, "Payment method properties"); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/PaymentMethodLink.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/PaymentMethodLink.tsp new file mode 100644 index 000000000000..7e5b63f016e2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/PaymentMethodLink.tsp @@ -0,0 +1,87 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingProfile.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A payment method link. + */ +@tenantResource +@parentResource(BillingProfile) +model PaymentMethodLink + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PaymentMethodLink, + KeyName = "paymentMethodName", + SegmentName = "paymentMethodLinks", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +alias PaymentMethodLinkOps = Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter; + ...Azure.ResourceManager.Legacy.Provider; + + /** The ID that uniquely identifies a billing account. */ + @path + @segment("billingAccounts") + @key + billingAccountName: string; + + /** The ID that uniquely identifies a billing profile. */ + @path + @segment("billingProfiles") + @key + billingProfileName: string; + }, + { + /** The ID that uniquely identifies a payment method. */ + @path + @segment("paymentMethodLinks") + @key + paymentMethodName: string; + } +>; + +@armResourceOperations(#{ omitTags: true }) +interface PaymentMethodLinks { + /** + * Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("PaymentMethods") + getByBillingProfile is PaymentMethodLinkOps.Read; + + /** + * Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("PaymentMethods") + listByBillingProfile is PaymentMethodLinkOps.List< + PaymentMethodLink, + Response = ArmResponse + >; +} + +@@doc(PaymentMethodLink.name, + "The ID that uniquely identifies a payment method." +); +@@doc(PaymentMethodLink.properties, "Payment method link properties"); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/Product.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/Product.tsp new file mode 100644 index 000000000000..ab0a20ae308b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/Product.tsp @@ -0,0 +1,146 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A product. + */ +@tenantResource +@parentResource(BillingAccount) +model Product is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = Product, + KeyName = "productName", + SegmentName = "products", + NamePattern = "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface Products { + /** + * Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + get is ArmResourceRead< + Product, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-patch" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + Product, + PatchModel = ProductPatch, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + listByBillingAccount is ArmResourceListByParent< + Product, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * 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. + */ + @query("top") + top?: int64; + + /** + * The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + */ + @query("skip") + skip?: int64; + + /** + * The count query option allows clients to request a count of the matching resources included with the resources in the response. + */ + @query("count") + count?: boolean; + + /** + * 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. + */ + @query("search") + search?: string; + }, + Response = ArmResponse + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + move is ArmResourceActionAsync< + Product, + MoveProductRequest, + Product, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Product") + validateMoveEligibility is ArmResourceActionSync< + Product, + MoveProductRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; +} + +@@doc(Product.name, "The ID that uniquely identifies a product."); +@@doc(Product.properties, "A product."); +@@doc(Products.update::parameters.properties, "A product."); +@@doc(Products.move::parameters.body, + "The properties of the product to initiate a transfer." +); +@@doc(Products.validateMoveEligibility::parameters.body, + "The properties of the product to initiate a transfer." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/RecipientTransferDetails.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/RecipientTransferDetails.tsp new file mode 100644 index 000000000000..ece3a0de171d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/RecipientTransferDetails.tsp @@ -0,0 +1,98 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * Details of the transfer. + */ +@tenantResource +model RecipientTransferDetails + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = RecipientTransferDetails, + KeyName = "transferName", + SegmentName = "transfers", + NamePattern = "^[a-z0-9]*$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations +interface RecipientTransfers { + /** + * Gets a transfer request by ID. The caller must be the recipient of the transfer request. + */ + @summary("Gets a transfer request by ID. The caller must be the recipient of the transfer request.") + get is ArmResourceRead< + RecipientTransferDetails, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the transfer requests received by the caller. + */ + @summary("Lists the transfer requests received by the caller.") + list is ArmResourceListByParent< + RecipientTransferDetails, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResponse + >; + + /** + * Accepts a transfer request. + */ + @summary("Accepts a transfer request.") + accept is ArmResourceActionSync< + RecipientTransferDetails, + AcceptTransferRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + @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.") + validate is ArmResourceActionSync< + RecipientTransferDetails, + AcceptTransferRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Declines a transfer request. + */ + @summary("Declines a transfer request.") + decline is ArmResourceActionSync< + RecipientTransferDetails, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; +} + +@@doc(RecipientTransferDetails.name, + "The ID that uniquely identifies a transfer request." +); +@@doc(RecipientTransferDetails.properties, "Details of the transfer."); +@@doc(RecipientTransfers.accept::parameters.body, + "Request parameters that are provided to the accept transfer operation." +); +@@doc(RecipientTransfers.validate::parameters.body, + "Request parameters that are provided to the validate transfer operation." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/Reservation.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/Reservation.tsp new file mode 100644 index 000000000000..37780c71d85a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/Reservation.tsp @@ -0,0 +1,88 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ReservationOrder.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * The definition of the reservation. + */ +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@tenantResource +@parentResource(ReservationOrder) +model Reservation + is Azure.ResourceManager.Legacy.TrackedResourceWithOptionalLocation { + ...ResourceNameParameter< + Resource = Reservation, + KeyName = "reservationId", + SegmentName = "reservations", + NamePattern = "" + >; + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + etag?: int32; + + /** + * The sku information associated to this reservation + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + sku?: ReservationSkuProperty; +} + +@armResourceOperations(#{ omitTags: true }) +interface Reservations { + /** + * Get specific Reservation details in the billing account. + */ + @summary("Get Reservation details in the billing account.") + @tag("Reservation") + getByReservationOrder is ArmResourceRead< + Reservation, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * May be used to expand the detail information of some properties. + */ + @query("expand") + expand?: string; + } + >; + + /** + * Update reservation by billing account. + */ + @tag("Reservation") + @patch(#{ implicitOptionality: false }) + updateByBillingAccount is ArmCustomPatchAsync< + Reservation, + PatchModel = Patch, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + LroHeaders = ArmAsyncOperationHeader & + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * List Reservations within a single ReservationOrder in the billing account. + */ + @summary("Get Reservations in a given reservation Order in the billing account") + @tag("Reservations") + listByReservationOrder is ArmResourceListByParent< + Reservation, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResponse + >; +} + +@@doc(Reservation.name, "Id of the reservation item"); +@@doc(Reservation.properties, "The properties associated to this reservation"); +@@doc(Reservations.updateByBillingAccount::parameters.properties, + "Request body for patching a reservation" +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/ReservationOrder.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/ReservationOrder.tsp new file mode 100644 index 000000000000..2df50eb37af2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/ReservationOrder.tsp @@ -0,0 +1,92 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * Details of a reservation order being returned. + */ +@tenantResource +@parentResource(BillingAccount) +model ReservationOrder + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ReservationOrder, + KeyName = "reservationOrderId", + SegmentName = "reservationOrders", + NamePattern = "" + >; + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + etag?: int32; + + /** + * Tags for this reservation + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface ReservationOrders { + /** + * Get the details of the ReservationOrder in the billing account. + */ + @summary("Get a specific ReservationOrder in the billing account.") + @tag("ReservationOrder") + getByBillingAccount is ArmResourceRead< + ReservationOrder, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * May be used to expand the detail information of some properties. + */ + @query("expand") + expand?: string; + } + >; + + /** + * List all the ReservationOrders in the billing account. + */ + @summary("Get all `ReservationOrders in the billing account.") + @tag("ReservationOrders") + listByBillingAccount is ArmResourceListByParent< + ReservationOrder, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * The number of reservations to skip from the list before returning results + */ + @query("skiptoken") + skiptoken?: float32; + }, + Response = ArmResponse + >; +} + +@@doc(ReservationOrder.name, "Order Id of the reservation"); +@@doc(ReservationOrder.properties, + "The properties associated to this reservation order" +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/SavingsPlanModel.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/SavingsPlanModel.tsp new file mode 100644 index 000000000000..9339cca2e29b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/SavingsPlanModel.tsp @@ -0,0 +1,104 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./SavingsPlanOrderModel.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * Savings plan + */ +@tenantResource +@parentResource(SavingsPlanOrderModel) +model SavingsPlanModel + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = SavingsPlanModel, + KeyName = "savingsPlanId", + SegmentName = "savingsPlans", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; + + /** + * Savings plan SKU + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + sku: Sku; +} + +@armResourceOperations(#{ omitTags: true }) +interface SavingsPlanModels { + /** + * Get savings plan by billing account. + */ + @tag("Savings plan") + getByBillingAccount is ArmResourceRead< + SavingsPlanModel, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * May be used to expand the planInformation. + */ + @query("expand") + expand?: string; + } + >; + + /** + * Update savings plan by billing account. + */ + @tag("Savings plan") + @patch(#{ implicitOptionality: false }) + updateByBillingAccount is ArmCustomPatchAsync< + SavingsPlanModel, + PatchModel = SavingsPlanUpdateRequest, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + LroHeaders = ArmAsyncOperationHeader & + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * List savings plans in an order by billing account. + */ + @tag("Savings plan") + listBySavingsPlanOrder is ArmResourceListByParent< + SavingsPlanModel, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResponse + >; + + /** + * Validate savings plan patch by billing account. + */ + @tag("Savings plan") + @action("validate") + validateUpdateByBillingAccount is ArmResourceActionSync< + SavingsPlanModel, + SavingsPlanUpdateValidateRequest, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; +} + +@@doc(SavingsPlanModel.name, "ID of the savings plan"); +@@doc(SavingsPlanModel.properties, "Savings plan properties"); +@@doc(SavingsPlanModels.updateByBillingAccount::parameters.properties, + "Request body for patching a savings plan order alias" +); +@@doc(SavingsPlanModels.validateUpdateByBillingAccount::parameters.body, + "Request body for patching a savings plan order alias" +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/SavingsPlanOrderModel.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/SavingsPlanOrderModel.tsp new file mode 100644 index 000000000000..6fddc4ecb3e5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/SavingsPlanOrderModel.tsp @@ -0,0 +1,91 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./BillingAccount.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * Savings plan order + */ +@tenantResource +@parentResource(BillingAccount) +model SavingsPlanOrderModel + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = SavingsPlanOrderModel, + KeyName = "savingsPlanOrderId", + SegmentName = "savingsPlanOrders", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; + + /** + * Savings plan SKU + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + sku: Sku; +} + +@armResourceOperations(#{ omitTags: true }) +interface SavingsPlanOrderModels { + /** + * Get a savings plan order by billing account. + */ + @tag("Savings plan order") + getByBillingAccount is ArmResourceRead< + SavingsPlanOrderModel, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * May be used to expand the planInformation. + */ + @query("expand") + expand?: string; + } + >; + + /** + * List all Savings plan orders by billing account. + */ + @tag("Savings plan order") + listByBillingAccount is ArmResourceListByParent< + SavingsPlanOrderModel, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Parameters = { + /** + * The filter query option allows clients to filter a collection of resources that are addressed by a request URL. + */ + @query("filter") + filter?: string; + + /** + * The orderby query option allows clients to request resources in a particular order. + */ + @query("orderBy") + orderBy?: string; + + /** + * The number of savings plans to skip from the list before returning results + */ + @query("skiptoken") + skiptoken?: float32; + }, + Response = ArmResponse + >; +} + +@@doc(SavingsPlanOrderModel.name, "Order ID of the savings plan"); +@@doc(SavingsPlanOrderModel.properties, "Savings plan order properties"); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/SubscriptionPolicy.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/SubscriptionPolicy.tsp new file mode 100644 index 000000000000..f723b94ab439 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/SubscriptionPolicy.tsp @@ -0,0 +1,50 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * A policy at subscription scope. + */ +@singleton("default") +@subscriptionResource +model SubscriptionPolicy + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = SubscriptionPolicy, + KeyName = "policy", + SegmentName = "policies", + NamePattern = "" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +@armResourceOperations(#{ omitTags: true }) +interface SubscriptionPolicies { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Policy") + getBySubscription is ArmResourceRead< + SubscriptionPolicy, + BaseParameters = Azure.ResourceManager.Foundations.SubscriptionBaseParameters + >; +} + +@@doc(SubscriptionPolicy.name, ""); +@@doc(SubscriptionPolicy.properties, "A policy at subscription scope."); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/TransferDetails.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/TransferDetails.tsp new file mode 100644 index 000000000000..21bde68b6c39 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/TransferDetails.tsp @@ -0,0 +1,82 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./InvoiceSection.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; +/** + * Details of the transfer. + */ +@tenantResource +@parentResource(InvoiceSection) +model TransferDetails + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TransferDetails, + KeyName = "transferName", + SegmentName = "transfers", + NamePattern = "^[a-z0-9]*$" + >; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface Transfers { + /** + * Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + get is ArmResourceRead< + TransferDetails, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * 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. + */ + initiate is Azure.ResourceManager.Legacy.CreateOrUpdateSync< + TransferDetails, + Request = InitiateTransferRequest, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; + + /** + * Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + list is ArmResourceListByParent< + TransferDetails, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters, + Response = ArmResponse + >; + + /** + * Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. + */ + cancel is ArmResourceActionSync< + TransferDetails, + void, + ArmResponse, + BaseParameters = Azure.ResourceManager.Foundations.TenantBaseParameters + >; +} + +@@doc(TransferDetails.name, + "The ID that uniquely identifies a transfer request." +); +@@doc(TransferDetails.properties, "Details of the transfer."); +@@doc(Transfers.initiate::parameters.resource, + "Request parameters that are provided to the initiate transfer operation." +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/back-compatible.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/back-compatible.tsp new file mode 100644 index 000000000000..2aba14d27cf2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/back-compatible.tsp @@ -0,0 +1,558 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.Billing; + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(ExtendedStatusInfo.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(PurchaseRequest.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(BillingSubscriptionProperties.enrollmentAccountSubscriptionDetails +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(BillingSubscriptionPatch.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(ReservationProperty.utilization); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(ReservationPurchaseRequest.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(ReservationPurchaseRequestProperties.reservedResourceProperties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(Patch.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(PatchProperties.renewProperties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(InitiateTransferRequest.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(PartnerInitiateTransferRequest.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(AcceptTransferRequest.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(ValidateTransferResponse.properties); + +@@clientName(AssociatedTenants.createOrUpdate::parameters.resource, + "parameters" +); + +@@clientLocation(AvailableBalanceOperationGroup.getByBillingProfile, + AvailableBalances +); + +@@clientName(BillingAccounts.update::parameters.properties, "parameters"); +@@clientName(BillingAccounts.addPaymentTerms::parameters.body, "parameters"); +@@clientName(BillingAccounts.cancelPaymentTerms::parameters.body, "parameters"); +@@clientName(BillingAccounts.validatePaymentTerms::parameters.body, + "parameters" +); +@@clientLocation(BillingAccounts.listByBillingAccount, "BillingPermissions"); +@@clientLocation(BillingAccounts.checkAccessByBillingAccount, + "BillingPermissions" +); +@@clientName(BillingAccounts.checkAccessByBillingAccount::parameters.body, + "parameters" +); +@@clientLocation(BillingAccounts.billingRequestsListByBillingAccount, + BillingRequests +); +@@clientName(BillingAccounts.billingRequestsListByBillingAccount, + "ListByBillingAccount" +); +@@clientLocation(BillingAccounts.createByBillingAccount, + BillingRoleAssignments +); +@@clientName(BillingAccounts.createByBillingAccount::parameters.body, + "parameters" +); +@@clientLocation(BillingAccounts.resolveByBillingAccount, + BillingRoleAssignments +); +@@clientLocation(BillingAccounts.savingsPlansListByBillingAccount, + "SavingsPlans" +); +@@clientName(BillingAccounts.savingsPlansListByBillingAccount, + "ListByBillingAccount" +); +@@clientLocation(BillingAccounts.downloadDocumentsByBillingAccount, Invoices); +@@clientName(BillingAccounts.downloadDocumentsByBillingAccount::parameters.body, + "parameters" +); +@@clientLocation(BillingAccounts.reservationsListByBillingAccount, + Reservations +); +@@clientName(BillingAccounts.reservationsListByBillingAccount, + "ListByBillingAccount" +); + +@@clientName(BillingProfiles.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(BillingProfiles.listByBillingProfile, "BillingPermissions"); +@@clientLocation(BillingProfiles.checkAccessByBillingProfile, + "BillingPermissions" +); +@@clientName(BillingProfiles.checkAccessByBillingProfile::parameters.body, + "parameters" +); +@@clientLocation(BillingProfiles.billingRequestsListByBillingProfile, + BillingRequests +); +@@clientName(BillingProfiles.billingRequestsListByBillingProfile, + "ListByBillingProfile" +); +@@clientLocation(BillingProfiles.createByBillingProfile, + BillingRoleAssignments +); +@@clientName(BillingProfiles.createByBillingProfile::parameters.body, + "parameters" +); +@@clientLocation(BillingProfiles.resolveByBillingProfile, + BillingRoleAssignments +); +@@clientLocation(BillingProfiles.invoicesListByBillingProfile, Invoices); +@@clientName(BillingProfiles.invoicesListByBillingProfile, + "ListByBillingProfile" +); +@@clientLocation(BillingProfiles.productsListByBillingProfile, Products); +@@clientName(BillingProfiles.productsListByBillingProfile, + "ListByBillingProfile" +); +@@clientLocation(BillingProfiles.reservationsListByBillingProfile, + Reservations +); +@@clientName(BillingProfiles.reservationsListByBillingProfile, + "ListByBillingProfile" +); +@@clientLocation(BillingProfiles.transactionsListByBillingProfile, + "Transactions" +); +@@clientName(BillingProfiles.transactionsListByBillingProfile, + "ListByBillingProfile" +); + +@@clientLocation(BillingProperties.get, "BillingProperty"); +@@clientLocation(BillingProperties.update, "BillingProperty"); +@@clientName(BillingProperties.update::parameters.properties, "parameters"); + +@@clientName(BillingRequests.createOrUpdate::parameters.resource, "parameters"); + +@@clientLocation(BillingRoleAssignmentByCustomer.getByCustomer, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByCustomer.deleteByCustomer, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByCustomer.listByCustomer, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByInvoiceSection.getByInvoiceSection, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByInvoiceSection.deleteByInvoiceSection, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByInvoiceSection.listByInvoiceSection, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByBillingAccount.getByBillingAccount, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByBillingAccount.createOrUpdateByBillingAccount, + BillingRoleAssignments +); +@@clientName(BillingRoleAssignmentByBillingAccount.createOrUpdateByBillingAccount::parameters.resource, + "parameters" +); +@@clientLocation(BillingRoleAssignmentByBillingAccount.deleteByBillingAccount, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByBillingAccount.listByBillingAccount, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByDepartment.getByDepartment, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByDepartment.createOrUpdateByDepartment, + BillingRoleAssignments +); +@@clientName(BillingRoleAssignmentByDepartment.createOrUpdateByDepartment::parameters.resource, + "parameters" +); +@@clientLocation(BillingRoleAssignmentByDepartment.deleteByDepartment, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByDepartment.listByDepartment, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByEnrollmentAccount.getByEnrollmentAccount, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByEnrollmentAccount.createOrUpdateByEnrollmentAccount, + BillingRoleAssignments +); +@@clientName(BillingRoleAssignmentByEnrollmentAccount.createOrUpdateByEnrollmentAccount::parameters.resource, + "parameters" +); +@@clientLocation(BillingRoleAssignmentByEnrollmentAccount.deleteByEnrollmentAccount, + BillingRoleAssignments +); +@@clientLocation(BillingRoleAssignmentByEnrollmentAccount.listByEnrollmentAccount, + BillingRoleAssignments +); + +@@clientLocation(BillingRoleDefinitions.getByBillingProfile, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitions.listByBillingProfile, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByCustomer.getByCustomer, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByCustomer.listByCustomer, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByInvoiceSection.getByInvoiceSection, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByInvoiceSection.listByInvoiceSection, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByBillingAccount.getByBillingAccount, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByBillingAccount.listByBillingAccount, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByDepartment.getByDepartment, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByDepartment.listByDepartment, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByEnrollmentAccount.getByEnrollmentAccount, + "BillingRoleDefinition" +); +@@clientLocation(BillingRoleDefinitionByEnrollmentAccount.listByEnrollmentAccount, + "BillingRoleDefinition" +); + +@@clientLocation(SavingsPlanOrderModels.getByBillingAccount, + "SavingsPlanOrders" +); +@@clientLocation(SavingsPlanOrderModels.listByBillingAccount, + "SavingsPlanOrders" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(SavingsPlanOrderModel.properties); + +@@clientLocation(SavingsPlanModels.getByBillingAccount, "SavingsPlans"); +@@clientLocation(SavingsPlanModels.updateByBillingAccount, "SavingsPlans"); +@@clientName(SavingsPlanModels.updateByBillingAccount::parameters.properties, + "body" +); +@@clientLocation(SavingsPlanModels.listBySavingsPlanOrder, "SavingsPlans"); +@@clientLocation(SavingsPlanModels.validateUpdateByBillingAccount, + "SavingsPlans" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(SavingsPlanModel.properties); + +@@clientLocation(BillingSubscriptionOperationGroup.get, BillingSubscriptions); +@@clientLocation(BillingSubscriptionOperationGroup.update, + BillingSubscriptions +); +@@clientName(BillingSubscriptionOperationGroup.update::parameters.properties, + "parameters" +); +@@clientLocation(BillingSubscriptionOperationGroup.delete, + BillingSubscriptions +); +@@clientLocation(BillingSubscriptionOperationGroup.listByBillingAccount, + BillingSubscriptions +); +@@clientLocation(BillingSubscriptionOperationGroup.cancel, + BillingSubscriptions +); +@@clientName(BillingSubscriptionOperationGroup.cancel::parameters.body, + "parameters" +); +@@clientLocation(BillingSubscriptionOperationGroup.merge, BillingSubscriptions); +@@clientName(BillingSubscriptionOperationGroup.merge::parameters.body, + "parameters" +); +@@clientLocation(BillingSubscriptionOperationGroup.move, BillingSubscriptions); +@@clientName(BillingSubscriptionOperationGroup.move::parameters.body, + "parameters" +); +@@clientLocation(BillingSubscriptionOperationGroup.split, BillingSubscriptions); +@@clientName(BillingSubscriptionOperationGroup.split::parameters.body, + "parameters" +); +@@clientLocation(BillingSubscriptionOperationGroup.validateMoveEligibility, + BillingSubscriptions +); +@@clientName(BillingSubscriptionOperationGroup.validateMoveEligibility::parameters.body, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(BillingSubscription.properties); + +@@clientLocation(BillingSubscriptionAliases.get, "BillingSubscriptionsAliases"); +@@clientLocation(BillingSubscriptionAliases.createOrUpdate, + "BillingSubscriptionsAliases" +); +@@clientName(BillingSubscriptionAliases.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(BillingSubscriptionAliases.listByBillingAccount, + "BillingSubscriptionsAliases" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(BillingSubscriptionAlias.properties); + +@@clientLocation(Customers.listByCustomer, "BillingPermissions"); +@@clientLocation(Customers.checkAccessByCustomer, "BillingPermissions"); +@@clientName(Customers.checkAccessByCustomer::parameters.body, "parameters"); +@@clientLocation(Customers.billingRequestsListByCustomer, BillingRequests); +@@clientName(Customers.billingRequestsListByCustomer, "ListByCustomer"); +@@clientLocation(Customers.createByCustomer, BillingRoleAssignments); +@@clientName(Customers.createByCustomer::parameters.body, "parameters"); +@@clientLocation(Customers.resolveByCustomer, BillingRoleAssignments); +@@clientLocation(Customers.billingSubscriptionsListByCustomer, + BillingSubscriptions +); +@@clientName(Customers.billingSubscriptionsListByCustomer, "ListByCustomer"); +@@clientLocation(Customers.createOrUpdateByCustomer, Policies); +@@clientName(Customers.createOrUpdateByCustomer::parameters.body, "parameters"); +@@clientLocation(Customers.transactionsListByCustomer, "Transactions"); +@@clientName(Customers.transactionsListByCustomer, "ListByCustomer"); +@@clientLocation(CustomerOperationGroup.getByBillingAccount, Customers); +@@clientLocation(CustomerOperationGroup.listByBillingAccount, Customers); +@@clientLocation(CustomerOperationGroup.listByCustomerAtBillingAccount, + "BillingPermissions" +); +@@clientLocation(CustomerOperationGroup.billingSubscriptionsListByCustomerAtBillingAccount, + BillingSubscriptions +); +@@clientName(CustomerOperationGroup.billingSubscriptionsListByCustomerAtBillingAccount, + "ListByCustomerAtBillingAccount" +); +@@clientLocation(CustomerOperationGroup.listByCustomer, Products); + +@@clientLocation(Departments.listByDepartment, "BillingPermissions"); +@@clientLocation(Departments.checkAccessByDepartment, "BillingPermissions"); +@@clientName(Departments.checkAccessByDepartment::parameters.body, + "parameters" +); + +@@clientLocation(EnrollmentAccountOperationGroup.get, EnrollmentAccounts); +@@clientLocation(EnrollmentAccountOperationGroup.listByBillingAccount, + EnrollmentAccounts +); +@@clientLocation(EnrollmentAccountOperationGroup.listByEnrollmentAccount, + "BillingPermissions" +); +@@clientLocation(EnrollmentAccountOperationGroup.checkAccessByEnrollmentAccount, + "BillingPermissions" +); +@@clientName(EnrollmentAccountOperationGroup.checkAccessByEnrollmentAccount::parameters.body, + "parameters" +); +@@clientLocation(EnrollmentAccountOperationGroup.billingSubscriptionsListByEnrollmentAccount, + BillingSubscriptions +); +@@clientName(EnrollmentAccountOperationGroup.billingSubscriptionsListByEnrollmentAccount, + "ListByEnrollmentAccount" +); + +@@clientLocation(Invoices.listByInvoice, "Transactions"); +@@clientLocation(Invoices.transactionsDownloadByInvoice, "Transactions"); +@@clientLocation(Invoices.getTransactionSummaryByInvoice, "Transactions"); +@@clientLocation(InvoiceByBillingSubscription.getByBillingSubscription, + Invoices +); +@@clientLocation(InvoiceByBillingSubscription.listByBillingSubscription, + Invoices +); +@@clientLocation(InvoiceByBillingSubscription.downloadByBillingSubscription, + Invoices +); +@@clientLocation(InvoiceById.get, Invoices); + +@@clientName(InvoiceSections.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(InvoiceSections.listByInvoiceSection, "BillingPermissions"); +@@clientLocation(InvoiceSections.checkAccessByInvoiceSection, + "BillingPermissions" +); +@@clientName(InvoiceSections.checkAccessByInvoiceSection::parameters.body, + "parameters" +); +@@clientLocation(InvoiceSections.billingRequestsListByInvoiceSection, + BillingRequests +); +@@clientName(InvoiceSections.billingRequestsListByInvoiceSection, + "ListByInvoiceSection" +); +@@clientLocation(InvoiceSections.createByInvoiceSection, + BillingRoleAssignments +); +@@clientName(InvoiceSections.createByInvoiceSection::parameters.body, + "parameters" +); +@@clientLocation(InvoiceSections.resolveByInvoiceSection, + BillingRoleAssignments +); +@@clientLocation(InvoiceSections.billingSubscriptionsListByInvoiceSection, + BillingSubscriptions +); +@@clientName(InvoiceSections.billingSubscriptionsListByInvoiceSection, + "ListByInvoiceSection" +); +@@clientLocation(InvoiceSections.productsListByInvoiceSection, Products); +@@clientName(InvoiceSections.productsListByInvoiceSection, + "ListByInvoiceSection" +); +@@clientLocation(InvoiceSections.transactionsListByInvoiceSection, + "Transactions" +); +@@clientName(InvoiceSections.transactionsListByInvoiceSection, + "ListByInvoiceSection" +); + +@@clientLocation(PaymentMethodLinks.getByBillingProfile, PaymentMethods); +@@clientLocation(PaymentMethodLinks.listByBillingProfile, PaymentMethods); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(PaymentMethodLink.properties); + +@@clientLocation(PaymentMethodOperationGroup.getByUser, PaymentMethods); +@@clientLocation(PaymentMethodOperationGroup.deleteByUser, PaymentMethods); +@@clientLocation(PaymentMethodOperationGroup.listByUser, PaymentMethods); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(PaymentMethod.properties); + +@@clientLocation(CustomerPolicies.getByCustomer, Policies); +@@clientName(Policies.createOrUpdateByCustomerAtBillingAccount::parameters.resource, + "parameters" +); + +@@clientLocation(BillingProfilePolicies.getByBillingProfile, Policies); +@@clientLocation(BillingProfilePolicies.createOrUpdateByBillingProfile, + Policies +); +@@clientName(BillingProfilePolicies.createOrUpdateByBillingProfile::parameters.resource, + "parameters" +); + +@@clientLocation(BillingAccountPolicies.getByBillingAccount, Policies); +@@clientLocation(BillingAccountPolicies.createOrUpdateByBillingAccount, + Policies +); +@@clientName(BillingAccountPolicies.createOrUpdateByBillingAccount::parameters.resource, + "parameters" +); + +@@clientLocation(SubscriptionPolicies.getBySubscription, Policies); + +@@clientName(Products.update::parameters.properties, "parameters"); +@@clientName(Products.move::parameters.body, "parameters"); +@@clientName(Products.validateMoveEligibility::parameters.body, "parameters"); + +@@clientName(Reservations.updateByBillingAccount::parameters.properties, + "body" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(Reservation.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(ReservationOrder.properties); + +@@clientName(Transfers.initiate::parameters.resource, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(TransferDetails.properties); + +@@clientName(PartnerTransfers.initiate::parameters.resource, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(PartnerTransferDetails.properties); + +@@clientName(RecipientTransfers.accept::parameters.body, "parameters"); +@@clientName(RecipientTransfers.validate::parameters.body, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Legacy.flattenProperty(RecipientTransferDetails.properties); + +@@clientLocation(AddressOperationGroup.validate, "Address"); + +@@clientLocation(InvoicesOperationGroup.downloadDocumentsByBillingSubscription, + Invoices +); +@@clientName(InvoicesOperationGroup.downloadDocumentsByBillingSubscription::parameters.downloadUrls, + "parameters" +); + +@@clientName(AddressOperationGroup.validate::parameters.body, "parameters"); + +@@Azure.ResourceManager.identifiers(InvoiceSectionWithCreateSubPermissionListResult.value, + #["invoiceSectionId"] +); + +@@Azure.ResourceManager.identifiers(AgreementListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(AssociatedTenantListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(BillingAccountListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(BillingProfileListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(BillingRequestListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(BillingRoleAssignmentListResult.value, + #["id"] +); +@@Azure.ResourceManager.identifiers(BillingRoleDefinitionListResult.value, + #["id"] +); +@@Azure.ResourceManager.identifiers(BillingSubscriptionAliasListResult.value, + #["id"] +); +@@Azure.ResourceManager.identifiers(CustomerListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(DepartmentListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(EnrollmentAccountListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(InvoiceListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(InvoiceSectionListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(PaymentMethodLinksListResult.value, + #["id"] +); +@@Azure.ResourceManager.identifiers(PaymentMethodsListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(ProductListResult.value, #["id"]); +@@Azure.ResourceManager.identifiers(TransactionListResult.value, #["id"]); + +@@visibility(AgreementListResult.value, Lifecycle.Read); +@@visibility(AssociatedTenantListResult.value, Lifecycle.Read); +@@visibility(BillingProfileListResult.value, Lifecycle.Read); +@@visibility(BillingRequestListResult.value, Lifecycle.Read); +@@visibility(BillingRoleAssignmentListResult.value, Lifecycle.Read); +@@visibility(BillingRoleDefinitionListResult.value, Lifecycle.Read); +@@visibility(BillingSubscriptionAliasListResult.value, Lifecycle.Read); +@@visibility(CustomerListResult.value, Lifecycle.Read); +@@visibility(DepartmentListResult.value, Lifecycle.Read); +@@visibility(EnrollmentAccountListResult.value, Lifecycle.Read); +@@visibility(InvoiceListResult.value, Lifecycle.Read); +@@visibility(InvoiceSectionListResult.value, Lifecycle.Read); +@@visibility(PaymentMethodLinksListResult.value, Lifecycle.Read); +@@visibility(PaymentMethodsListResult.value, Lifecycle.Read); +@@visibility(ProductListResult.value, Lifecycle.Read); +@@visibility(TransactionListResult.value, Lifecycle.Read); +@@visibility(BillingAccountListResult.value, Lifecycle.Read); +@@visibility(BillingPermissionListResult.value, Lifecycle.Read); +@@visibility(InvoiceSectionWithCreateSubPermissionListResult.value, + Lifecycle.Read +); +@@visibility(PartnerTransferDetailsListResult.value, Lifecycle.Read); +@@visibility(RecipientTransferDetailsListResult.value, Lifecycle.Read); +@@visibility(TransferDetailsListResult.value, Lifecycle.Read); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/client.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/client.tsp new file mode 100644 index 000000000000..aa4e8e20e592 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/client.tsp @@ -0,0 +1,121 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.Billing; + +@@clientName(Microsoft.Billing, "BillingManagementClient", "javascript,python"); +@@clientName(BillingPlan.P1M, "P1_M", "python"); +@@clientName(SavingsPlanTerm.P1Y, "P1_Y", "python"); +@@clientName(SavingsPlanTerm.P3Y, "P3_Y", "python"); +@@clientName(SavingsPlanTerm.P5Y, "P5_Y", "python"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(AssociatedTenantsListByBillingAccountParameters.includeRevoked, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingAccountsListParameters.includeAll, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingAccountsListParameters.includeAllWithoutBillingProfiles, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingAccountsListParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingAccountsListParameters.includePendingAgreement, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingAccountsListParameters.includeResellee, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingPropertyGetParameters.includeBillingCountry, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingPropertyGetParameters.includeTransitionStatus, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingProfilesListByBillingAccountParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionAliasesListByBillingAccountParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingRoleAssignmentsResolveByBillingAccountParameters.resolveScopeDisplayNames, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingRoleAssignmentsResolveByBillingProfileParameters.resolveScopeDisplayNames, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingRoleAssignmentsResolveByInvoiceSectionParameters.resolveScopeDisplayNames, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingRoleAssignmentsResolveByCustomerParameters.resolveScopeDisplayNames, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionsListByBillingAccountParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionsListByBillingAccountParameters.includeTenantSubscriptions, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionsListByBillingAccountParameters.includeFailed, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionsListByBillingProfileParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionsListByCustomerParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionsListByCustomerAtBillingAccountParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(BillingSubscriptionsListByInvoiceSectionParameters.includeDeleted, + false, + "python" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy decorator required for Python SDK compatibility" +@@Azure.ClientGenerator.Core.Legacy.clientDefaultValue(InvoiceSectionsListByBillingProfileParameters.includeDeleted, + false, + "python" +); diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/addressValidateInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/addressValidateInvalid.json new file mode 100644 index 000000000000..e7ef278e6e94 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/addressValidateInvalid.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "addressLine1": "1 Test", + "city": "bellevue", + "country": "us", + "postalCode": "12345", + "region": "wa" + } + }, + "responses": { + "200": { + "body": { + "status": "Invalid", + "suggestedAddresses": [ + { + "addressLine1": "1 Test Address", + "city": "Bellevue", + "country": "US", + "postalCode": "98052", + "region": "WA" + }, + { + "addressLine1": "1 Test Address", + "city": "Bellevue", + "country": "US", + "postalCode": "12345-0000", + "region": "WA" + } + ], + "validationMessage": "Invalid address" + } + } + }, + "operationId": "Address_Validate", + "title": "AddressValidateInvalid" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/addressValidateValid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/addressValidateValid.json new file mode 100644 index 000000000000..da2e6693f5c7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/addressValidateValid.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "addressLine1": "1 Test", + "city": "bellevue", + "country": "us", + "postalCode": "12345", + "region": "wa" + } + }, + "responses": { + "200": { + "body": { + "status": "Valid" + } + } + }, + "operationId": "Address_Validate", + "title": "AddressValidateValid" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/agreementByName.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/agreementByName.json new file mode 100644 index 000000000000..634d089914ef --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/agreementByName.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "agreementName": "ABC123", + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "name": "ABC123", + "type": "Microsoft.Billing/billingAccounts/agreements", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", + "properties": { + "acceptanceMode": "ClickToAccept", + "agreementLink": "https://contoso.com", + "displayName": "Microsoft Customer Agreement", + "effectiveDate": "2018-11-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "status": "Active" + } + } + } + }, + "operationId": "Agreements_Get", + "title": "AgreementByName" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/agreementsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/agreementsListByBillingAccount.json new file mode 100644 index 000000000000..d2a13522af78 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/agreementsListByBillingAccount.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expand": "Participants" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ABC123", + "type": "Microsoft.Billing/billingAccounts/agreements", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", + "properties": { + "acceptanceMode": "ClickToAccept", + "agreementLink": "https://contoso.com", + "displayName": "Microsoft Customer Agreement", + "effectiveDate": "2018-11-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "participants": [ + { + "email": "abc@contoso.com", + "status": "Accepted", + "statusDate": "2018-11-01T00:00:00Z" + }, + { + "email": "xtz@contoso.com", + "status": "Declined", + "statusDate": "2018-11-02T00:00:00Z" + } + ], + "status": "Active" + } + }, + { + "name": "DEF456", + "type": "Microsoft.Billing/billingAccounts/agreements", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/DEF456", + "properties": { + "acceptanceMode": "ESignEmbedded", + "agreementLink": "https://contoso.com", + "displayName": "Microsoft Customer Agreement", + "effectiveDate": "2018-12-05T00:00:00Z", + "expirationDate": "2019-12-05T00:00:00Z", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "participants": [ + { + "email": "abc@contoso.com", + "status": "Pending", + "statusDate": "2018-12-05T00:00:00Z" + } + ], + "status": "PendingSignature" + } + } + ] + } + } + }, + "operationId": "Agreements_ListByBillingAccount", + "title": "AgreementsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsCreateOrUpdate.json new file mode 100644 index 000000000000..77355ee3d850 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsCreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "associatedTenantName": "11111111-1111-1111-1111-111111111111", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": { + "properties": { + "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningManagementState": "Pending" + } + } + }, + "responses": { + "200": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "properties": { + "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", + "provisioningManagementState": "Pending", + "tenantId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "201": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "properties": { + "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", + "provisioningManagementState": "Pending", + "tenantId": "11111111-1111-1111-1111-111111111111" + } + } + } + }, + "operationId": "AssociatedTenants_CreateOrUpdate", + "title": "AssociatedTenantsCreateOrUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsDelete.json new file mode 100644 index 000000000000..0caf8059815d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "associatedTenantName": "11111111-1111-1111-1111-111111111111", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/deleteAssociatedTenant_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + }, + "204": {} + }, + "operationId": "AssociatedTenants_Delete", + "title": "AssociatedTenantsDelete" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsGet.json new file mode 100644 index 000000000000..eec3701a77cc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "associatedTenantName": "11111111-1111-1111-1111-111111111111", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "properties": { + "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", + "provisioningManagementState": "Pending", + "tenantId": "11111111-1111-1111-1111-111111111111" + } + } + } + }, + "operationId": "AssociatedTenants_Get", + "title": "AssociatedTenantsGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsListByBillingAccount.json new file mode 100644 index 000000000000..d94046378673 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/associatedTenantsListByBillingAccount.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "properties": { + "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningManagementState": "NotRequested", + "tenantId": "11111111-1111-1111-1111-111111111111" + } + }, + { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/22222222-2222-2222-2222-222222222222", + "properties": { + "billingManagementState": "NotAllowed", + "displayName": "Contoso Engineering", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", + "provisioningManagementState": "Pending", + "tenantId": "22222222-2222-2222-2222-222222222222" + } + } + ] + } + } + }, + "operationId": "AssociatedTenants_ListByBillingAccount", + "title": "AssociatedTenantsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/availableBalanceGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/availableBalanceGetByBillingAccount.json new file mode 100644 index 000000000000..f16d10d918d5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/availableBalanceGetByBillingAccount.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/availableBalance", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/availableBalance/default", + "properties": { + "amount": { + "currency": "USD", + "value": 500 + }, + "paymentsOnAccount": [ + { + "amount": { + "currency": "USD", + "value": 50 + }, + "billingProfileDisplayName": "Contoso Finance", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "date": "2024-04-01T00:00:00.0000000Z", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceName": "G123456789", + "paymentMethodType": "CheckWire" + }, + { + "amount": { + "currency": "USD", + "value": 150 + }, + "billingProfileDisplayName": "Contoso Engineering", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", + "date": "2023-01-01T00:00:00.0000000Z", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", + "invoiceName": "G987654321", + "paymentMethodType": "CheckWire" + } + ], + "totalPaymentsOnAccount": { + "currency": "USD", + "value": 200 + } + } + } + } + }, + "operationId": "AvailableBalances_GetByBillingAccount", + "title": "AvailableBalanceGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/availableBalanceGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/availableBalanceGetByBillingProfile.json new file mode 100644 index 000000000000..04227bbcc084 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/availableBalanceGetByBillingProfile.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/availableBalance/default", + "properties": { + "amount": { + "currency": "USD", + "value": 500 + }, + "paymentsOnAccount": [ + { + "amount": { + "currency": "USD", + "value": 50 + }, + "billingProfileDisplayName": "Contoso Finance", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "date": "2024-04-01T00:00:00.0000000Z", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceName": "G123456789", + "paymentMethodType": "CheckWire" + } + ], + "totalPaymentsOnAccount": { + "currency": "USD", + "value": 200 + } + } + } + } + }, + "operationId": "AvailableBalances_GetByBillingProfile", + "title": "AvailableBalanceGetByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountForLegacyAccountDetails.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountForLegacyAccountDetails.json new file mode 100644 index 000000000000..363eda9fa090 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountForLegacyAccountDetails.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "20000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001", + "properties": { + "accountStatus": "Active", + "accountType": "Individual", + "agreementType": "MicrosoftOnlineServicesProgram", + "displayName": "Individual Account 2", + "hasReadAccess": true, + "notificationEmailAddress": "individual@domain.com" + } + } + ] + } + } + }, + "operationId": "BillingAccounts_List", + "title": "BillingAccountForLegacyAccountDetails" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountUpdateWithPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountUpdateWithPONumber.json new file mode 100644 index 000000000000..abed245a968b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountUpdateWithPONumber.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6575495", + "parameters": { + "properties": { + "enrollmentDetails": { + "poNumber": "poNumber123" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "6575495", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6575495", + "properties": { + "accountStatus": "Active", + "accountSubType": "None", + "accountType": "Enterprise", + "agreementType": "EnterpriseAgreement", + "displayName": "Enterprise Account", + "enrollmentDetails": { + "billingCycle": "Monthly", + "channel": "EaDirect", + "cloud": "Azure Commercial", + "countryCode": "US", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", + "extendedTermOption": "Opted-Out", + "poNumber": "poNumber123", + "startDate": "2018-05-01T17:32:28Z", + "supportCoverage": "1/26/2021 - 6/30/2021", + "supportLevel": "Standard", + "language": "en" + }, + "hasReadAccess": true, + "soldTo": { + "addressLine1": "Test Address", + "addressLine2": "Test Address", + "addressLine3": "Test Address", + "city": "City", + "country": "US", + "postalCode": "00000", + "region": "WA" + } + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/6575495/operationStatus/65e1f2bf-c31c-4b89-a599-25d9d4172af9?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingAccounts_Update", + "title": "BillingAccountUpdateWithPONumber" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithExpandForPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithExpandForPONumber.json new file mode 100644 index 000000000000..6829bae6d8bc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithExpandForPONumber.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "8608480", + "expand": "enrollmentDetails/poNumber" + }, + "responses": { + "200": { + "body": { + "name": "6564892", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892", + "properties": { + "accountStatus": "Active", + "accountType": "Enterprise", + "agreementType": "EnterpriseAgreement", + "displayName": "Enterprise Account", + "enrollmentDetails": { + "billingCycle": "Monthly", + "channel": "EaDirect", + "cloud": "Azure Commercial", + "countryCode": "US", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", + "extendedTermOption": "Opted-Out", + "poNumber": "poNumber123", + "startDate": "2018-05-01T17:32:28Z", + "supportCoverage": "1/26/2021 - 6/30/2021", + "supportLevel": "Standard", + "language": "en" + }, + "hasReadAccess": true + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountWithExpandForPONumber" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithRegistrationNumberWithDefaultType.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithRegistrationNumberWithDefaultType.json new file mode 100644 index 000000000000..679d8ceb4963 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithRegistrationNumberWithDefaultType.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "registrationNumber": { + "type": [ + "RegistrationNumber" + ], + "id": "RegistrationId" + } + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountWithRegistrationNumberWithDefaultType" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithRegistrationNumberWithType.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithRegistrationNumberWithType.json new file mode 100644 index 000000000000..c8c7440b53ac --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountWithRegistrationNumberWithType.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "registrationNumber": { + "type": [ + "TIN" + ], + "id": "SomeRegistrationId", + "required": true + } + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountWithRegistrationNumberWithType" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsConfirmTransition.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsConfirmTransition.json new file mode 100644 index 000000000000..589193cbed76 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsConfirmTransition.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "anniversaryDay": 12, + "transitionDate": "2021-05-17T00:00:00Z" + } + } + }, + "operationId": "BillingAccounts_ConfirmTransition", + "title": "BillingAccountsConfirmTransition" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGet.json new file mode 100644 index 000000000000..44ae0a07a639 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountsGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGetEA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGetEA.json new file mode 100644 index 000000000000..0053a120b15d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGetEA.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6575495" + }, + "responses": { + "200": { + "body": { + "name": "6575495", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6575495", + "properties": { + "agreementType": "EnterpriseAgreement", + "enrollmentDetails": { + "billingCycle": "Monthly", + "channel": "EaDirect", + "cloud": "Azure Commercial", + "countryCode": "US", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", + "extendedTermOption": "Opted-Out", + "indirectRelationshipInfo": { + "billingAccountName": "pcn.12345", + "billingProfileName": "", + "displayName": "Test partner" + }, + "invoiceRecipient": "abc@contoso.com", + "markupStatus": "Published", + "startDate": "2018-05-01T17:32:28Z", + "supportCoverage": "1/26/2021 - 6/30/2021", + "supportLevel": "Standard", + "language": "en" + }, + "soldTo": { + "addressLine1": "Test Address", + "addressLine2": "Test Address", + "addressLine3": "Test Address", + "city": "City", + "country": "US", + "postalCode": "00000", + "region": "WA" + } + } + } + } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountsGetEA" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGetWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGetWithExpand.json new file mode 100644 index 000000000000..c3f02eb9ce12 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsGetWithExpand.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expand": "SoldTo" + }, + "responses": { + "200": { + "body": { + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "soldTo": { + "addressLine1": "1 Microsoft Way", + "city": "Redmond", + "companyName": "Contoso", + "country": "US", + "isValidAddress": true, + "postalCode": "98052-8300", + "region": "WA" + } + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountsGetWithExpand" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsList.json new file mode 100644 index 000000000000..5c557c38a296 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsList.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "name": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Professional", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Standard Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "name": "30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Individual", + "accountType": "Individual", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Individual Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "name": "40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftPartnerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + ] + } + } + }, + "operationId": "BillingAccounts_List", + "title": "BillingAccountsList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsListWithExpandForPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsListWithExpandForPONumber.json new file mode 100644 index 000000000000..7b8418240286 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsListWithExpandForPONumber.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "expand": "soldTo,enrollmentDetails/poNumber" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6564892", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892", + "properties": { + "accountStatus": "Active", + "accountSubType": "None", + "accountType": "Enterprise", + "agreementType": "EnterpriseAgreement", + "displayName": "Enterprise Account", + "enrollmentDetails": { + "billingCycle": "Monthly", + "channel": "EaDirect", + "cloud": "Azure Commercial", + "countryCode": "US", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", + "extendedTermOption": "Opted-Out", + "poNumber": "poNumber123", + "startDate": "2018-05-01T17:32:28Z", + "supportCoverage": "1/26/2021 - 6/30/2021", + "supportLevel": "Standard", + "language": "en" + }, + "hasReadAccess": true, + "soldTo": { + "addressLine1": "Test Address", + "city": "City", + "companyName": "Enterprise Company", + "country": "US", + "postalCode": "00000-1111", + "region": "WA" + } + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + ] + } + } + }, + "operationId": "BillingAccounts_List", + "title": "BillingAccountsListWithExpandForPONumber" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsUpdate.json new file mode 100644 index 000000000000..3b11aaee462c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingAccountsUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": { + "properties": { + "displayName": "Test Account", + "soldTo": { + "addressLine1": "1 Microsoft Way", + "city": "Redmond", + "companyName": "Contoso", + "country": "US", + "postalCode": "98052-8300", + "region": "WA" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "soldTo": { + "addressLine1": "1 Microsoft Way", + "city": "Redmond", + "companyName": "Contoso", + "country": "US", + "isValidAddress": true, + "postalCode": "98052-8300", + "region": "WA" + } + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/patchBillingAccount_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingAccounts_Update", + "title": "BillingAccountsUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByBillingAccount.json new file mode 100644 index 000000000000..5c69c6e6bfaa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByBillingAccount.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000009", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "20000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + }, + "operationId": "BillingPermissions_ListByBillingAccount", + "title": "BillingPermissionsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByBillingProfile.json new file mode 100644 index 000000000000..d7c745a68c36 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByBillingProfile.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000009", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "20000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + }, + "operationId": "BillingPermissions_ListByBillingProfile", + "title": "BillingPermissionsListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByCustomer.json new file mode 100644 index 000000000000..368bd46ba4b1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByCustomer.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + }, + "operationId": "BillingPermissions_ListByCustomer", + "title": "BillingPermissionsListByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..e390590b522f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByCustomerAtBillingAccount.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + }, + "operationId": "BillingPermissions_ListByCustomerAtBillingAccount", + "title": "BillingPermissionsListByCustomerAtBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByDepartment.json new file mode 100644 index 000000000000..7e42ef99ef37 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByDepartment.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6100092", + "departmentName": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ], + "notActions": [] + } + ] + } + } + }, + "operationId": "BillingPermissions_ListByDepartment", + "title": "BillingPermissionsListByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByEnrollmentAccount.json new file mode 100644 index 000000000000..dd0dfb70b39f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByEnrollmentAccount.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6100092", + "enrollmentAccountName": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ], + "notActions": [] + } + ] + } + } + }, + "operationId": "BillingPermissions_ListByEnrollmentAccount", + "title": "BillingPermissionsListByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByInvoiceSection.json new file mode 100644 index 000000000000..128ccccc415a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPermissionsListByInvoiceSection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "XXXX-XXXX-XXX-XXX" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + }, + "operationId": "BillingPermissions_ListByInvoiceSection", + "title": "BillingPermissionsListByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesCreateOrUpdate.json new file mode 100644 index 000000000000..14075970fb83 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesCreateOrUpdate.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "displayName": "Billing Profile 1", + "enabledAzurePlans": [ + { + "skuId": "0001" + }, + { + "skuId": "0002" + } + ], + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "status": "Active", + "systemId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "201": { + "body": { + "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "status": "Active", + "systemId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/putBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingProfiles_CreateOrUpdate", + "title": "BillingProfilesCreateOrUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesDelete.json new file mode 100644 index 000000000000..a2657ce2cd09 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesDelete.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "displayName": "Billing Profile 1", + "enabledAzurePlans": [ + { + "skuId": "0001" + }, + { + "skuId": "0002" + } + ], + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/deleteBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + }, + "204": {} + }, + "operationId": "BillingProfiles_Delete", + "title": "BillingProfilesDelete" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesGet.json new file mode 100644 index 000000000000..7f7191630eec --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesGet.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "spendingLimit": "On", + "spendingLimitDetails": [ + { + "type": "FreeAccount", + "amount": 200, + "currency": "USD", + "endDate": "2019-01-01T00:00:00.0000000Z", + "startDate": "2018-01-01T00:00:00.0000000Z", + "status": "Active" + } + ], + "status": "Warned", + "statusReasonCode": "PastDue", + "systemId": "11111111-1111-1111-1111-111111111111" + } + } + } + }, + "operationId": "BillingProfiles_Get", + "title": "BillingProfilesGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesListByBillingAccount.json new file mode 100644 index 000000000000..9bcd40e1d098 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesListByBillingAccount.json @@ -0,0 +1,221 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "spendingLimit": "On", + "spendingLimitDetails": [ + { + "type": "FreeAccount", + "amount": 200, + "currency": "USD", + "endDate": "2019-01-01T00:00:00.0000000Z", + "startDate": "2018-01-01T00:00:00.0000000Z", + "status": "Active" + } + ], + "status": "Warned", + "statusReasonCode": "PastDue", + "systemId": "11111111-1111-1111-1111-111111111111" + } + }, + { + "name": "yyyy-yyyy-yyy-yyy", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "currency": "USD", + "displayName": "Billing Profile 2", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "status": "UnderReview", + "statusReasonCode": "UnusualActivity", + "systemId": "22222222-2222-2222-2222-222222222222" + } + }, + { + "name": "zzzz-zzzz-zzz-zzz", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/zzzz-zzzz-zzz-zzz", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "isValidAddress": true, + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA" + }, + "status": "Active", + "systemId": "33333333-3333-3333-3333-333333333333" + } + } + ] + } + } + }, + "operationId": "BillingProfiles_ListByBillingAccount", + "title": "BillingProfilesListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesValidateDeleteEligibilityFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesValidateDeleteEligibilityFailure.json new file mode 100644 index 000000000000..b9658bba3b6e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesValidateDeleteEligibilityFailure.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "eligibilityDetails": [ + { + "code": "ActiveBillingSubscriptions", + "message": "There are active or disabled subscriptions assigned to the invoice section. Either move the subscription to another invoice section or delete the subscriptions and then try deleting the invoice section." + }, + { + "code": "LastBillingProfile", + "message": "Billing profile cannot be deleted as this is the only billing profile in this billing account." + }, + { + "code": "OutstandingCharges", + "message": "Billing Profile cannot be deleted as there are outstanding charges on this billing profile." + }, + { + "code": "PendingCharges", + "message": "Billing Profile cannot be deleted as there are pending charges accumulating on this billing profile." + }, + { + "code": "ReservedInstances", + "message": "Billing Profile cannot be deleted as there are reserved assets with a billing plan." + } + ], + "eligibilityStatus": "NotAllowed" + } + } + }, + "operationId": "BillingProfiles_ValidateDeleteEligibility", + "title": "BillingProfilesValidateDeleteEligibilityFailure" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesValidateDeleteEligibilitySuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesValidateDeleteEligibilitySuccess.json new file mode 100644 index 000000000000..fd2b2248fc72 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingProfilesValidateDeleteEligibilitySuccess.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": {} + } + }, + "operationId": "BillingProfiles_ValidateDeleteEligibility", + "title": "BillingProfilesValidateDeleteEligibilitySuccess" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMCA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMCA.json new file mode 100644 index 000000000000..c54d888cd8ec --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMCA.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "properties": { + "billingAccountAgreementType": "MicrosoftCustomerAgreement", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Business", + "billingProfileDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSpendingLimit": "Off", + "billingProfileStatus": "Active", + "costCenter": "1010", + "invoiceSectionDisplayName": "Operations", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "subscriptionBillingStatus": "Active", + "subscriptionBillingStatusDetails": [ + { + "effectiveDate": "2023-01-01T17:32:28Z", + "reason": "Cancelled" + } + ], + "subscriptionBillingType": "Free", + "subscriptionWorkloadType": "Production" + } + } + } + }, + "operationId": "BillingProperty_Get", + "title": "BillingPropertyGetMCA" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMOSP.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMOSP.json new file mode 100644 index 000000000000..ba4bfd540a54 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMOSP.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "properties": { + "billingAccountAgreementType": "MicrosoftOnlineServicesProgram", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Individual", + "subscriptionBillingType": "Free", + "subscriptionServiceUsageAddress": { + "addressLine1": "Address line 1", + "addressLine2": "Address line 2", + "city": "City", + "country": "US", + "firstName": "Jenny", + "lastName": "Doe", + "middleName": "Ann", + "postalCode": "12345", + "region": "State" + }, + "subscriptionWorkloadType": "Production" + } + } + } + }, + "operationId": "BillingProperty_Get", + "title": "BillingPropertyGetMOSP" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMPA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMPA.json new file mode 100644 index 000000000000..211fb2f6b054 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyGetMPA.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "properties": { + "billingAccountAgreementType": "MicrosoftCustomerAgreement", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Business", + "billingProfileDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSpendingLimit": "Off", + "billingProfileStatus": "Active", + "costCenter": "1010", + "customerDisplayName": "Operations", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx/customers/yyyy-yyyy-yyy-yyy", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "subscriptionBillingStatus": "Active", + "subscriptionBillingStatusDetails": [ + { + "effectiveDate": "2023-01-01T17:32:28Z", + "reason": "Cancelled" + } + ], + "subscriptionBillingType": "Free", + "subscriptionWorkloadType": "Production" + } + } + } + }, + "operationId": "BillingProperty_Get", + "title": "BillingPropertyGetMPA" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyPatchCostCenter.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyPatchCostCenter.json new file mode 100644 index 000000000000..9a2e6633691f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyPatchCostCenter.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "properties": { + "costCenter": "1010" + } + }, + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "properties": { + "billingAccountAgreementType": "MicrosoftCustomerAgreement", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Business", + "billingProfileDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSpendingLimit": "Off", + "billingProfileStatus": "Active", + "costCenter": "1010", + "invoiceSectionDisplayName": "Operations", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "subscriptionBillingStatus": "Active", + "subscriptionBillingStatusDetails": [ + { + "effectiveDate": "2023-01-01T17:32:28Z", + "reason": "Cancelled" + } + ], + "subscriptionBillingType": "Free", + "subscriptionWorkloadType": "Production" + } + } + } + }, + "operationId": "BillingProperty_Update", + "title": "BillingPropertyPatchCostCenter" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyPatchSubscriptionServiceUsageAddress.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyPatchSubscriptionServiceUsageAddress.json new file mode 100644 index 000000000000..5453ef57bddc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingPropertyPatchSubscriptionServiceUsageAddress.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "properties": { + "subscriptionServiceUsageAddress": { + "addressLine1": "Address line 1", + "addressLine2": "Address line 2", + "city": "City", + "country": "US", + "firstName": "Jenny", + "lastName": "Doe", + "middleName": "Ann", + "postalCode": "12345", + "region": "State" + } + } + }, + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "properties": { + "billingAccountAgreementType": "MicrosoftOnlineServicesProgram", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Individual", + "subscriptionBillingType": "Free", + "subscriptionServiceUsageAddress": { + "addressLine1": "Address line 1", + "addressLine2": "Address line 2", + "city": "City", + "country": "US", + "firstName": "Jenny", + "lastName": "Doe", + "middleName": "Ann", + "postalCode": "12345", + "region": "State" + }, + "subscriptionWorkloadType": "Production" + } + } + } + }, + "operationId": "BillingProperty_Update", + "title": "BillingPropertyPatchSubscriptionServiceUsageAddress" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsCreateOrUpdate.json new file mode 100644 index 000000000000..d59eb799f4ba --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsCreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingRequestName": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "decisionReason": "New team member", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } + } + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "admin@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } + } + }, + "201": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "admin@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } + } + } + }, + "operationId": "BillingRequests_CreateOrUpdate", + "title": "BillingRequestsCreateOrUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsGet.json new file mode 100644 index 000000000000..fc638c688267 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingRequestName": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "admin@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } + } + } + }, + "operationId": "BillingRequests_Get", + "title": "BillingRequestsGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByBillingAccount.json new file mode 100644 index 000000000000..785da9e08144 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByBillingAccount.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } + }, + { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", + "properties": { + "type": "ProvisioningAccess", + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2023-03-01T17:32:28Z", + "expirationDate": "2023-03-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "admin@contosofinance.com" + }, + "lastUpdatedDate": "2023-03-02T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "reviewalDate": "2023-03-02T17:32:28Z", + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "status": "Approved" + } + } + ] + } + } + }, + "operationId": "BillingRequests_ListByBillingAccount", + "title": "BillingRequestsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByBillingProfile.json new file mode 100644 index 000000000000..7414713f063b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByBillingProfile.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } + } + ] + } + } + }, + "operationId": "BillingRequests_ListByBillingProfile", + "title": "BillingRequestsListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByCustomer.json new file mode 100644 index 000000000000..e5f63dcd6f13 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByCustomer.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "30000000-aaaa-bbbb-cccc-200000000003" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "customerDisplayName": "Customer 1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "customerName": "11111111-1111-1111-1111-111111111111", + "expirationDate": "2023-04-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "status": "Pending" + } + } + ] + } + } + }, + "operationId": "BillingRequests_ListByCustomer", + "title": "BillingRequestsListByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByInvoiceSection.json new file mode 100644 index 000000000000..7d224505bdd9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByInvoiceSection.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "30000000-aaaa-bbbb-cccc-200000000003" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "invoiceSectionDisplayName": "Department 1", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "status": "Pending" + } + } + ] + } + } + }, + "operationId": "BillingRequests_ListByInvoiceSection", + "title": "BillingRequestsListByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByUser.json new file mode 100644 index 000000000000..acbd021f540c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByUser.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "properties": { + "type": "RoleAssignment", + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } + }, + { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", + "properties": { + "type": "ProvisioningAccess", + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2023-03-01T17:32:28Z", + "expirationDate": "2023-03-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "admin@contosofinance.com" + }, + "lastUpdatedDate": "2023-03-02T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "reviewalDate": "2023-03-02T17:32:28Z", + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "status": "Approved" + } + } + ] + } + } + }, + "operationId": "BillingRequests_ListByUser", + "title": "BillingRequestsListByUser" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByUserWithFilter.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByUserWithFilter.json new file mode 100644 index 000000000000..da2f67cf1c14 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRequestsListByUserWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "filter": "properties/status eq 'Approved'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", + "properties": { + "type": "ProvisioningAccess", + "billingAccountDisplayName": "Contoso", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2023-03-01T17:32:28Z", + "expirationDate": "2023-03-15T17:32:28Z", + "lastUpdatedBy": { + "upn": "admin@contosofinance.com" + }, + "lastUpdatedDate": "2023-03-02T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "reviewalDate": "2023-03-02T17:32:28Z", + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "status": "Approved" + } + } + ] + } + } + }, + "operationId": "BillingRequests_ListByUser", + "title": "BillingRequestsListByUserWithFilter" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByBillingAccount.json new file mode 100644 index 000000000000..12e95b00e115 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByBillingAccount.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/createBillingRoleAssignment_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_CreateByBillingAccount", + "title": "BillingRoleAssignmentCreateByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByBillingProfile.json new file mode 100644 index 000000000000..e272e274e136 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByBillingProfile.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/operationResults/createBillingRoleAssignment_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_CreateByBillingProfile", + "title": "BillingRoleAssignmentCreateByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByCustomer.json new file mode 100644 index 000000000000..a4ae6ef9bfc7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByCustomer.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "name": "30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/customers/703ab484-dda2-4402-827b-a74513b61e2d/operationResults/createBillingRoleAssignment_30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_CreateByCustomer", + "title": "BillingRoleAssignmentCreateByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByInvoiceSection.json new file mode 100644 index 000000000000..245068fbdf6d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateByInvoiceSection.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/xxxx-xxxx-xxx-xxx/operationResults/createBillingRoleAssignment_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_CreateByInvoiceSection", + "title": "BillingRoleAssignmentCreateByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByBillingAccount.json new file mode 100644 index 000000000000..30f2e0c68858 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByBillingAccount.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "parameters": { + "properties": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "userEmailAddress": "john@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901" + } + } + }, + "201": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901" + } + } + } + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByBillingAccount", + "title": "BillingRoleAssignmentCreateOrUpdateByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByDepartment.json new file mode 100644 index 000000000000..f24547311692 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByDepartment.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "departmentName": "12345", + "parameters": { + "properties": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "userEmailAddress": "john@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345" + } + } + }, + "201": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345" + } + } + } + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByDepartment", + "title": "BillingRoleAssignmentCreateOrUpdateByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json new file mode 100644 index 000000000000..e47226615718 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "enrollmentAccountName": "123456", + "parameters": { + "properties": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "userEmailAddress": "john@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456" + } + } + }, + "201": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456" + } + } + } + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount", + "title": "BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByBillingAccount.json new file mode 100644 index 000000000000..de655b738660 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByBillingAccount.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "BillingRoleAssignments_DeleteByBillingAccount", + "title": "BillingRoleAssignmentDeleteByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByBillingProfile.json new file mode 100644 index 000000000000..9b141013c74b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByBillingProfile.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "BillingRoleAssignments_DeleteByBillingProfile", + "title": "BillingRoleAssignmentDeleteByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByCustomer.json new file mode 100644 index 000000000000..626bc9d5db00 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByCustomer.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "BillingRoleAssignments_DeleteByCustomer", + "title": "BillingRoleAssignmentDeleteByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByDepartment.json new file mode 100644 index 000000000000..b771d19580ca --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByDepartment.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "8608480", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "departmentName": "123456" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "BillingRoleAssignments_DeleteByDepartment", + "title": "BillingRoleAssignmentDeleteByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByEnrollmentAccount.json new file mode 100644 index 000000000000..e256ae84433e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByEnrollmentAccount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "8608480", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "enrollmentAccountName": "123456" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "BillingRoleAssignments_DeleteByEnrollmentAccount", + "title": "BillingRoleAssignmentDeleteByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByInvoiceSection.json new file mode 100644 index 000000000000..709412c42cb7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentDeleteByInvoiceSection.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", + "title": "BillingRoleAssignmentDeleteByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByBillingAccount.json new file mode 100644 index 000000000000..5560de0ec3fa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByBillingAccount.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": { + "body": { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-01-04T22:39:34.2606750Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } + } + } + }, + "operationId": "BillingRoleAssignments_GetByBillingAccount", + "title": "BillingRoleAssignmentGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByBillingProfile.json new file mode 100644 index 000000000000..8b14b12303fa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByBillingProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": { + "body": { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-01-04T22:39:34.2606750Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } + } + } + }, + "operationId": "BillingRoleAssignments_GetByBillingProfile", + "title": "BillingRoleAssignmentGetByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByCustomer.json new file mode 100644 index 000000000000..dcd3ab45b48a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByCustomer.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" + }, + "responses": { + "200": { + "body": { + "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-01-04T22:39:34.2606750Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } + } + } + }, + "operationId": "BillingRoleAssignments_GetByCustomer", + "title": "BillingRoleAssignmentGetByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByDepartment.json new file mode 100644 index 000000000000..30f05c09d9cd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByDepartment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "departmentName": "225314" + }, + "responses": { + "200": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314", + "userAuthenticationType": "Organization", + "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" + } + } + } + }, + "operationId": "BillingRoleAssignments_GetByDepartment", + "title": "BillingRoleAssignmentGetByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByEnrollmentAccount.json new file mode 100644 index 000000000000..15a43992978a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByEnrollmentAccount.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "enrollmentAccountName": "225314" + }, + "responses": { + "200": { + "body": { + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314", + "userAuthenticationType": "Organization", + "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" + } + } + } + }, + "operationId": "BillingRoleAssignments_GetByEnrollmentAccount", + "title": "BillingRoleAssignmentGetByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByInvoiceSection.json new file mode 100644 index 000000000000..d15ccb8bd3a3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentGetByInvoiceSection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } + } + } + }, + "operationId": "BillingRoleAssignments_GetByInvoiceSection", + "title": "BillingRoleAssignmentGetByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByBillingAccount.json new file mode 100644 index 000000000000..765dc0a1dfd3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByBillingAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } + } + ] + } + } + }, + "operationId": "BillingRoleAssignments_ListByBillingAccount", + "title": "BillingRoleAssignmentListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByBillingProfile.json new file mode 100644 index 000000000000..746e1c108f10 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByBillingProfile.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } + } + ] + } + } + }, + "operationId": "BillingRoleAssignments_ListByBillingProfile", + "title": "BillingRoleAssignmentListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByCustomer.json new file mode 100644 index 000000000000..a3be8a6d7b07 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByCustomer.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } + }, + { + "name": "30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } + } + ] + } + } + }, + "operationId": "BillingRoleAssignments_ListByCustomer", + "title": "BillingRoleAssignmentListByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByDepartment.json new file mode 100644 index 000000000000..2368d97efc54 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByDepartment.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "departmentName": "12345" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "\"/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345" + } + } + ] + } + } + }, + "operationId": "BillingRoleAssignments_ListByDepartment", + "title": "BillingRoleAssignmentListByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByEnrollmentAccount.json new file mode 100644 index 000000000000..d8e8dab6dd2d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByEnrollmentAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6100092", + "enrollmentAccountName": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456" + } + } + ] + } + } + }, + "operationId": "BillingRoleAssignments_ListByEnrollmentAccount", + "title": "BillingRoleAssignmentListByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByInvoiceSection.json new file mode 100644 index 000000000000..340645fd67f0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleAssignmentListByInvoiceSection.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } + } + ] + } + } + }, + "operationId": "BillingRoleAssignments_ListByInvoiceSection", + "title": "BillingRoleAssignmentListByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByBillingAccount.json new file mode 100644 index 000000000000..6578abeabf51 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByBillingAccount.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "roleDefinitionName": "50000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000000", + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000002", + "50000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000004", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018", + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000016" + ] + } + ], + "roleName": "Billing account owner" + } + } + } + }, + "operationId": "BillingRoleDefinition_GetByBillingAccount", + "title": "BillingRoleDefinitionGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByBillingProfile.json new file mode 100644 index 000000000000..d3d1cbf773c7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByBillingProfile.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "roleDefinitionName": "40000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "name": "40000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Billing profile owner" + } + } + } + }, + "operationId": "BillingRoleDefinition_GetByBillingProfile", + "title": "BillingRoleDefinitionGetByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByCustomer.json new file mode 100644 index 000000000000..71baf0c57416 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByCustomer.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "roleDefinitionName": "30000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ], + "notActions": [] + } + ], + "roleName": "Customer owner" + } + } + } + }, + "operationId": "BillingRoleDefinition_GetByCustomer", + "title": "BillingRoleDefinitionGetByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByDepartment.json new file mode 100644 index 000000000000..6f2ac4d06fef --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByDepartment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "departmentName": "7368531", + "roleDefinitionName": "50000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/departments/action", + "Microsoft.Billing/billingAccounts/departments/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete" + ] + } + ], + "roleName": "Department Admin" + } + } + } + }, + "operationId": "BillingRoleDefinition_GetByDepartment", + "title": "BillingRoleDefinitionGetByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByEnrollmentAccount.json new file mode 100644 index 000000000000..05c5fbe0b334 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByEnrollmentAccount.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "enrollmentAccountName": "4568789", + "roleDefinitionName": "50000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action" + ] + } + ], + "roleName": "Account Owner" + } + } + } + }, + "operationId": "BillingRoleDefinition_GetByEnrollmentAccount", + "title": "BillingRoleDefinitionGetByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByInvoiceSection.json new file mode 100644 index 000000000000..bcc4adc28448 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionGetByInvoiceSection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "roleDefinitionName": "30000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ] + } + ], + "roleName": "Invoice section owner" + } + } + } + }, + "operationId": "BillingRoleDefinition_GetByInvoiceSection", + "title": "BillingRoleDefinitionGetByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByBillingAccount.json new file mode 100644 index 000000000000..c52232927b50 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByBillingAccount.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000000", + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000002", + "50000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000004", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018", + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000016" + ] + } + ], + "roleName": "Billing account owner" + } + }, + { + "name": "50000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management on the organization.", + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000002", + "50000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000004", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000016" + ] + } + ], + "roleName": "Billing account contributor" + } + }, + { + "name": "50000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The Reader role gives the user read permissions to an organization.", + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "10000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012" + ] + } + ], + "roleName": "Billing account reader" + } + }, + { + "name": "50000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The Reader role gives the user read permissions to an organization.", + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "10000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012" + ] + } + ], + "roleName": "Billing account reader" + } + }, + { + "name": "50000000-aaaa-bbbb-cccc-100000000003", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000003", + "properties": { + "description": "The Purchaser role gives the user permissions to make purchases by creating new Projects and Billing Groups in an organization.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000006" + ] + } + ], + "roleName": "Basic Purchaser" + } + } + ] + } + } + }, + "operationId": "BillingRoleDefinition_ListByBillingAccount", + "title": "BillingRoleDefinitionListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByBillingProfile.json new file mode 100644 index 000000000000..0e4403179310 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByBillingProfile.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "40000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Billing profile owner" + } + }, + { + "name": "40000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Billing profile contributor" + } + }, + { + "name": "40000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The Reader role gives the user read only access to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012" + ] + } + ], + "roleName": "Billing profile reader" + } + }, + { + "name": "40000000-aaaa-bbbb-cccc-100000000004", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000004", + "properties": { + "description": "The Invoice Manager role gives the user the ability to view and manage invoices.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Invoice manager" + } + } + ] + } + } + }, + "operationId": "BillingRoleDefinition_ListByBillingProfile", + "title": "BillingRoleDefinitionListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByCustomer.json new file mode 100644 index 000000000000..fa11c8b1bcbf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByCustomer.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ], + "notActions": [] + } + ], + "roleName": "Customer owner" + } + }, + { + "name": "30000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management rights to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ], + "notActions": [] + } + ], + "roleName": "Customer contributor" + } + }, + { + "name": "30000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The reader role gives the user read only access to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017" + ], + "notActions": [] + } + ], + "roleName": "Customer reader" + } + } + ] + } + } + }, + "operationId": "BillingRoleDefinition_ListByCustomer", + "title": "BillingRoleDefinitionListByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByDepartment.json new file mode 100644 index 000000000000..a3f184742bc2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByDepartment.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "departmentName": "7368531" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/departments/action", + "Microsoft.Billing/billingAccounts/departments/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read" + ] + } + ], + "roleName": "Department Admin" + } + }, + { + "name": "50000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read" + ] + } + ], + "roleName": "Department Reader" + } + } + ] + } + } + }, + "operationId": "BillingRoleDefinition_ListByDepartment", + "title": "BillingRoleDefinitionListByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByEnrollmentAccount.json new file mode 100644 index 000000000000..a7ee816a6ed5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByEnrollmentAccount.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "enrollmentAccountName": "4568789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The account owner role gives the user all permissions including access management rights to an accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action" + ], + "notActions": [] + } + ], + "roleName": "Account Owner" + } + } + ] + } + } + }, + "operationId": "BillingRoleDefinition_ListByEnrollmentAccount", + "title": "BillingRoleDefinitionListByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByInvoiceSection.json new file mode 100644 index 000000000000..3da00b6dbadc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingRoleDefinitionListByInvoiceSection.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ] + } + ], + "roleName": "Invoice section owner" + } + }, + { + "name": "30000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ] + } + ], + "roleName": "Invoice section contributor" + } + }, + { + "name": "30000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The reader role gives the user read only access to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017" + ] + } + ], + "roleName": "Invoice section reader" + } + }, + { + "name": "30000000-aaaa-bbbb-cccc-100000000006", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000006", + "properties": { + "description": "The Azure subscription creator role gives the user the ability to create an Azure subscription for the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Azure subscription creator" + } + } + ] + } + } + }, + "operationId": "BillingRoleDefinition_ListByInvoiceSection", + "title": "BillingRoleDefinitionListByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasCreateOrUpdate.json new file mode 100644 index 000000000000..35284f88847c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasCreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": { + "properties": { + "billingFrequency": "P1M", + "displayName": "Subscription 3", + "quantity": 1, + "skuId": "0001", + "termDuration": "P1M" + } + } + }, + "responses": { + "200": { + "body": { + "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "displayName": "Billing Subscription Display Name", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "201": { + "body": { + "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "displayName": "Billing Subscription Display Name", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/putBillingSubscriptionAlias_c356b7c7-7545-4686-b843-c1a49cf853fc:11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingSubscriptionsAliases_CreateOrUpdate", + "title": "BillingSubscriptionAliasCreateOrUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasGet.json new file mode 100644 index 000000000000..3acbf0408d4b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "displayName": "Billing Subscription Display Name", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + } + }, + "operationId": "BillingSubscriptionsAliases_Get", + "title": "BillingSubscriptionAliasGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasList.json new file mode 100644 index 000000000000..972130b55ef2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionAliasList.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "displayName": "My subscription", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/11111111-1111-1111-1111-111111111111", + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000001", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "22222222-2222-2222-2222-222222222222", + "displayName": "Test subscription", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "Software", + "productType": "Software Product Type", + "productTypeId": "EFG456", + "purchaseDate": "2023-01-06T22:39:34.2606750Z", + "quantity": 1, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/22222222-2222-2222-2222-222222222222", + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-07T22:39:34.2606750Z", + "termStartDate": "2023-01-07T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-06T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-07T22:39:34.2606750Z" + } + }, + { + "name": "90000000-0000-0000-0000-000000000002", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000002", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "33333333-3333-3333-3333-333333333333", + "displayName": "Dev subscription", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "ReservationOrder", + "productType": "Reservation Product Type", + "productTypeId": "JKL789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "resourceUri": "/providers/Microsoft.Capacity/reservationOrders/33333333-3333-3333-3333-333333333333", + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Suspended", + "suspensionReasonDetails": [ + { + "effectiveDate": "2023-01-15T22:39:34.2606750Z", + "reason": "Cancelled" + } + ], + "suspensionReasons": [ + "Cancelled" + ], + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptionsAliases_ListByBillingAccount", + "title": "BillingSubscriptionAliasList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionGetByBillingProfile.json new file mode 100644 index 000000000000..17f09355962d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionGetByBillingProfile.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "pcn.94077792", + "billingProfileName": "6478903", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "responses": { + "200": { + "body": { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903", + "billingProfileName": "47268432", + "displayName": "My Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/6564892/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "provisioningTenantId": "7d62dbd1-1348-4496-b2f8-df6948c103ee", + "quantity": 50, + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "systemOverrides": { + "cancellation": "Allowed", + "cancellationAllowedEndDate": "2023-01-05T22:39:34.2606750Z" + } + } + } + } + }, + "operationId": "BillingSubscriptions_GetByBillingProfile", + "title": "BillingSubscriptionGetByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionMove.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionMove.json new file mode 100644 index 000000000000..41315343d41e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionMove.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "consumptionCostCenter": "ABC1234", + "displayName": "My Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/operationResults/moveBillingSubscription_11000000-0000-0000-0000-000000000000:22000000-0000-0000-0000-000000000000:6b96d3f2-9008-4a9d-912f-f87744185aa3:44000000-0000-0000-0000-000000000055:10000000-0000-0000-0000-000000000001?api-version=2020-12-15-privatepreview", + "Retry-After": "30" + } + } + }, + "operationId": "BillingSubscriptions_Move", + "title": "BillingSubscriptionMove" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionValidateMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionValidateMoveFailure.json new file mode 100644 index 000000000000..d9e04a753566 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionValidateMoveFailure.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "errorDetails": { + "code": "SubscriptionNotActive", + "message": "Invoice Sections can only be changed for active subscriptions." + } + } + } + }, + "operationId": "BillingSubscriptions_ValidateMoveEligibility", + "title": "BillingSubscriptionValidateMoveFailure" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionValidateMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionValidateMoveSuccess.json new file mode 100644 index 000000000000..9deec3d962ed --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionValidateMoveSuccess.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "isMoveEligible": true + } + } + }, + "operationId": "BillingSubscriptions_ValidateMoveEligibility", + "title": "BillingSubscriptionValidateMoveSuccess" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsCancel.json new file mode 100644 index 000000000000..28aeef92114d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsCancel.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "cancellationReason": "Compromise", + "customerId": "11111111-1111-1111-1111-111111111111" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/cancelBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingSubscriptions_Cancel", + "title": "BillingSubscriptionsCancel" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsDelete.json new file mode 100644 index 000000000000..9e1cc40c863d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/cancelBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + }, + "204": {} + }, + "operationId": "BillingSubscriptions_Delete", + "title": "BillingSubscriptionsDelete" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsGet.json new file mode 100644 index 000000000000..43a4cd37d02b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "My subscription", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + }, + "operationId": "BillingSubscriptions_Get", + "title": "BillingSubscriptionsGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingAccount.json new file mode 100644 index 000000000000..3db4281ae8c3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingAccount.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "excludeCharges": false, + "includeDeleted": false, + "includeTenantSubscriptions": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "My subscription", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Test subscription", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "Software", + "productType": "Software Product Type", + "productTypeId": "EFG456", + "purchaseDate": "2023-01-06T22:39:34.2606750Z", + "quantity": 1, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-07T22:39:34.2606750Z", + "termStartDate": "2023-01-07T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-06T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-07T22:39:34.2606750Z" + } + }, + { + "name": "90000000-0000-0000-0000-000000000002", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000002", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Dev subscription", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "ReservationOrder", + "productType": "Reservation Product Type", + "productTypeId": "JKL789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "resourceUri": "/providers/Microsoft.Capacity/reservationOrders/90000000-0000-0000-0000-000000000002", + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Suspended", + "suspensionReasonDetails": [ + { + "effectiveDate": "2023-01-15T22:39:34.2606750Z", + "reason": "Cancelled" + } + ], + "suspensionReasons": [ + "Cancelled" + ], + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptions_ListByBillingAccount", + "title": "BillingSubscriptionsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingProfileEA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingProfileEA.json new file mode 100644 index 000000000000..ebb52bad9c95 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingProfileEA.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "pcn.94077792", + "billingProfileName": "6478903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903", + "billingProfileName": "47268432", + "displayName": "My Subscription", + "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountId": "172988", + "offerId": "MS-AZR-0017P", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptions_ListByBillingProfile", + "title": "BillingSubscriptionsListByBillingProfileEA" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingProfileMCA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingProfileMCA.json new file mode 100644 index 000000000000..87b8659a17d1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByBillingProfileMCA.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "My Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + } + }, + { + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Test Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + } + }, + { + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "90D31600-D46D-4084-84C6-1235CDAFFB56" + } + }, + { + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Test Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptions_ListByBillingProfile", + "title": "BillingSubscriptionsListByBillingProfileMCA" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByCustomer.json new file mode 100644 index 000000000000..0e62bcbea4fe --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByCustomer.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "My Subscription", + "reseller": { + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + } + }, + { + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "Test Subscription", + "reseller": { + "description": "Reseller3", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + } + }, + { + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "Dev Test Subscription", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptions_ListByCustomer", + "title": "BillingSubscriptionsListByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..f16663b14cc5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByCustomerAtBillingAccount.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "customerName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "My Subscription", + "reseller": { + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + } + }, + { + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "Test Subscription", + "reseller": { + "description": "Reseller3", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + } + }, + { + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "Dev Test Subscription", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptions_ListByCustomerAtBillingAccount", + "title": "BillingSubscriptionsListByCustomerAtBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByEnrollmentAccount.json new file mode 100644 index 000000000000..3fb62e8c573d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByEnrollmentAccount.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "enrollmentAccountName": "172988" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "properties": { + "consumptionCostCenter": "123", + "displayName": "TestSubscription", + "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountId": "172988", + "enrollmentAccountSubscriptionDetails": { + "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z" + }, + "offerId": "MS-AZR-0017P", + "subscriptionId": "90000000-0000-0000-0000-000000000000" + } + }, + { + "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000001", + "properties": { + "consumptionCostCenter": "", + "displayName": "Microsoft Azure Enterprise-1", + "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountId": "172988", + "enrollmentAccountSubscriptionDetails": { + "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z", + "subscriptionEnrollmentAccountStatus": "Deleted" + }, + "offerId": "MS-AZR-0136P", + "subscriptionId": "90000000-0000-0000-0000-000000000001" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptions_ListByEnrollmentAccount", + "title": "BillingSubscriptionsListByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByInvoiceSection.json new file mode 100644 index 000000000000..035a35768029 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsListByInvoiceSection.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "My Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + } + }, + { + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Test Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + } + }, + { + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "90D31600-D46D-4084-84C6-1235CDAFFB56" + } + }, + { + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Test Subscription", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + } + } + ] + } + } + }, + "operationId": "BillingSubscriptions_ListByInvoiceSection", + "title": "BillingSubscriptionsListByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsMerge.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsMerge.json new file mode 100644 index 000000000000..9b755bf7ed86 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsMerge.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "quantity": 1, + "targetBillingSubscriptionName": "22222222-2222-2222-2222-222222222222" + } + }, + "responses": { + "200": { + "body": { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/22222222-2222-2222-2222-222222222222", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 2, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/splitBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingSubscriptions_Merge", + "title": "BillingSubscriptionsMerge" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsSplit.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsSplit.json new file mode 100644 index 000000000000..68db697e7aec --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsSplit.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "billingFrequency": "P1M", + "quantity": 1, + "targetProductTypeId": "XYZ56789", + "targetSkuId": "0001", + "termDuration": "P1M" + } + }, + "responses": { + "200": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/splitBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingSubscriptions_Split", + "title": "BillingSubscriptionsSplit" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsUpdate.json new file mode 100644 index 000000000000..5fff8da3d7ce --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/billingSubscriptionsUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "consumptionCostCenter": "ABC1234" + } + } + }, + "responses": { + "200": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" + }, + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/manageBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "BillingSubscriptions_Update", + "title": "BillingSubscriptionsUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByBillingAccount.json new file mode 100644 index 000000000000..93ac15cdffcd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByBillingAccount.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + }, + "operationId": "BillingPermissions_CheckAccessByBillingAccount", + "title": "CheckAccessByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByBillingProfile.json new file mode 100644 index 000000000000..7128d7524ebf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByBillingProfile.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + }, + "operationId": "BillingPermissions_CheckAccessByBillingProfile", + "title": "CheckAccessByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByCustomer.json new file mode 100644 index 000000000000..309da80e893c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByCustomer.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + }, + "operationId": "BillingPermissions_CheckAccessByCustomer", + "title": "CheckAccessByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByDepartment.json new file mode 100644 index 000000000000..51ac9c7c6720 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByDepartment.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "departmentName": "12345", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + }, + "operationId": "BillingPermissions_CheckAccessByDepartment", + "title": "CheckAccessByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByEnrollmentAccount.json new file mode 100644 index 000000000000..d3a747bf15b5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByEnrollmentAccount.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "enrollmentAccountName": "123456", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + }, + "operationId": "BillingPermissions_CheckAccessByEnrollmentAccount", + "title": "CheckAccessByEnrollmentAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByInvoiceSection.json new file mode 100644 index 000000000000..87d886d4ac35 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/checkAccessByInvoiceSection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + }, + "operationId": "BillingPermissions_CheckAccessByInvoiceSection", + "title": "CheckAccessByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersGet.json new file mode 100644 index 000000000000..d6c88013f0bf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "enabledAzurePlans": [ + { + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" + } + ], + "resellers": [ + { + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" + }, + { + "description": "Reseller2", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" + } + ], + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + } + }, + "operationId": "Customers_Get", + "title": "CustomersGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersGetByBillingAccount.json new file mode 100644 index 000000000000..adb63620add7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersGetByBillingAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "enabledAzurePlans": [ + { + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" + } + ], + "resellers": [ + { + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" + }, + { + "description": "Reseller2", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" + } + ], + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + } + }, + "operationId": "Customers_GetByBillingAccount", + "title": "CustomersGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingAccount.json new file mode 100644 index 000000000000..1064a49c704a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + }, + { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer2", + "status": "Active", + "systemId": "zzzz-zzzz-zzz-zzz" + } + } + ] + } + } + }, + "operationId": "Customers_ListByBillingAccount", + "title": "CustomersListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingAccountWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingAccountWithExpand.json new file mode 100644 index 000000000000..95dd9762fbae --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingAccountWithExpand.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expand": "enabledAzurePlans,resellers" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "enabledAzurePlans": [ + { + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" + } + ], + "resellers": [ + { + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" + }, + { + "description": "Reseller2", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" + } + ], + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + ] + } + } + }, + "operationId": "Customers_ListByBillingAccount", + "title": "CustomersListByBillingAccountWithExpand" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingProfile.json new file mode 100644 index 000000000000..4781d9a4780b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/customersListByBillingProfile.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + }, + { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer2", + "status": "Active", + "systemId": "zzzz-zzzz-zzz-zzz" + } + } + ] + } + } + }, + "operationId": "Customers_ListByBillingProfile", + "title": "CustomersListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/departmentGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/departmentGet.json new file mode 100644 index 000000000000..438c256efa13 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/departmentGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "456598", + "departmentName": "164821" + }, + "responses": { + "200": { + "body": { + "name": "164821", + "type": "Microsoft.Billing/billingAccounts/departments", + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", + "properties": { + "costCenter": "C1", + "displayName": "Test department", + "status": "Active" + } + } + } + }, + "operationId": "Departments_Get", + "title": "DepartmentGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/departmentsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/departmentsListByBillingAccount.json new file mode 100644 index 000000000000..5e06cd8592b0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/departmentsListByBillingAccount.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "456598" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "164821", + "type": "Microsoft.Billing/billingAccounts/departments", + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", + "properties": { + "costCenter": "C1", + "displayName": "departmentName1", + "status": "Active" + } + }, + { + "name": "164822", + "type": "Microsoft.Billing/billingAccounts/departments", + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164822", + "properties": { + "costCenter": "C4", + "displayName": "departmentName2", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "Departments_ListByBillingAccount", + "title": "DepartmentsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountByDepartment.json new file mode 100644 index 000000000000..3e80e4b4459f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountByDepartment.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "departmentName": "164821", + "enrollmentAccountName": "257698" + }, + "responses": { + "200": { + "body": { + "name": "257698", + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", + "properties": { + "accountOwner": "account0@contoso.com", + "authType": "MicrosoftAccount", + "costCenter": "C0", + "departmentDisplayName": "TestDept", + "departmentId": "164821", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", + "isDevTestEnabled": true, + "startDate": "2018-05-01T17:32:28Z", + "status": "Active" + } + } + } + }, + "operationId": "EnrollmentAccounts_GetByDepartment", + "title": "EnrollmentAccountByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountGet.json new file mode 100644 index 000000000000..e339850df786 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "enrollmentAccountName": "257698" + }, + "responses": { + "200": { + "body": { + "name": "257698", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", + "properties": { + "accountOwner": "account0@contoso.com", + "authType": "Organization", + "costCenter": "C0", + "departmentDisplayName": "TestDept123", + "departmentId": "234516", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", + "isDevTestEnabled": true, + "startDate": "2018-05-01T17:32:28Z", + "status": "Active" + } + } + } + }, + "operationId": "EnrollmentAccounts_Get", + "title": "EnrollmentAccountGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountsListByBillingAccount.json new file mode 100644 index 000000000000..abf35fa57ccc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountsListByBillingAccount.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "257698", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", + "properties": { + "accountOwner": "account0@contoso.com", + "authType": "Organization", + "costCenter": "C0", + "departmentDisplayName": "TestDept123", + "departmentId": "234516", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", + "isDevTestEnabled": true, + "startDate": "2018-05-01T17:32:28Z", + "status": "Active" + } + }, + { + "name": "264698", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/264698", + "properties": { + "accountOwner": "account1@contoso.com", + "authType": "MicrosoftAccount", + "costCenter": "C1", + "departmentDisplayName": "TestDept1", + "departmentId": "234531", + "displayName": "AccountName1", + "endDate": "2019-05-31T17:32:28Z", + "isDevTestEnabled": true, + "startDate": "2018-05-01T17:32:28Z", + "status": "Active" + } + }, + { + "name": "276290", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/276290", + "properties": { + "accountOwner": "account2@contoso.com", + "authType": "Organization", + "costCenter": "C2", + "departmentDisplayName": "TestDept2", + "departmentId": "234512", + "displayName": "AccountName2", + "endDate": "2019-05-31T17:32:28Z", + "isDevTestEnabled": true, + "startDate": "2018-05-01T17:32:28Z", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "EnrollmentAccounts_ListByBillingAccount", + "title": "EnrollmentAccountsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountsListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountsListByDepartment.json new file mode 100644 index 000000000000..d5868b3a9412 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/enrollmentAccountsListByDepartment.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "departmentName": "164821" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "257698", + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", + "properties": { + "accountOwner": "account0@contoso.com", + "authType": "MicrosoftAccount", + "costCenter": "C0", + "departmentDisplayName": "TestDept", + "departmentId": "164821", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", + "isDevTestEnabled": true, + "startDate": "2018-05-01T17:32:28Z", + "status": "Active" + } + }, + { + "name": "264698", + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/264698", + "properties": { + "accountOwner": "account1@contoso.com", + "authType": "Organization", + "costCenter": "C1", + "departmentDisplayName": "TestDept", + "departmentId": "164821", + "displayName": "AccountName1", + "endDate": "2019-05-31T17:32:28Z", + "isDevTestEnabled": false, + "startDate": "2018-05-01T17:32:28Z", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "EnrollmentAccounts_ListByDepartment", + "title": "EnrollmentAccountsListByDepartment" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsCreateOrUpdate.json new file mode 100644 index 000000000000..f389c2b590fc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsCreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "invoice-section-1", + "parameters": { + "properties": { + "displayName": "Invoice Section 1", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + }, + "201": { + "body": { + "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/putAssociatedTenant_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + } + }, + "operationId": "InvoiceSections_CreateOrUpdate", + "title": "InvoiceSectionsCreateOrUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsDelete.json new file mode 100644 index 000000000000..5a78c77c8640 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/deleteInvoiceSection_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + }, + "204": {} + }, + "operationId": "InvoiceSections_Delete", + "title": "InvoiceSectionsDelete" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsGet.json new file mode 100644 index 000000000000..14bb9fb17c92 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + } + }, + "operationId": "InvoiceSections_Get", + "title": "InvoiceSectionsGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsListByBillingProfile.json new file mode 100644 index 000000000000..80192327a992 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsListByBillingProfile.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "includeDeleted": true + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "state": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + }, + { + "name": "invoice-section-2", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-2", + "properties": { + "displayName": "Invoice Section 2", + "reasonCode": "PastDue", + "state": "Warned", + "systemId": "zzzz-zzzz-zzz-zzz", + "tags": { + "costCategory": "Marketing", + "pcCode": "Z345678" + } + } + }, + { + "name": "invoice-section-3", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-3", + "properties": { + "displayName": "Invoice Section 3", + "state": "Deleted", + "systemId": "aaaa-aaaa-aaa-aaa", + "tags": { + "costCategory": "Support", + "pcCode": "A123456" + } + } + } + ] + } + } + }, + "operationId": "InvoiceSections_ListByBillingProfile", + "title": "InvoiceSectionsListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsValidateDeleteEligibilityFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsValidateDeleteEligibilityFailure.json new file mode 100644 index 000000000000..1668074a45c3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsValidateDeleteEligibilityFailure.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "eligibilityDetails": [ + { + "code": "ActiveBillingSubscriptions", + "message": "There are active or disabled subscriptions assigned to the invoice section. Either move the subscription to another invoice section or delete the subscriptions and then try deleting the invoice section." + }, + { + "code": "LastInvoiceSection", + "message": "This is the only invoice section in this billing profile so it can’t be deleted." + }, + { + "code": "ActiveAzurePlans", + "message": "This is the invoice section that was created when its billing profile was created so it can’t be deleted." + }, + { + "code": "ReservedInstances", + "message": "The invoice section has the RI asset with a billing plan." + } + ], + "eligibilityStatus": "NotAllowed" + } + } + }, + "operationId": "InvoiceSections_ValidateDeleteEligibility", + "title": "InvoiceSectionsValidateDeleteEligibilityFailure" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsValidateDeleteEligibilitySuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsValidateDeleteEligibilitySuccess.json new file mode 100644 index 000000000000..52213dde07c6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsValidateDeleteEligibilitySuccess.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": {} + } + }, + "operationId": "InvoiceSections_ValidateDeleteEligibility", + "title": "InvoiceSectionsValidateDeleteEligibilitySuccess" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsWithCreateSubscriptionPermissionList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsWithCreateSubscriptionPermissionList.json new file mode 100644 index 000000000000..0f6b4ebe83be --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoiceSectionsWithCreateSubscriptionPermissionList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSpendingLimit": "On", + "billingProfileStatus": "Warned", + "billingProfileStatusReasonCode": "PastDue", + "billingProfileSystemId": "33000000-0000-0000-0000-000000000000", + "enabledAzurePlans": [ + { + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001" + }, + { + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" + } + ], + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionSystemId": "22000000-0000-0000-0000-000000000000" + } + ] + } + } + }, + "operationId": "BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission", + "title": "InvoiceSectionsWithCreateSubscriptionPermissionList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesAmend.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesAmend.json new file mode 100644 index 000000000000..7be7083e7c45 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesAmend.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789/operationResults/invoiceAmend_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + }, + "operationId": "Invoices_Amend", + "title": "InvoicesAmend" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadByBillingAccount.json new file mode 100644 index 000000000000..ff63bd242d0b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadByBillingAccount.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "documentName": "12345678", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + }, + "operationId": "Invoices_DownloadByBillingAccount", + "title": "InvoicesDownloadByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadByBillingSubscription.json new file mode 100644 index 000000000000..92bce81e17c2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadByBillingSubscription.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "documentName": "12345678", + "invoiceName": "E123456789", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + }, + "operationId": "Invoices_DownloadByBillingSubscription", + "title": "InvoicesDownloadByBillingSubscription" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadDocumentsByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadDocumentsByBillingAccount.json new file mode 100644 index 000000000000..ee7e31e238de --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadDocumentsByBillingAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": [ + { + "documentName": "12345678", + "invoiceName": "G123456789" + }, + { + "documentName": "12345678", + "invoiceName": "G987654321" + } + ] + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + }, + "operationId": "Invoices_DownloadDocumentsByBillingAccount", + "title": "InvoicesDownloadDocumentsByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadDocumentsByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadDocumentsByBillingSubscription.json new file mode 100644 index 000000000000..c2267bd021aa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadDocumentsByBillingSubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": [ + { + "documentName": "12345678", + "invoiceName": "E123456789" + }, + { + "documentName": "12345678", + "invoiceName": "E987654321" + } + ], + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + }, + "operationId": "Invoices_DownloadDocumentsByBillingSubscription", + "title": "InvoicesDownloadDocumentsByBillingSubscription" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadSummaryByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadSummaryByBillingAccount.json new file mode 100644 index 000000000000..7e3f23a4fde2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesDownloadSummaryByBillingAccount.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456789", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724_summary.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456789/operationResults/invoiceSummaryDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + }, + "operationId": "Invoices_DownloadSummaryByBillingAccount", + "title": "InvoicesDownloadSummaryByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGet.json new file mode 100644 index 000000000000..48f386e6616d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGet.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documentType": "Invoice", + "documents": [ + { + "name": "12345678", + "kind": "Invoice" + }, + { + "name": "22345678", + "kind": "TaxReceipt" + } + ], + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" + } + }, + "specialTaxationType": "SubtotalLevel", + "status": "Due", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + } + } + } + }, + "operationId": "Invoices_Get", + "title": "InvoicesGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGetByBillingAccount.json new file mode 100644 index 000000000000..f60e257e55f0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGetByBillingAccount.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documentType": "Invoice", + "documents": [ + { + "name": "12345678", + "kind": "Invoice" + }, + { + "name": "22345678", + "kind": "TaxReceipt" + } + ], + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" + } + }, + "specialTaxationType": "SubtotalLevel", + "status": "Due", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + } + } + } + }, + "operationId": "Invoices_GetByBillingAccount", + "title": "InvoicesGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGetByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGetByBillingSubscription.json new file mode 100644 index 000000000000..216ac293d844 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesGetByBillingSubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "invoiceName": "E123456789", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "E123456789", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "dueDate": "2023-02-16T17:32:28Z", + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "invoiceType": "AzureServices", + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + } + } + } + }, + "operationId": "Invoices_GetByBillingSubscription", + "title": "InvoicesGetByBillingSubscription" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingAccount.json new file mode 100644 index 000000000000..5c97f586d6d9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingAccount.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "periodEndDate": "2023-06-30", + "periodStartDate": "2023-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documentType": "Invoice", + "documents": [ + { + "name": "12345678", + "kind": "Invoice" + }, + { + "name": "22345678", + "kind": "TaxReceipt" + } + ], + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" + } + }, + "status": "Due", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + } + }, + { + "name": "G987654321", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", + "properties": { + "amountDue": { + "currency": "USD", + "value": 0 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documentType": "Invoice", + "documents": [ + { + "name": "12345678", + "kind": "Invoice" + }, + { + "name": "22345678", + "kind": "TaxReceipt" + } + ], + "dueDate": "2023-01-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-01-01T17:32:28Z", + "invoicePeriodEndDate": "2023-01-15T17:32:28Z", + "invoicePeriodStartDate": "2023-01-01T17:32:28Z", + "isMonthlyInvoice": false, + "payments": [ + { + "amount": { + "currency": "USD", + "value": 33.99 + }, + "date": "2023-01-14T17:32:28Z", + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa", + "paymentType": "debited" + } + ], + "purchaseOrderNumber": "123455", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" + } + }, + "status": "Paid", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + } + } + ] + } + } + }, + "operationId": "Invoices_ListByBillingAccount", + "title": "InvoicesListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingProfile.json new file mode 100644 index 000000000000..c2a04d9eaca8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingProfile.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "periodEndDate": "2023-06-30", + "periodStartDate": "2023-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documentType": "Invoice", + "documents": [ + { + "name": "12345678", + "kind": "Invoice" + }, + { + "name": "22345678", + "kind": "TaxReceipt" + } + ], + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" + } + }, + "status": "Due", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + } + }, + { + "name": "G987654321", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", + "properties": { + "amountDue": { + "currency": "USD", + "value": 0 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documentType": "Invoice", + "documents": [ + { + "name": "12345678", + "kind": "Invoice" + }, + { + "name": "22345678", + "kind": "TaxReceipt" + } + ], + "dueDate": "2023-01-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-01-01T17:32:28Z", + "invoicePeriodEndDate": "2023-01-15T17:32:28Z", + "invoicePeriodStartDate": "2023-01-01T17:32:28Z", + "isMonthlyInvoice": false, + "payments": [ + { + "amount": { + "currency": "USD", + "value": 33.99 + }, + "date": "2023-01-14T17:32:28Z", + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa", + "paymentType": "debited" + } + ], + "purchaseOrderNumber": "123455", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "rebillDetails": { + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" + } + }, + "status": "Paid", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + } + } + ] + } + } + }, + "operationId": "Invoices_ListByBillingProfile", + "title": "InvoicesListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingSubscription.json new file mode 100644 index 000000000000..de7b1d65ba72 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/invoicesListByBillingSubscription.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "periodEndDate": "2023-06-30", + "periodStartDate": "2023-01-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "E123456789", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "dueDate": "2023-02-16T17:32:28Z", + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "invoiceType": "AzureServices", + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + } + }, + { + "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 15.53 + }, + "billedAmount": { + "currency": "USD", + "value": 55.99 + }, + "dueDate": "2023-02-16T17:32:28Z", + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "invoiceType": "AzureMarketplace", + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + } + }, + { + "name": "E987654321", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E987654321", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "documents": [ + { + "name": "12345678", + "kind": "Invoice" + } + ], + "dueDate": "2023-01-16T17:32:28Z", + "invoiceDate": "2023-01-01T17:32:28Z", + "invoicePeriodEndDate": "2023-01-15T17:32:28Z", + "invoicePeriodStartDate": "2023-01-01T17:32:28Z", + "invoiceType": "AzureSupport", + "payments": [ + { + "amount": { + "currency": "USD", + "value": 2000 + }, + "date": "2023-01-14T17:32:28Z", + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa", + "paymentType": "credited" + } + ], + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + } + } + ] + } + } + }, + "operationId": "Invoices_ListByBillingSubscription", + "title": "InvoicesListByBillingSubscription" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/operationsList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/operationsList.json new file mode 100644 index 000000000000..cefabe33c7f2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/operationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{namespace}/resource/read", + "display": { + "operation": "List resources", + "provider": "{namespace}", + "resource": "resource" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "OperationsList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersCancel.json new file mode 100644 index 000000000000..0c27c912e8ee --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersCancel.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "properties": { + "canceledBy": "user@contoso.com", + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorCustomerType": "Partner", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" + } + } + } + }, + "operationId": "PartnerTransfers_Cancel", + "title": "PartnerTransferCancel" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersGet.json new file mode 100644 index 000000000000..be3e6c467ec5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "properties": { + "detailedTransferStatus": [ + { + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "productType": "AzureSubscription", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productId": "reservedInstanceId", + "productName": "Reservation name", + "productType": "AzureReservation", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorCustomerType": "Partner", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" + } + } + } + }, + "operationId": "PartnerTransfers_Get", + "title": "PartnerTransferGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersInitiate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersInitiate.json new file mode 100644 index 000000000000..5126d6992020 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersInitiate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "recipientEmailId": "user@contoso.com" + } + }, + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorCustomerType": "Partner", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" + } + } + }, + "201": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorCustomerType": "Partner", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" + } + } + } + }, + "operationId": "PartnerTransfers_Initiate", + "title": "InitiatePartnerTransfer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersList.json new file mode 100644 index 000000000000..2185d0e29055 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/partnerTransfersList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "properties": { + "detailedTransferStatus": [ + { + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "productType": "AzureSubscription", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productId": "reservedInstanceId", + "productName": "Reservation name", + "productType": "AzureReservation", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorCustomerType": "Partner", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" + } + } + ] + } + } + }, + "operationId": "PartnerTransfers_List", + "title": "PartnerTransfersList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsDeleteByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsDeleteByUser.json new file mode 100644 index 000000000000..a8c96baa845e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsDeleteByUser.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "paymentMethodName": "ABCDABCDABC0" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PaymentMethods_DeleteByUser", + "title": "DeletePaymentMethodOwnedByUser" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByBillingAccount.json new file mode 100644 index 000000000000..0e98bd48011d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByBillingAccount.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", + "paymentMethodName": "21dd9edc-af71-4d62-80ce-37151d475326" + }, + "responses": { + "200": { + "body": { + "name": "21dd9edc-af71-4d62-80ce-37151d475326", + "type": "Microsoft.Billing/billingAccounts/paymentMethods", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", + "properties": { + "displayName": "Check/wire transfer", + "family": "CheckWire", + "paymentMethodType": "check" + } + } + } + }, + "operationId": "PaymentMethods_GetByBillingAccount", + "title": "PaymentMethodGetAtBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByBillingProfile.json new file mode 100644 index 000000000000..0bcd26dc0121 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByBillingProfile.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", + "billingProfileName": "ABC1-A1CD-AB1-BP1", + "paymentMethodName": "ABCDABCDABC0" + }, + "responses": { + "200": { + "body": { + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", + "properties": { + "accountHolderName": "abc", + "displayName": "Master Card", + "expiration": "1/2035", + "family": "CreditCard", + "lastFourDigits": "1270", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "paymentMethodType": "mc", + "status": "active" + } + } + } + }, + "operationId": "PaymentMethods_GetByBillingProfile", + "title": "PaymentMethodsGetByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByUser.json new file mode 100644 index 000000000000..a894566b8a7e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsGetByUser.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "paymentMethodName": "ABCDABCDABC0" + }, + "responses": { + "200": { + "body": { + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/paymentMethods", + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "properties": { + "accountHolderName": "abc", + "displayName": "Master Card", + "expiration": "1/2035", + "family": "CreditCard", + "lastFourDigits": "1270", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "paymentMethodType": "mc", + "status": "active" + } + } + } + }, + "operationId": "PaymentMethods_GetByUser", + "title": "GetPaymentMethodOwnedByUser" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByBillingAccount.json new file mode 100644 index 000000000000..f455c2b05b35 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByBillingAccount.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "21dd9edc-af71-4d62-80ce-37151d475326", + "type": "Microsoft.Billing/billingAccounts/paymentMethods", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", + "properties": { + "displayName": "Check/wire transfer", + "family": "CheckWire", + "paymentMethodType": "check" + } + } + ] + } + } + }, + "operationId": "PaymentMethods_ListByBillingAccount", + "title": "PaymentMethodsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByBillingProfile.json new file mode 100644 index 000000000000..2bbd5f9065e4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByBillingProfile.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", + "billingProfileName": "ABC1-A1CD-AB1-BP1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", + "properties": { + "accountHolderName": "abc", + "displayName": "Master Card", + "expiration": "1/2035", + "family": "CreditCard", + "lastFourDigits": "1270", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "paymentMethodType": "mc", + "status": "active" + } + } + ] + } + } + }, + "operationId": "PaymentMethods_ListByBillingProfile", + "title": "PaymentMethodsListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByUser.json new file mode 100644 index 000000000000..171ce892979f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentMethodsListByUser.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/paymentMethods", + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "properties": { + "accountHolderName": "abc", + "displayName": "Master Card", + "expiration": "1/2035", + "family": "CreditCard", + "lastFourDigits": "1270", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_mc_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_mc.svg" + } + ], + "paymentMethodType": "mc", + "status": "active" + } + }, + { + "name": "ABCDABCDABC1", + "type": "Microsoft.Billing/paymentMethods", + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC1", + "properties": { + "accountHolderName": "abc", + "displayName": "Visa", + "expiration": "1/2025", + "family": "CreditCard", + "lastFourDigits": "7373", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "paymentMethodType": "visa", + "status": "active" + } + } + ] + } + } + }, + "operationId": "PaymentMethods_ListByUser", + "title": "ListPaymentMethodOwnedByUser" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermInvalid.json new file mode 100644 index 000000000000..a0e8996e8e22 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermInvalid.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": [ + { + "endDate": "2023-01-25T22:39:34.2606750Z", + "startDate": "2023-02-05T22:39:34.2606750Z", + "term": "net10" + } + ] + }, + "responses": { + "200": { + "body": { + "eligibilityDetails": [ + { + "code": "InvalidDateRange", + "message": "The date range is invalid. The start date must be before the end date." + } + ], + "eligibilityStatus": "Invalid" + } + } + }, + "operationId": "BillingAccounts_ValidatePaymentTerms", + "title": "PaymentTermInvalid" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermValid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermValid.json new file mode 100644 index 000000000000..b9d6a2d0b8e2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermValid.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": [ + { + "endDate": "2023-01-25T22:39:34.2606750Z", + "startDate": "2023-01-05T22:39:34.2606750Z", + "term": "net10" + } + ] + }, + "responses": { + "200": { + "body": { + "eligibilityStatus": "Valid" + } + } + }, + "operationId": "BillingAccounts_ValidatePaymentTerms", + "title": "PaymentTermValid" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermsAdd.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermsAdd.json new file mode 100644 index 000000000000..9233b4b2953e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermsAdd.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": [ + { + "endDate": "2023-01-25T22:39:34.2606750Z", + "startDate": "2023-01-05T22:39:34.2606750Z", + "term": "net10" + } + ] + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/addPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", + "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b", + "retry-after": "10" + } + } + }, + "operationId": "BillingAccounts_AddPaymentTerms", + "title": "PaymentTermsAdd" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermsCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermsCancel.json new file mode 100644 index 000000000000..5acaac028d71 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/paymentTermsCancel.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": "2023-01-05T22:39:34.2606750Z" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountSubType": "Enterprise", + "accountType": "Business", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/cancelPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", + "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b", + "retry-after": "10" + } + } + }, + "operationId": "BillingAccounts_CancelPaymentTerms", + "title": "PaymentTermsCancel" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByBillingAccount.json new file mode 100644 index 000000000000..a0d77bb27fff --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByBillingAccount.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "1234567" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + } + } + } + }, + "operationId": "Policies_GetByBillingAccount", + "title": "PoliciesGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByBillingProfile.json new file mode 100644 index 000000000000..2ace88338036 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByBillingProfile.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + } + } + } + }, + "operationId": "Policies_GetByBillingProfile", + "title": "PoliciesGetByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByCustomer.json new file mode 100644 index 000000000000..27517beee747 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByCustomer.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "policyName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "properties": { + "viewCharges": "Allowed" + } + } + } + }, + "operationId": "Policies_GetByCustomer", + "title": "PoliciesGetByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..dbb455ddddb5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetByCustomerAtBillingAccount.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "properties": { + "viewCharges": "Allowed" + } + } + } + }, + "operationId": "Policies_GetByCustomerAtBillingAccount", + "title": "PoliciesGetByCustomerAtBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetBySubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetBySubscription.json new file mode 100644 index 000000000000..256eb0324fcd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesGetBySubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/policies/default", + "properties": { + "policies": [ + { + "name": "ViewCharges", + "policyType": "SystemControlled", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000", + "value": "Allowed" + } + ] + } + } + } + }, + "operationId": "Policies_GetBySubscription", + "title": "PoliciesGetBySubscription" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByBillingAccount.json new file mode 100644 index 000000000000..8b5c94d8f90b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByBillingAccount.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "1234567", + "parameters": { + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + } + } + } + }, + "operationId": "Policies_CreateOrUpdateByBillingAccount", + "title": "PoliciesPutByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByBillingProfile.json new file mode 100644 index 000000000000..48ddb2a101ff --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByBillingProfile.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + } + } + } + }, + "operationId": "Policies_CreateOrUpdateByBillingProfile", + "title": "PoliciesPutByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByCustomer.json new file mode 100644 index 000000000000..4ef1d775daf7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByCustomer.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "viewCharges": "Allowed" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "properties": { + "viewCharges": "Allowed" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "properties": { + "viewCharges": "Allowed" + } + } + } + }, + "operationId": "Policies_CreateOrUpdateByCustomer", + "title": "PoliciesPutByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..61c1a40d4e2a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/policiesPutByCustomerAtBillingAccount.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "viewCharges": "Allowed" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "properties": { + "viewCharges": "Allowed" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "properties": { + "viewCharges": "Allowed" + } + } + } + }, + "operationId": "Policies_CreateOrUpdateByCustomerAtBillingAccount", + "title": "PoliciesPutByCustomerAtBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productMove.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productMove.json new file mode 100644 index 000000000000..ff04c5d96200 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productMove.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + }, + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "responses": { + "200": { + "body": { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/products/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "My Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "status": "Active" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/operationResults/moveProduct_11000000-0000-0000-0000-000000000000:22000000-0000-0000-0000-000000000000:6b96d3f2-9008-4a9d-912f-f87744185aa3:44000000-0000-0000-0000-000000000055:10000000-0000-0000-0000-000000000001?api-version=2020-12-15-privatepreview", + "Retry-After": "30" + } + } + }, + "operationId": "Products_Move", + "title": "ProductMove" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productValidateMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productValidateMoveFailure.json new file mode 100644 index 000000000000..9190262c6153 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productValidateMoveFailure.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + }, + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "responses": { + "200": { + "body": { + "errorDetails": { + "code": "ProductInactive", + "message": "Invoice Sections can only be changed for active products." + } + } + } + }, + "operationId": "Products_ValidateMoveEligibility", + "title": "ProductValidateMoveFailure" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productValidateMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productValidateMoveSuccess.json new file mode 100644 index 000000000000..86fc99665ebe --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productValidateMoveSuccess.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + }, + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "responses": { + "200": { + "body": { + "isMoveEligible": true + } + } + }, + "operationId": "Products_ValidateMoveEligibility", + "title": "ProductValidateMoveSuccess" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsGet.json new file mode 100644 index 000000000000..d060cf6c4035 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "productName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "My product", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active" + } + } + } + }, + "operationId": "Products_Get", + "title": "ProductsGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByBillingAccount.json new file mode 100644 index 000000000000..d151d2c1f68c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByBillingAccount.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "My product", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000001", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "Test product", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "productType": "Software Product Type", + "productTypeId": "EFG456", + "purchaseDate": "2023-01-06T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "90000000-0000-0000-0000-000000000002", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000002", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "Dev product", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "productType": "Reservation Product Type", + "productTypeId": "JKL789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Suspended" + } + } + ] + } + } + }, + "operationId": "Products_ListByBillingAccount", + "title": "ProductsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByBillingProfile.json new file mode 100644 index 000000000000..a992f596fca9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByBillingProfile.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "My Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Test Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Test Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "Products_ListByBillingProfile", + "title": "ProductsListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByCustomer.json new file mode 100644 index 000000000000..964234c1abde --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByCustomer.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "customerName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "My Product", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", + "status": "Active" + } + }, + { + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "Test Product", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", + "status": "Active" + } + }, + { + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "displayName": "Dev Test Product", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "Products_ListByCustomer", + "title": "ProductsListByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByInvoiceSection.json new file mode 100644 index 000000000000..93996c50973e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsListByInvoiceSection.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "My Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Test Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active" + } + }, + { + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "displayName": "Dev Test Product", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "Products_ListByInvoiceSection", + "title": "ProductsListByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsUpdate.json new file mode 100644 index 000000000000..c2c1927e6fda --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/productsUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": { + "properties": { + "autoRenew": "On" + } + }, + "productName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/11111111-1111-1111-1111-111111111111", + "properties": { + "autoRenew": "On", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "Product Display Name", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active" + } + } + } + }, + "operationId": "Products_Update", + "title": "ProductsUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersAccept.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersAccept.json new file mode 100644 index 000000000000..efa2a1b87041 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersAccept.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "properties": { + "productDetails": [ + { + "productId": "subscriptionId", + "productType": "AzureSubscription" + }, + { + "productId": "reservedInstanceId", + "productType": "AzureReservation" + } + ] + } + }, + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "properties": { + "detailedTransferStatus": [ + { + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "productType": "AzureSubscription", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productId": "reservedInstanceId", + "productName": "Reservation name", + "productType": "AzureReservation", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" + } + } + } + }, + "operationId": "RecipientTransfers_Accept", + "title": "AcceptTransfer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersDecline.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersDecline.json new file mode 100644 index 000000000000..d7e431d7ad84 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersDecline.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Declined" + } + } + } + }, + "operationId": "RecipientTransfers_Decline", + "title": "DeclineTransfer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersGet.json new file mode 100644 index 000000000000..2f8c8514ce8e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "properties": { + "detailedTransferStatus": [ + { + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "productType": "AzureSubscription", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productId": "reservedInstanceId", + "productName": "Reservation name", + "productType": "AzureReservation", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" + } + } + } + }, + "operationId": "RecipientTransfers_Get", + "title": "RecipientTransferGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersList.json new file mode 100644 index 000000000000..d520774686b5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "properties": { + "detailedTransferStatus": [ + { + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "productType": "AzureSubscription", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productId": "reservedInstanceId", + "productName": "Reservation name", + "productType": "ReservedInstance", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" + } + } + ] + } + } + }, + "operationId": "RecipientTransfers_List", + "title": "RecipientTransfersList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersValidate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersValidate.json new file mode 100644 index 000000000000..274b593d0206 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/recipientTransfersValidate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "properties": { + "productDetails": [ + { + "productId": "subscriptionId", + "productType": "AzureSubscription" + }, + { + "productId": "reservedInstanceId", + "productType": "AzureReservation" + } + ] + } + }, + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "productId": "subscriptionId", + "results": [ + { + "code": "NotIntendedRecipient", + "level": "Error", + "message": "Intended recipient is different." + } + ], + "status": "Failed" + } + } + ] + } + } + }, + "operationId": "RecipientTransfers_Validate", + "title": "ValidateTransfer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccount.json new file mode 100644 index 000000000000..cbe3e75c223e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccount.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "$expand": "renewProperties", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationId": "30000000-0000-0000-0000-000000000000", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "etag": 15, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", + "properties": { + "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "expiryDate": "2024-11-25", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", + "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2021-11-25", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Shared", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "On", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountManagementGroup.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountManagementGroup.json new file mode 100644 index 000000000000..3efd9881a573 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountManagementGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "$expand": "renewProperties", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationId": "30000000-0000-0000-0000-000000000000", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "etag": 21, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", + "properties": { + "appliedScopeProperties": { + "displayName": "TestRg", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "50000000-0000-0000-0000-000000000009" + }, + "appliedScopeType": "ManagementGroup", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30", + "displayProvisioningState": "NoBenefit", + "effectiveDateTime": "2023-01-26T01:19:31.9916066Z", + "expiryDate": "2024-11-25", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "extendedStatusInfo": { + "message": "The subscriptions utilizing the reservation were removed or transferred from this account and no longer receive the reservation benefit. You can cancel the reservation or transfer to the right account or create resources and subscriptions to map it to this reservation.", + "statusCode": "NoBenefit" + }, + "instanceFlexibility": "On", + "lastUpdatedDateTime": "2023-01-26T01:19:32.0697120Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2021-11-25", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeProperties": { + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "50000000-0000-0000-0000-000000000009" + }, + "appliedScopeType": "ManagementGroup", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", + "userFriendlyRenewState": "On", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccountManagementGroup" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountSingleResourceGroup.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountSingleResourceGroup.json new file mode 100644 index 000000000000..66fed654e178 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountSingleResourceGroup.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "$expand": "renewProperties", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationId": "30000000-0000-0000-0000-000000000000", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "etag": 23, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", + "properties": { + "appliedScopeProperties": { + "displayName": "fastpathtesting_20210915", + "resourceGroupId": "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915" + }, + "appliedScopeType": "Single", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2023-01-26T01:21:47.2936116Z", + "expiryDate": "2024-11-25", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", + "lastUpdatedDateTime": "2023-01-26T01:21:47.3561106Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2021-11-25", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Single", + "appliedScopes": [ + "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915" + ], + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "ResourceGroup", + "userFriendlyRenewState": "On", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccountSingleResourceGroup" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountSingleScope.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountSingleScope.json new file mode 100644 index 000000000000..f6fa1a4eb692 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationGetByBillingAccountSingleScope.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "$expand": "renewProperties", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationId": "30000000-0000-0000-0000-000000000000", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "etag": 19, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", + "properties": { + "appliedScopeProperties": { + "displayName": "Azure subscription 1", + "subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000009" + }, + "appliedScopeType": "Single", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2023-01-26T01:14:18.558909Z", + "expiryDate": "2024-11-25", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "instanceFlexibility": "Off", + "lastUpdatedDateTime": "2023-01-26T01:14:18.6057756Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2021-11-25", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Single", + "appliedScopes": [ + "/subscriptions/30000000-0000-0000-0000-000000000009" + ], + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "Off", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "Off" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Single", + "userFriendlyRenewState": "On", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccountSingleScope" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrderGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrderGetByBillingAccount.json new file mode 100644 index 000000000000..133dbbc0ecc2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrderGetByBillingAccount.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders", + "etag": 27, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", + "properties": { + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "Monthly", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "createdDateTime": "2021-11-25T06:34:13.9736776Z", + "displayName": "VM_RI_11-24-2021_22-30", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "originalQuantity": 1, + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "requestDateTime": "2021-11-25T06:31:18.3925493Z", + "reservations": [ + { + "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" + } + ], + "term": "P3Y" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "ReservationOrders_GetByBillingAccount", + "title": "reservationOrderGetByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrderGetByBillingAccountWithExpandPlanInformation.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrderGetByBillingAccountWithExpandPlanInformation.json new file mode 100644 index 000000000000..000022735202 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrderGetByBillingAccountWithExpandPlanInformation.json @@ -0,0 +1,411 @@ +{ + "parameters": { + "$expand": "schedule", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders", + "etag": 26, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", + "properties": { + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "Monthly", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "createdDateTime": "2021-11-25T06:34:13.9736776Z", + "displayName": "VM_RI_11-24-2021_22-30", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "originalQuantity": 1, + "planInformation": { + "nextPaymentDueDate": "2023-01-25", + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "startDate": "2021-11-25", + "transactions": [ + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2021-11-25", + "paymentDate": "2021-11-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2021-12-25", + "paymentDate": "2021-12-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-01-25", + "paymentDate": "2022-01-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-02-25", + "paymentDate": "2022-02-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-03-25", + "paymentDate": "2022-03-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-04-25", + "paymentDate": "2022-04-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-05-25", + "paymentDate": "2022-05-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-06-25", + "paymentDate": "2022-06-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-07-25", + "paymentDate": "2022-07-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-08-25", + "paymentDate": "2022-08-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-09-25", + "paymentDate": "2022-09-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-10-25", + "paymentDate": "2022-10-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-11-25", + "paymentDate": "2022-11-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "dueDate": "2022-12-25", + "paymentDate": "2022-12-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "dueDate": "2023-01-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-02-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-03-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-04-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-05-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-06-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-07-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-08-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-09-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-10-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-11-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-12-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-01-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-02-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-03-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-04-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-05-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-06-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-07-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-08-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-09-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-10-25", + "pricingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, + "status": "Scheduled" + } + ] + }, + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "requestDateTime": "2021-11-25T06:31:18.3925493Z", + "reservations": [ + { + "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" + } + ], + "term": "P3Y" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "ReservationOrders_GetByBillingAccount", + "title": "reservationOrderGetByBillingAccountWithExpandPlanInformation" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrdersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrdersListByBillingAccount.json new file mode 100644 index 000000000000..c4fd7b0bcb83 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationOrdersListByBillingAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders", + "etag": 10, + "id": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", + "properties": { + "benefitStartTime": "2021-08-03T21:26:48.5128969Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "Upfront", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "createdDateTime": "2021-08-03T21:26:50.7784836Z", + "displayName": "SUSE_Plan_08-03-2021_14-22", + "expiryDateTime": "2024-08-03T21:26:48.5128969Z", + "originalQuantity": 1, + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "requestDateTime": "2021-08-03T21:23:47.9090964Z", + "reservations": [ + { + "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" + } + ], + "term": "P3Y" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ] + } + } + }, + "operationId": "ReservationOrders_ListByBillingAccount", + "title": "reservationOrderListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationUpdateByBillingAccount.json new file mode 100644 index 000000000000..6422ff18d86f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationUpdateByBillingAccount.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "body": { + "properties": { + "displayName": "NewName" + } + }, + "reservationId": "30000000-0000-0000-0000-000000000000", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "etag": 15, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", + "properties": { + "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "NewName", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "expiryDate": "2024-11-25", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", + "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2021-11-25", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Shared", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "On", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "Retry-After": 120 + } + } + }, + "operationId": "Reservations_UpdateByBillingAccount", + "title": "ReservationUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsGetFromOrderByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsGetFromOrderByBillingAccount.json new file mode 100644 index 000000000000..df794e93133b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsGetFromOrderByBillingAccount.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "a7d70646-b848-4498-8093-5938128b225c", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "etag": 15, + "id": "/providers/Microsoft.Billing/billingAccounts/4973e1de-a829-5c64-4fef-0a692e2b3108:1970c5da-0aa4-46fd-a917-4772f9a17978_2019-05-31/reservationOrders/99f340d1-6db4-41b4-b469-cfc499716973/reservations/a7d70646-b848-4498-8093-5938128b225c", + "location": "westus", + "properties": { + "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", + "displayName": "VM_RI_11-24-2021_22-30", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "expiryDate": "2024-11-25", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", + "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2021-11-25", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "On", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ] + } + } + }, + "operationId": "Reservations_ListByReservationOrder", + "title": "reservationsGetFromOrderByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsListByBillingAccount.json new file mode 100644 index 000000000000..cd1aa66e6d3f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsListByBillingAccount.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "$filter": "properties/reservedResourceType eq 'VirtualMachineSoftware' and properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA'", + "$orderby": "properties/userFriendlyAppliedScopeType asc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "refreshsummary": "true", + "selectedState": "Succeeded" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "summary": { + "cancelledCount": 0, + "expiredCount": 0, + "expiringCount": 0, + "failedCount": 0, + "noBenefitCount": 0, + "pendingCount": 0, + "processingCount": 0, + "succeededCount": 1, + "warningCount": 0 + }, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", + "location": "global", + "properties": { + "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", + "displayName": "VirtualMachineSoftware_01-18-2022_13-51", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "0001-01-01T00:00:00Z", + "expiryDate": "2025-01-18", + "expiryDateTime": "2025-01-18T21:54:31.0741034Z", + "instanceFlexibility": "On", + "lastUpdatedDateTime": "0001-01-01T00:00:00.0000000", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2022-01-18", + "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", + "quantity": 1, + "renew": false, + "reservedResourceType": "VirtualMachineSoftware", + "skuDescription": "Sku description", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "Off", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "mock_sku" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ] + } + } + }, + "operationId": "Reservations_ListByBillingAccount", + "title": "reservationsListByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsListByBillingProfile.json new file mode 100644 index 000000000000..4996fa1842a8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/reservationsListByBillingProfile.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "$filter": "properties/reservedResourceType eq 'VirtualMachineSoftware'", + "$orderby": "properties/userFriendlyAppliedScopeType asc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "AAAA-AAAA-AAA-AAA", + "refreshsummary": "true", + "selectedState": "Succeeded" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "summary": { + "cancelledCount": 0, + "expiredCount": 0, + "expiringCount": 0, + "failedCount": 0, + "noBenefitCount": 0, + "pendingCount": 0, + "processingCount": 0, + "succeededCount": 1, + "warningCount": 0 + }, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", + "location": "global", + "properties": { + "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", + "displayName": "VirtualMachineSoftware_01-18-2022_13-51", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "0001-01-01T00:00:00Z", + "expiryDate": "2025-01-18", + "expiryDateTime": "2025-01-18T21:54:31.0741034Z", + "instanceFlexibility": "On", + "lastUpdatedDateTime": "0001-01-01T00:00:00.0000000", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDate": "2022-01-18", + "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", + "quantity": 1, + "renew": false, + "reservedResourceType": "VirtualMachineSoftware", + "skuDescription": "Sku description", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "Off", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "mock_sku" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ] + } + } + }, + "operationId": "Reservations_ListByBillingProfile", + "title": "ReservationsListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByBillingAccount.json new file mode 100644 index 000000000000..db7ea4bc75d5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByBillingAccount.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_ResolveByBillingAccount", + "title": "ResolveBillingRoleAssignmentByBillingAccount" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByBillingProfile.json new file mode 100644 index 000000000000..428ab7756d75 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByBillingProfile.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_ResolveByBillingProfile", + "title": "ResolveBillingRoleAssignmentByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByCustomer.json new file mode 100644 index 000000000000..38425a32ec60 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByCustomer.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "c360d6f1-2709-476d-81bb-d075b213d9fc", + "principalTenantName": "Foo Bar", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "userEmailAddress": "foo@bar.com" + } + }, + { + "name": "30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "c360d6f1-2709-476d-81bb-d075b213d9fc", + "principalTenantName": "Foo Bar", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "userEmailAddress": "foo@bar.com" + } + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_ResolveByCustomer", + "title": "ResolveBillingRoleAssignmentByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByInvoiceSection.json new file mode 100644 index 000000000000..0ea5110510cd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/resolveBillingRoleAssignmentByInvoiceSection.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } + }, + { + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + }, + "operationId": "BillingRoleAssignments_ResolveByInvoiceSection", + "title": "ResolveBillingRoleAssignmentByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanGetByBillingAccount.json new file mode 100644 index 000000000000..5de5877a9ef2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanGetByBillingAccount.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "properties": { + "appliedScopeProperties": { + "displayName": "TestRg", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "70000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2022-11-16T02:25:11.7183866Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP1", + "displayProvisioningState": "NoBenefit", + "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", + "expiryDateTime": "2025-11-16T02:25:11.7183866Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDateTime": "2022-11-16T02:23:21.3864783Z", + "renew": false, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "SavingsPlans_GetByBillingAccount", + "title": "SavingsPlanGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanGetExpandRenewPropertiesByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanGetExpandRenewPropertiesByBillingAccount.json new file mode 100644 index 000000000000..b9801fd6aa7e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanGetExpandRenewPropertiesByBillingAccount.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "$expand": "renewProperties", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "properties": { + "appliedScopeProperties": { + "displayName": "TestRg", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "70000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2022-11-16T02:25:11.7183866Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP1", + "displayProvisioningState": "NoBenefit", + "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", + "expiryDateTime": "2025-11-16T02:25:11.7183866Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDateTime": "2022-11-16T02:23:21.3864783Z", + "renew": false, + "renewProperties": { + "purchaseProperties": { + "properties": { + "appliedScopeProperties": { + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "70000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP1_renewed", + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" + } + } + }, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "SavingsPlans_GetByBillingAccount", + "title": "SavingsPlanGetExpandRenewProperties" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderExpandedScheduleGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderExpandedScheduleGetByBillingAccount.json new file mode 100644 index 000000000000..3052121a97fc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderExpandedScheduleGetByBillingAccount.json @@ -0,0 +1,344 @@ +{ + "parameters": { + "$expand": "schedule", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", + "properties": { + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP1", + "expiryDateTime": "2026-01-20T02:36:22.3394755Z", + "planInformation": { + "nextPaymentDueDate": "2023-02-20", + "pricingCurrencyTotal": { + "amount": 26.28, + "currencyCode": "USD" + }, + "startDate": "2023-01-20", + "transactions": [ + { + "billingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "dueDate": "2023-01-20", + "paymentDate": "2023-01-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Completed" + }, + { + "dueDate": "2023-02-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-03-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-04-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-05-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-06-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-07-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-08-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-09-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-10-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-11-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-12-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-01-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-02-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-03-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-04-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-05-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-06-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-07-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-08-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-09-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-10-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-11-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-12-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-01-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-02-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-03-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-04-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-05-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-06-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-07-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-08-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-09-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-10-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-11-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-12-20", + "pricingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, + "status": "Scheduled" + } + ] + }, + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" + ], + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "SavingsPlanOrders_GetByBillingAccount", + "title": "SavingsPlanOrderWithExpandedPaymentsGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderGetByBillingAccount.json new file mode 100644 index 000000000000..c14582949bf4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderGetByBillingAccount.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", + "properties": { + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP1", + "expiryDateTime": "2026-01-20T02:36:22.3394755Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" + ], + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "SavingsPlanOrders_GetByBillingAccount", + "title": "SavingsPlanOrderGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderListByBillingAccount.json new file mode 100644 index 000000000000..6c08b5c6ab70 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanOrderListByBillingAccount.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "$filter": "properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD'", + "$orderby": "properties/displayName asc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", + "properties": { + "benefitStartTime": "2023-02-04T03:18:31.3072635Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP1", + "expiryDateTime": "2026-02-04T03:18:31.3072635Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" + ], + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + { + "name": "20000000-0000-0000-0000-000000000001", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001", + "properties": { + "benefitStartTime": "2023-02-04T03:22:19.7304330Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP2", + "expiryDateTime": "2026-02-04T03:22:19.7304330Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001" + ], + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ] + } + } + }, + "operationId": "SavingsPlanOrders_ListByBillingAccount", + "title": "SavingsPlanOrderList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanUpdateByBillingAccount.json new file mode 100644 index 000000000000..95c82013e2dc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanUpdateByBillingAccount.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "body": { + "properties": { + "appliedScopeProperties": { + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1", + "tenantId": "80000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "displayName": "sp_newName", + "renew": true, + "renewProperties": { + "purchaseProperties": { + "properties": { + "appliedScopeProperties": { + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1", + "tenantId": "80000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "billingPlan": "P1M", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "sp_newName_renewed", + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" + } + } + } + } + }, + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "properties": { + "appliedScopeProperties": { + "displayName": "mg1", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1", + "tenantId": "80000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2023-02-04T03:18:31.3072635Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "sp_newName", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2023-02-04T04:30:49.1982989Z", + "expiryDateTime": "2026-02-04T03:18:31.3072635Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDateTime": "2023-02-04T03:16:38.9065505Z", + "renew": true, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", + "utilization": { + "aggregates": [] + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01", + "Retry-After": 120 + } + } + }, + "operationId": "SavingsPlans_UpdateByBillingAccount", + "title": "SavingsPlanUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanValidateUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanValidateUpdateByBillingAccount.json new file mode 100644 index 000000000000..8c3893ecb261 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlanValidateUpdateByBillingAccount.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "body": { + "benefits": [ + { + "appliedScopeProperties": { + "subscriptionId": "/subscriptions/50000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "Single" + } + ] + }, + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "benefits": [ + { + "valid": true + } + ] + } + } + }, + "operationId": "SavingsPlans_ValidateUpdateByBillingAccount", + "title": "SavingsPlanValidateUpdate" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlansListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlansListByBillingAccount.json new file mode 100644 index 000000000000..41bd8ffb8e75 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlansListByBillingAccount.json @@ -0,0 +1,277 @@ +{ + "parameters": { + "$filter": "properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD'", + "$orderby": "properties/displayName asc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "refreshSummary": "true", + "selectedState": "Succeeded", + "take": "3" + }, + "responses": { + "200": { + "body": { + "summary": { + "cancelledCount": 0, + "expiredCount": 0, + "expiringCount": 0, + "failedCount": 0, + "noBenefitCount": 0, + "pendingCount": 0, + "processingCount": 0, + "succeededCount": 3, + "warningCount": 0 + }, + "value": [ + { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "properties": { + "appliedScopeType": "Shared", + "benefitStartTime": "2022-12-16T02:17:03.7396152Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 10, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP1", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2022-12-16T02:17:04.9896661Z", + "expiryDateTime": "2023-12-16T02:17:03.7396152Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDateTime": "2022-12-16T02:14:58.2304134Z", + "renew": false, + "term": "P1Y", + "userFriendlyAppliedScopeType": "Shared", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + { + "name": "30000000-0000-0000-0000-000000000001", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001", + "properties": { + "appliedScopeProperties": { + "displayName": "TestRg", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "50000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2022-12-16T02:22:22.7254795Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 10, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP2", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2022-12-16T02:22:24.5536191Z", + "expiryDateTime": "2023-12-16T02:22:22.7254795Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDateTime": "2022-12-16T02:20:23.4733076Z", + "renew": false, + "term": "P1Y", + "userFriendlyAppliedScopeType": "ManagementGroup", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + { + "name": "30000000-0000-0000-0000-000000000002", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002", + "properties": { + "appliedScopeProperties": { + "displayName": "Azure subscription 1", + "subscriptionId": "/subscriptions/10000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "Single", + "benefitStartTime": "2022-10-14T21:18:55.2960613Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.025, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP3", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2022-11-07T23:54:43.8233243Z", + "expiryDateTime": "2025-10-14T21:18:55.2960613Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDateTime": "2022-10-14T21:16:57.2347688Z", + "renew": true, + "term": "P3Y", + "userFriendlyAppliedScopeType": "Single", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 66, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 66, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 65.52, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + { + "name": "30000000-0000-0000-0000-000000000003", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003", + "properties": { + "appliedScopeProperties": { + "displayName": "testRG", + "resourceGroupId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG" + }, + "appliedScopeType": "Single", + "benefitStartTime": "2022-11-08T00:00:06.3636747Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP4", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2022-11-30T21:18:12.1967323Z", + "expiryDateTime": "2025-11-08T00:00:06.3636747Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "purchaseDateTime": "2022-11-07T23:57:58.2428677Z", + "renew": false, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ResourceGroup", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 100, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 100, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 100, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ] + } + } + }, + "operationId": "SavingsPlans_ListByBillingAccount", + "title": "SavingsPlansList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlansListBySavingsPlanOrders.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlansListBySavingsPlanOrders.json new file mode 100644 index 000000000000..6a94ca08ab21 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/savingsPlansListBySavingsPlanOrders.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "properties": { + "appliedScopeType": "Shared", + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP1", + "displayProvisioningState": "Succeeded", + "effectiveDateTime": "2023-01-20T02:36:25.0894669Z", + "expiryDateTime": "2026-01-20T02:36:22.3394755Z", + "provisioningState": "Succeeded", + "purchaseDateTime": "2023-01-20T02:34:38.1261695Z", + "renew": false, + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "utilization": { + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Compute_Savings_Plan" + } + } + ] + } + } + }, + "operationId": "SavingsPlans_ListBySavingsPlanOrder", + "title": "SavingsPlansInOrderList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionSummaryGetByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionSummaryGetByInvoice.json new file mode 100644 index 000000000000..e8a13d48735e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionSummaryGetByInvoice.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "azureCreditApplied": 100, + "billingCurrency": "USD", + "consumptionCommitmentDecremented": 1000, + "subTotal": 1000, + "tax": 500, + "total": 5400 + } + } + }, + "operationId": "Transactions_GetTransactionSummaryByInvoice", + "title": "TransactionSummaryGetByInvoice" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsDownloadByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsDownloadByInvoice.json new file mode 100644 index 000000000000..432ca7dc39f5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsDownloadByInvoice.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724_invoice.csv?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/transactionsDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + }, + "operationId": "Transactions_TransactionsDownloadByInvoice", + "title": "TransactionsDownloadByInvoice" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByBillingProfile.json new file mode 100644 index 000000000000..78e8d1dee2cf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByBillingProfile.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "type": "Billed", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "filter": "properties/date gt '2020-10-01'", + "orderby": "properties/date", + "periodEndDate": "2023-05-30", + "periodStartDate": "2024-04-01", + "search": "storage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 11.25 + } + }, + { + "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 1.25 + } + } + ] + } + } + }, + "operationId": "Transactions_ListByBillingProfile", + "title": "TransactionsListByBillingProfile" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByCustomer.json new file mode 100644 index 000000000000..9f971fd6c7c0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByCustomer.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "type": "Billed", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "22000000-0000-0000-0000-000000000000", + "filter": "properties/date gt '2020-10-01'", + "orderby": "properties/date", + "periodEndDate": "2023-05-30", + "periodStartDate": "2024-04-01", + "search": "storage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "customerDisplayName": "Contoso operations customer", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22000000-0000-0000-0000-000000000000", + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 11.25 + } + }, + { + "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "customerDisplayName": "Contoso operations customer", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22000000-0000-0000-0000-000000000000", + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 1.25 + } + } + ] + } + } + }, + "operationId": "Transactions_ListByCustomer", + "title": "TransactionsListByCustomer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByInvoice.json new file mode 100644 index 000000000000..f326874a02bd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByInvoice.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 11.25 + } + }, + { + "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 1.25 + } + } + ] + } + } + }, + "operationId": "Transactions_ListByInvoice", + "title": "TransactionsListByInvoice" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByInvoiceSection.json new file mode 100644 index 000000000000..098d1266cdae --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transactionsListByInvoiceSection.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "type": "Billed", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "filter": "properties/date gt '2020-10-01'", + "invoiceSectionName": "22000000-0000-0000-0000-000000000000", + "orderby": "properties/date", + "periodEndDate": "2023-05-30", + "periodStartDate": "2024-04-01", + "search": "storage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 11.25 + } + }, + { + "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productType": "VM Instance", + "productTypeId": "A12345", + "quantity": 1, + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute", + "units": 1.25 + } + } + ] + } + } + }, + "operationId": "Transactions_ListByInvoiceSection", + "title": "TransactionsListByInvoiceSection" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersCancel.json new file mode 100644 index 000000000000..99f39d511ec3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersCancel.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "properties": { + "canceledBy": "user@contoso.com", + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" + } + } + } + }, + "operationId": "Transfers_Cancel", + "title": "TransferCancel" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersGet.json new file mode 100644 index 000000000000..545e6330836a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "properties": { + "detailedTransferStatus": [ + { + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "productType": "AzureSubscription", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productId": "reservedInstanceId", + "productName": "Reservation name", + "productType": "AzureReservation", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" + } + } + } + }, + "operationId": "Transfers_Get", + "title": "TransferGet" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersInitiate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersInitiate.json new file mode 100644 index 000000000000..3ff6ccdda827 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersInitiate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "parameters": { + "properties": { + "recipientEmailId": "user@contoso.com" + } + }, + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" + } + } + }, + "201": { + "body": { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" + } + } + } + }, + "operationId": "Transfers_Initiate", + "title": "InitiateTransfer" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersList.json new file mode 100644 index 000000000000..b2ad4f7cd05f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/examples/2024-04-01/transfersList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "properties": { + "detailedTransferStatus": [ + { + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "productType": "AzureSubscription", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productId": "reservedInstanceId", + "productName": "Reservation name", + "productType": "AzureReservation", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" + } + } + ] + } + } + }, + "operationId": "Transfers_List", + "title": "TransfersList" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/main.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/main.tsp new file mode 100644 index 000000000000..a2b0405bd4bc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/main.tsp @@ -0,0 +1,95 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Parameters used: + * isFullCompatible: true + * guessResourceKey: false + * Version: 0.11.12 + * Date: 2026-02-01T07:26:21.551Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./back-compatible.tsp"; +import "./Agreement.tsp"; +import "./AssociatedTenant.tsp"; +import "./AvailableBalance.tsp"; +import "./BillingAccount.tsp"; +import "./BillingProfile.tsp"; +import "./BillingProperty.tsp"; +import "./BillingRequest.tsp"; +import "./BillingRoleAssignment.tsp"; +import "./BillingRoleDefinition.tsp"; +import "./SavingsPlanOrderModel.tsp"; +import "./SavingsPlanModel.tsp"; +import "./BillingSubscription.tsp"; +import "./BillingSubscriptionAlias.tsp"; +import "./Customer.tsp"; +import "./Department.tsp"; +import "./EnrollmentAccount.tsp"; +import "./Invoice.tsp"; +import "./InvoiceSection.tsp"; +import "./PaymentMethodLink.tsp"; +import "./PaymentMethod.tsp"; +import "./CustomerPolicy.tsp"; +import "./BillingProfilePolicy.tsp"; +import "./BillingAccountPolicy.tsp"; +import "./SubscriptionPolicy.tsp"; +import "./Product.tsp"; +import "./Reservation.tsp"; +import "./ReservationOrder.tsp"; +import "./TransferDetails.tsp"; +import "./PartnerTransferDetails.tsp"; +import "./RecipientTransferDetails.tsp"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.OpenAPI; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * Documentation for Microsoft.Billing. + */ +@armProviderNamespace +@service(#{ title: "BillingManagementClient" }) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.Billing; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2024-04-01 API version. + */ + v2024_04_01: "2024-04-01", +} + +// interface Operations extends Azure.ResourceManager.Operations { +// #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +// @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") +// list is Azure.ResourceManager.Operations.list; +// } + +interface Operations { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("ArmOperations") + @autoRoute + @doc("List of operations supported by provider.") + @segment("operations") + @get + @list + list( + ...ApiVersionParameter, + ...Azure.ResourceManager.Legacy.Provider, + ): ArmResponse | Azure.ResourceManager.ErrorResponse; +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/models.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/models.tsp new file mode 100644 index 000000000000..6f6299ab01dd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/models.tsp @@ -0,0 +1,9126 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.Core; +using Azure.ResourceManager.Foundations; + +namespace Microsoft.Billing; + +/** + * The mode of acceptance for an agreement. + */ +union AcceptanceMode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * ClickToAccept + */ + ClickToAccept: "ClickToAccept", + + /** + * ESignEmbedded + */ + ESignEmbedded: "ESignEmbedded", + + /** + * ESignOffline + */ + ESignOffline: "ESignOffline", + + /** + * Implicit + */ + Implicit: "Implicit", + + /** + * Offline + */ + Offline: "Offline", + + /** + * PhysicalSign + */ + PhysicalSign: "PhysicalSign", +} + +/** + * The category of the agreement. + */ +union Category { + string, + + /** + * Other + */ + Other: "Other", + + /** + * AffiliatePurchaseTerms + */ + AffiliatePurchaseTerms: "AffiliatePurchaseTerms", + + /** + * IndirectForGovernmentAgreement + */ + IndirectForGovernmentAgreement: "IndirectForGovernmentAgreement", + + /** + * MicrosoftCustomerAgreement + */ + MicrosoftCustomerAgreement: "MicrosoftCustomerAgreement", + + /** + * MicrosoftPartnerAgreement + */ + MicrosoftPartnerAgreement: "MicrosoftPartnerAgreement", + + /** + * UKCloudComputeFramework + */ + UKCloudComputeFramework: "UKCloudComputeFramework", +} + +/** + * The type of identity that created the resource. + */ +union CreatedByType { + string, + + /** + * User + */ + User: "User", + + /** + * Application + */ + Application: "Application", + + /** + * ManagedIdentity + */ + ManagedIdentity: "ManagedIdentity", + + /** + * Key + */ + Key: "Key", +} + +/** + * The provisioning state of the resource during a long-running operation. + */ +union ProvisioningState { + string, + + /** + * Succeeded + */ + Succeeded: "Succeeded", + + /** + * Canceled + */ + Canceled: "Canceled", + + /** + * Failed + */ + Failed: "Failed", + + /** + * New + */ + New: "New", + + /** + * Pending + */ + Pending: "Pending", + + /** + * Provisioning + */ + Provisioning: "Provisioning", + + /** + * PendingBilling + */ + PendingBilling: "PendingBilling", + + /** + * ConfirmedBilling + */ + ConfirmedBilling: "ConfirmedBilling", + + /** + * Creating + */ + Creating: "Creating", + + /** + * Created + */ + Created: "Created", + + /** + * Expired + */ + Expired: "Expired", +} + +/** + * 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. + */ +union BillingManagementTenantState { + string, + + /** + * Other + */ + Other: "Other", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", + + /** + * Active + */ + Active: "Active", + + /** + * Revoked + */ + Revoked: "Revoked", +} + +/** + * 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. + */ +union ProvisioningTenantState { + string, + + /** + * Other + */ + Other: "Other", + + /** + * NotRequested + */ + NotRequested: "NotRequested", + + /** + * Active + */ + Active: "Active", + + /** + * Pending + */ + Pending: "Pending", + + /** + * BillingRequestExpired + */ + BillingRequestExpired: "BillingRequestExpired", + + /** + * BillingRequestDeclined + */ + BillingRequestDeclined: "BillingRequestDeclined", + + /** + * Revoked + */ + Revoked: "Revoked", +} + +/** + * Payment on Account type. + */ +union PaymentMethodFamily { + string, + + /** + * Other + */ + Other: "Other", + + /** + * None + */ + None: "None", + + /** + * CreditCard + */ + CreditCard: "CreditCard", + + /** + * Credits + */ + Credits: "Credits", + + /** + * CheckWire + */ + CheckWire: "CheckWire", + + /** + * EWallet + */ + EWallet: "EWallet", + + /** + * TaskOrder + */ + TaskOrder: "TaskOrder", + + /** + * DirectDebit + */ + DirectDebit: "DirectDebit", +} + +/** + * The current status of the billing account. + */ +union AccountStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Active + */ + Active: "Active", + + /** + * UnderReview + */ + UnderReview: "UnderReview", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * Deleted + */ + Deleted: "Deleted", + + /** + * Extended + */ + Extended: "Extended", + + /** + * Pending + */ + Pending: "Pending", + + /** + * New + */ + New: "New", + + /** + * Expired + */ + Expired: "Expired", + + /** + * Terminated + */ + Terminated: "Terminated", + + /** + * Transferred + */ + Transferred: "Transferred", +} + +/** + * The type of customer. + */ +union AccountType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Enterprise + */ + Enterprise: "Enterprise", + + /** + * Individual + */ + Individual: "Individual", + + /** + * Partner + */ + Partner: "Partner", + + /** + * Reseller + */ + Reseller: "Reseller", + + /** + * ClassicPartner + */ + ClassicPartner: "ClassicPartner", + + /** + * Internal + */ + Internal: "Internal", + + /** + * Tenant + */ + Tenant: "Tenant", + + /** + * Business + */ + Business: "Business", +} + +/** + * The tier of the account. + */ +union AccountSubType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * None + */ + None: "None", + + /** + * Individual + */ + Individual: "Individual", + + /** + * Professional + */ + Professional: "Professional", + + /** + * Enterprise + */ + Enterprise: "Enterprise", +} + +/** + * Reason for the specified billing account status. + */ +union BillingAccountStatusReasonCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * UnusualActivity + */ + UnusualActivity: "UnusualActivity", + + /** + * ManuallyTerminated + */ + ManuallyTerminated: "ManuallyTerminated", + + /** + * Expired + */ + Expired: "Expired", + + /** + * Transferred + */ + Transferred: "Transferred", + + /** + * TerminateProcessing + */ + TerminateProcessing: "TerminateProcessing", +} + +/** + * The type of agreement. + */ +union AgreementType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * MicrosoftCustomerAgreement + */ + MicrosoftCustomerAgreement: "MicrosoftCustomerAgreement", + + /** + * EnterpriseAgreement + */ + EnterpriseAgreement: "EnterpriseAgreement", + + /** + * MicrosoftOnlineServicesProgram + */ + MicrosoftOnlineServicesProgram: "MicrosoftOnlineServicesProgram", + + /** + * MicrosoftPartnerAgreement + */ + MicrosoftPartnerAgreement: "MicrosoftPartnerAgreement", +} + +/** + * The billing account extension opted by the company. + */ +union ExtendedTermOption { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Opted-In + */ + `Opted-In`: "Opted-In", + + /** + * Opted-Out + */ + `Opted-Out`: "Opted-Out", +} + +/** + * The support level offer associated with an enrollment. + */ +union SupportLevel { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Standard + */ + Standard: "Standard", + + /** + * Pro-Direct + */ + `Pro-Direct`: "Pro-Direct", + + /** + * Developer + */ + Developer: "Developer", +} + +/** + * Markup status of enrollment, applicable only for indirect enrollments. + */ +union MarkupStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * Preview + */ + Preview: "Preview", + + /** + * Published + */ + Published: "Published", + + /** + * Locked + */ + Locked: "Locked", +} + +/** + * 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. + */ +union BillingRelationshipType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Direct + */ + Direct: "Direct", + + /** + * IndirectCustomer + */ + IndirectCustomer: "IndirectCustomer", + + /** + * IndirectPartner + */ + IndirectPartner: "IndirectPartner", + + /** + * CSPPartner + */ + CSPPartner: "CSPPartner", + + /** + * CSPCustomer + */ + CSPCustomer: "CSPCustomer", +} + +/** + * The type of the tax identifier. + */ +union TaxIdentifierType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * BrazilCcmId + */ + BrazilCcmId: "BrazilCcmId", + + /** + * BrazilCnpjId + */ + BrazilCnpjId: "BrazilCnpjId", + + /** + * BrazilCpfId + */ + BrazilCpfId: "BrazilCpfId", + + /** + * CanadianFederalExempt + */ + CanadianFederalExempt: "CanadianFederalExempt", + + /** + * CanadianProvinceExempt + */ + CanadianProvinceExempt: "CanadianProvinceExempt", + + /** + * ExternalTaxation + */ + ExternalTaxation: "ExternalTaxation", + + /** + * IndiaFederalTanId + */ + IndiaFederalTanId: "IndiaFederalTanId", + + /** + * IndiaFederalServiceTaxId + */ + IndiaFederalServiceTaxId: "IndiaFederalServiceTaxId", + + /** + * IndiaPanId + */ + IndiaPanId: "IndiaPanId", + + /** + * IndiaStateCstId + */ + IndiaStateCstId: "IndiaStateCstId", + + /** + * IndiaStateGstINId + */ + IndiaStateGstINId: "IndiaStateGstINId", + + /** + * IndiaStateVatId + */ + IndiaStateVatId: "IndiaStateVatId", + + /** + * IntlExempt + */ + IntlExempt: "IntlExempt", + + /** + * USExempt + */ + USExempt: "USExempt", + + /** + * VatId + */ + VatId: "VatId", + + /** + * LoveCode + */ + LoveCode: "LoveCode", + + /** + * MobileBarCode + */ + MobileBarCode: "MobileBarCode", + + /** + * NationalIdentificationNumber + */ + NationalIdentificationNumber: "NationalIdentificationNumber", + + /** + * PublicSectorId + */ + PublicSectorId: "PublicSectorId", +} + +/** + * The status of the tax identifier. + */ +union TaxIdentifierStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Valid + */ + Valid: "Valid", + + /** + * Invalid + */ + Invalid: "Invalid", +} + +/** + * The status of the billing profile. + */ +union BillingProfileStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Active + */ + Active: "Active", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * Warned + */ + Warned: "Warned", + + /** + * Deleted + */ + Deleted: "Deleted", + + /** + * UnderReview + */ + UnderReview: "UnderReview", +} + +/** + * Reason for the specified billing profile status. + */ +union BillingProfileStatusReasonCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * PastDue + */ + PastDue: "PastDue", + + /** + * UnusualActivity + */ + UnusualActivity: "UnusualActivity", + + /** + * SpendingLimitReached + */ + SpendingLimitReached: "SpendingLimitReached", + + /** + * SpendingLimitExpired + */ + SpendingLimitExpired: "SpendingLimitExpired", +} + +/** + * The billing profile spending limit. + */ +union SpendingLimit { + string, + + /** + * Off + */ + Off: "Off", + + /** + * On + */ + On: "On", +} + +/** + * Indicates the eligibility status of the payment terms. + */ +union PaymentTermsEligibilityStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Valid + */ + Valid: "Valid", + + /** + * Invalid + */ + Invalid: "Invalid", +} + +/** + * Indicates the reason for the ineligibility of the payment terms. + */ +union PaymentTermsEligibilityCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * OverlappingPaymentTerms + */ + OverlappingPaymentTerms: "OverlappingPaymentTerms", + + /** + * InvalidDateFormat + */ + InvalidDateFormat: "InvalidDateFormat", + + /** + * InvalidDateRange + */ + InvalidDateRange: "InvalidDateRange", + + /** + * InactiveBillingAccount + */ + InactiveBillingAccount: "InactiveBillingAccount", + + /** + * InvalidBillingAccountType + */ + InvalidBillingAccountType: "InvalidBillingAccountType", + + /** + * NullOrEmptyPaymentTerms + */ + NullOrEmptyPaymentTerms: "NullOrEmptyPaymentTerms", + + /** + * BillingAccountNotFound + */ + BillingAccountNotFound: "BillingAccountNotFound", + + /** + * IneligibleBillingAccountStatus + */ + IneligibleBillingAccountStatus: "IneligibleBillingAccountStatus", + + /** + * InvalidTerms + */ + InvalidTerms: "InvalidTerms", +} + +/** + * Status of the address validation. + */ +union AddressValidationStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Valid + */ + Valid: "Valid", + + /** + * Invalid + */ + Invalid: "Invalid", +} + +/** + * Access Decision, specifies access is allowed or not. + */ +union AccessDecision { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * Status describing if billing profile is eligible to be deleted. + */ +union DeleteBillingProfileEligibilityStatus { + string, + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * Code of the delete invoice section eligibility response. + */ +union DeleteBillingProfileEligibilityCode { + string, + + /** + * None + */ + None: "None", + + /** + * ActiveCredits + */ + ActiveCredits: "ActiveCredits", + + /** + * ActiveCreditCard + */ + ActiveCreditCard: "ActiveCreditCard", + + /** + * LastBillingProfile + */ + LastBillingProfile: "LastBillingProfile", + + /** + * NotSupported + */ + NotSupported: "NotSupported", + + /** + * OutstandingCharges + */ + OutstandingCharges: "OutstandingCharges", + + /** + * PendingCharges + */ + PendingCharges: "PendingCharges", + + /** + * ReservedInstances + */ + ReservedInstances: "ReservedInstances", + + /** + * ActiveBillingSubscriptions + */ + ActiveBillingSubscriptions: "ActiveBillingSubscriptions", +} + +/** + * The type of spending limit. + */ +union SpendingLimitType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * None + */ + None: "None", + + /** + * FreeAccount + */ + FreeAccount: "FreeAccount", + + /** + * Sandbox + */ + Sandbox: "Sandbox", + + /** + * AzureForStudents + */ + AzureForStudents: "AzureForStudents", + + /** + * AcademicSponsorship + */ + AcademicSponsorship: "AcademicSponsorship", + + /** + * AzureConsumptionCredit + */ + AzureConsumptionCredit: "AzureConsumptionCredit", + + /** + * AzurePassSponsorship + */ + AzurePassSponsorship: "AzurePassSponsorship", + + /** + * MpnSponsorship + */ + MpnSponsorship: "MpnSponsorship", + + /** + * MSDN + */ + MSDN: "MSDN", + + /** + * NonProfitSponsorship + */ + NonProfitSponsorship: "NonProfitSponsorship", + + /** + * Sponsorship + */ + Sponsorship: "Sponsorship", + + /** + * StartupSponsorship + */ + StartupSponsorship: "StartupSponsorship", + + /** + * AzureForStudentsStarter + */ + AzureForStudentsStarter: "AzureForStudentsStarter", + + /** + * VisualStudio + */ + VisualStudio: "VisualStudio", +} + +/** + * The status of current spending limit. + */ +union SpendingLimitStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * None + */ + None: "None", + + /** + * Active + */ + Active: "Active", + + /** + * Expired + */ + Expired: "Expired", + + /** + * LimitReached + */ + LimitReached: "LimitReached", + + /** + * LimitRemoved + */ + LimitRemoved: "LimitRemoved", +} + +/** + * Identifies the status of an customer. This is an upcoming property that will be populated in the future. + */ +union CustomerStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Active + */ + Active: "Active", + + /** + * Pending + */ + Pending: "Pending", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * Warned + */ + Warned: "Warned", + + /** + * Deleted + */ + Deleted: "Deleted", + + /** + * UnderReview + */ + UnderReview: "UnderReview", +} + +/** + * Identifies the status of an invoice section. + */ +union InvoiceSectionState { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Active + */ + Active: "Active", + + /** + * Deleted + */ + Deleted: "Deleted", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * UnderReview + */ + UnderReview: "UnderReview", + + /** + * Warned + */ + Warned: "Warned", + + /** + * Restricted + */ + Restricted: "Restricted", +} + +/** + * Reason for the specified invoice section status. + */ +union InvoiceSectionStateReasonCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * PastDue + */ + PastDue: "PastDue", + + /** + * UnusualActivity + */ + UnusualActivity: "UnusualActivity", + + /** + * SpendingLimitReached + */ + SpendingLimitReached: "SpendingLimitReached", + + /** + * SpendingLimitExpired + */ + SpendingLimitExpired: "SpendingLimitExpired", +} + +/** + * The subscription status. + */ +union BillingSubscriptionStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Unknown + */ + Unknown: "Unknown", + + /** + * Active + */ + Active: "Active", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * Deleted + */ + Deleted: "Deleted", + + /** + * Warned + */ + Warned: "Warned", + + /** + * Expiring + */ + Expiring: "Expiring", + + /** + * Expired + */ + Expired: "Expired", + + /** + * AutoRenew + */ + AutoRenew: "AutoRenew", + + /** + * Cancelled + */ + Cancelled: "Cancelled", + + /** + * Suspended + */ + Suspended: "Suspended", + + /** + * Failed + */ + Failed: "Failed", +} + +/** + * The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. + */ +union SubscriptionStatusReason { + string, + + /** + * None + */ + None: "None", + + /** + * Cancelled + */ + Cancelled: "Cancelled", + + /** + * PastDue + */ + PastDue: "PastDue", + + /** + * SuspiciousActivity + */ + SuspiciousActivity: "SuspiciousActivity", + + /** + * Other + */ + Other: "Other", + + /** + * Transferred + */ + Transferred: "Transferred", + + /** + * PolicyViolation + */ + PolicyViolation: "PolicyViolation", + + /** + * SpendingLimitReached + */ + SpendingLimitReached: "SpendingLimitReached", + + /** + * Expired + */ + Expired: "Expired", +} + +/** + * The type of billing subscription. + */ +union SubscriptionBillingType { + string, + + /** + * None + */ + None: "None", + + /** + * Benefit + */ + Benefit: "Benefit", + + /** + * Free + */ + Free: "Free", + + /** + * Paid + */ + Paid: "Paid", + + /** + * PrePaid + */ + PrePaid: "PrePaid", +} + +/** + * The Azure workload type of the subscription. + */ +union SubscriptionWorkloadType { + string, + + /** + * None + */ + None: "None", + + /** + * Production + */ + Production: "Production", + + /** + * DevTest + */ + DevTest: "DevTest", + + /** + * Internal + */ + Internal: "Internal", +} + +/** + * Status of billing request. + */ +union BillingRequestStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Pending + */ + Pending: "Pending", + + /** + * Approved + */ + Approved: "Approved", + + /** + * Declined + */ + Declined: "Declined", + + /** + * Cancelled + */ + Cancelled: "Cancelled", + + /** + * Completed + */ + Completed: "Completed", + + /** + * Expired + */ + Expired: "Expired", +} + +/** + * Type of billing request. + */ +union BillingRequestType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * InvoiceAccess + */ + InvoiceAccess: "InvoiceAccess", + + /** + * ProvisioningAccess + */ + ProvisioningAccess: "ProvisioningAccess", + + /** + * RoleAssignment + */ + RoleAssignment: "RoleAssignment", + + /** + * UpdateBillingPolicy + */ + UpdateBillingPolicy: "UpdateBillingPolicy", +} + +/** + * The type of a role Assignment. + */ +union PrincipalType { + string, + + /** + * Unknown + */ + Unknown: "Unknown", + + /** + * None + */ + None: "None", + + /** + * User + */ + User: "User", + + /** + * Group + */ + Group: "Group", + + /** + * DirectoryRole + */ + DirectoryRole: "DirectoryRole", + + /** + * ServicePrincipal + */ + ServicePrincipal: "ServicePrincipal", + + /** + * Everyone + */ + Everyone: "Everyone", +} + +/** + * Represents the Savings plan term in ISO 8601 format. + */ +union SavingsPlanTerm { + string, + + /** + * P1Y + */ + P1Y: "P1Y", + + /** + * P3Y + */ + P3Y: "P3Y", + + /** + * P5Y + */ + P5Y: "P5Y", +} + +/** + * Represents the billing plan in ISO 8601 format. Required only for monthly purchases. + */ +union BillingPlan { + string, + + /** + * P1M + */ + P1M: "P1M", +} + +/** + * Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future. + */ +union PaymentStatus { + string, + + /** + * Succeeded + */ + Succeeded: "Succeeded", + + /** + * Failed + */ + Failed: "Failed", + + /** + * Scheduled + */ + Scheduled: "Scheduled", + + /** + * Cancelled + */ + Cancelled: "Cancelled", + + /** + * Completed + */ + Completed: "Completed", + + /** + * Pending + */ + Pending: "Pending", +} + +/** + * Type of the Applied Scope. + */ +union AppliedScopeType { + string, + + /** + * Single + */ + Single: "Single", + + /** + * Shared + */ + Shared: "Shared", + + /** + * ManagementGroup + */ + ManagementGroup: "ManagementGroup", +} + +/** + * Commitment grain. + */ +union CommitmentGrain { + string, + + /** + * Hourly + */ + Hourly: "Hourly", +} + +/** + * Indicates whether auto renewal is turned on or off for a product. + */ +union AutoRenew { + string, + + /** + * Off + */ + Off: "Off", + + /** + * On + */ + On: "On", +} + +/** + * The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. + */ +union SubscriptionEnrollmentAccountStatus { + string, + + /** + * Active + */ + Active: "Active", + + /** + * Cancelled + */ + Cancelled: "Cancelled", + + /** + * Expired + */ + Expired: "Expired", + + /** + * Deleted + */ + Deleted: "Deleted", + + /** + * TransferredOut + */ + TransferredOut: "TransferredOut", + + /** + * Transferring + */ + Transferring: "Transferring", + + /** + * Inactive + */ + Inactive: "Inactive", +} + +/** + * The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. + */ +union Cancellation { + string, + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", + + /** + * Allowed + */ + Allowed: "Allowed", +} + +/** + * 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. + */ +union BillingSubscriptionOperationStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * None + */ + None: "None", + + /** + * LockedForUpdate + */ + LockedForUpdate: "LockedForUpdate", +} + +/** + * Cancellation reason. + */ +union CancellationReason { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Compromise + */ + Compromise: "Compromise", + + /** + * Dispute + */ + Dispute: "Dispute", +} + +/** + * Error code of the transfer validation response. + */ +union SubscriptionTransferValidationErrorCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * BillingAccountInactive + */ + BillingAccountInactive: "BillingAccountInactive", + + /** + * DestinationBillingProfileInactive + */ + DestinationBillingProfileInactive: "DestinationBillingProfileInactive", + + /** + * DestinationBillingProfileNotFound + */ + DestinationBillingProfileNotFound: "DestinationBillingProfileNotFound", + + /** + * DestinationBillingProfilePastDue + */ + DestinationBillingProfilePastDue: "DestinationBillingProfilePastDue", + + /** + * DestinationInvoiceSectionInactive + */ + DestinationInvoiceSectionInactive: "DestinationInvoiceSectionInactive", + + /** + * DestinationInvoiceSectionNotFound + */ + DestinationInvoiceSectionNotFound: "DestinationInvoiceSectionNotFound", + + /** + * InsufficientPermissionOnDestination + */ + InsufficientPermissionOnDestination: "InsufficientPermissionOnDestination", + + /** + * InsufficientPermissionOnSource + */ + InsufficientPermissionOnSource: "InsufficientPermissionOnSource", + + /** + * InvalidDestination + */ + InvalidDestination: "InvalidDestination", + + /** + * InvalidSource + */ + InvalidSource: "InvalidSource", + + /** + * MarketplaceNotEnabledOnDestination + */ + MarketplaceNotEnabledOnDestination: "MarketplaceNotEnabledOnDestination", + + /** + * ProductInactive + */ + ProductInactive: "ProductInactive", + + /** + * ProductNotFound + */ + ProductNotFound: "ProductNotFound", + + /** + * ProductTypeNotSupported + */ + ProductTypeNotSupported: "ProductTypeNotSupported", + + /** + * SourceBillingProfilePastDue + */ + SourceBillingProfilePastDue: "SourceBillingProfilePastDue", + + /** + * SourceInvoiceSectionInactive + */ + SourceInvoiceSectionInactive: "SourceInvoiceSectionInactive", + + /** + * AccountIsLocked + */ + AccountIsLocked: "AccountIsLocked", + + /** + * AssetHasCap + */ + AssetHasCap: "AssetHasCap", + + /** + * AssetNotActive + */ + AssetNotActive: "AssetNotActive", + + /** + * BillingProfilePastDue + */ + BillingProfilePastDue: "BillingProfilePastDue", + + /** + * CrossBillingAccountNotAllowed + */ + CrossBillingAccountNotAllowed: "CrossBillingAccountNotAllowed", + + /** + * NoActiveAzurePlan + */ + NoActiveAzurePlan: "NoActiveAzurePlan", + + /** + * None + */ + None: "None", + + /** + * SubscriptionNotActive + */ + SubscriptionNotActive: "SubscriptionNotActive", + + /** + * SubscriptionHasReservations + */ + SubscriptionHasReservations: "SubscriptionHasReservations", + + /** + * SubscriptionTypeNotSupported + */ + SubscriptionTypeNotSupported: "SubscriptionTypeNotSupported", + + /** + * InvoiceSectionIsRestricted + */ + InvoiceSectionIsRestricted: "InvoiceSectionIsRestricted", +} + +/** + * The type of the document. + */ +union InvoiceDocumentType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Invoice + */ + Invoice: "Invoice", + + /** + * VoidNote + */ + VoidNote: "VoidNote", + + /** + * TaxReceipt + */ + TaxReceipt: "TaxReceipt", + + /** + * CreditNote + */ + CreditNote: "CreditNote", + + /** + * Summary + */ + Summary: "Summary", + + /** + * Transactions + */ + Transactions: "Transactions", +} + +/** + * The source of the document. ENF for Brazil and DRS for rest of the world. + */ +union DocumentSource { + string, + + /** + * Other + */ + Other: "Other", + + /** + * DRS + */ + DRS: "DRS", + + /** + * ENF + */ + ENF: "ENF", +} + +/** + * The reason that the payment failed. + */ +union FailedPaymentReason { + string, + + /** + * Other + */ + Other: "Other", + + /** + * BankDeclined + */ + BankDeclined: "BankDeclined", + + /** + * CardExpired + */ + CardExpired: "CardExpired", + + /** + * IncorrectCardDetails + */ + IncorrectCardDetails: "IncorrectCardDetails", +} + +/** + * Invoice type. + */ +union InvoiceType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * AzureServices + */ + AzureServices: "AzureServices", + + /** + * AzureMarketplace + */ + AzureMarketplace: "AzureMarketplace", + + /** + * AzureSupport + */ + AzureSupport: "AzureSupport", +} + +/** + * The current status of the invoice. + */ +union InvoiceStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Due + */ + Due: "Due", + + /** + * OverDue + */ + OverDue: "OverDue", + + /** + * Paid + */ + Paid: "Paid", + + /** + * Void + */ + Void: "Void", + + /** + * Locked + */ + Locked: "Locked", +} + +/** + * Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. + */ +union SpecialTaxationType { + string, + + /** + * SubtotalLevel + */ + SubtotalLevel: "SubtotalLevel", + + /** + * InvoiceLevel + */ + InvoiceLevel: "InvoiceLevel", +} + +/** + * The status of refund request. + */ +union RefundStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Pending + */ + Pending: "Pending", + + /** + * Approved + */ + Approved: "Approved", + + /** + * Declined + */ + Declined: "Declined", + + /** + * Cancelled + */ + Cancelled: "Cancelled", + + /** + * Completed + */ + Completed: "Completed", + + /** + * Expired + */ + Expired: "Expired", +} + +/** + * The reason for refund. + */ +union RefundReasonCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * AccidentalConversion + */ + AccidentalConversion: "AccidentalConversion", + + /** + * UnclearPricing + */ + UnclearPricing: "UnclearPricing", + + /** + * AccidentalPurchase + */ + AccidentalPurchase: "AccidentalPurchase", + + /** + * ForgotToCancel + */ + ForgotToCancel: "ForgotToCancel", + + /** + * UnclearDocumentation + */ + UnclearDocumentation: "UnclearDocumentation", +} + +/** + * Status describing if invoice section is eligible to be deleted. + */ +union DeleteInvoiceSectionEligibilityStatus { + string, + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * Code for the delete invoice section validation. + */ +union DeleteInvoiceSectionEligibilityCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * LastInvoiceSection + */ + LastInvoiceSection: "LastInvoiceSection", + + /** + * ActiveAzurePlans + */ + ActiveAzurePlans: "ActiveAzurePlans", + + /** + * ReservedInstances + */ + ReservedInstances: "ReservedInstances", + + /** + * ActiveBillingSubscriptions + */ + ActiveBillingSubscriptions: "ActiveBillingSubscriptions", +} + +/** + * Status of the payment method. + */ +union PaymentMethodStatus { + string, + + /** + * active + */ + active: "active", + + /** + * inactive + */ + inactive: "inactive", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ServiceDefinedResourceName { + string, + + /** + * default + */ + default: "default", +} + +/** + * The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. + */ +union ViewChargesPolicy { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * The type of the policy. + */ +union PolicyType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * UserControlled + */ + UserControlled: "UserControlled", + + /** + * SystemControlled + */ + SystemControlled: "SystemControlled", +} + +/** + * The state showing the enrollment auth level. + */ +union EnrollmentAuthLevelState { + string, + + /** + * Other + */ + Other: "Other", + + /** + * MicrosoftAccountOnly + */ + MicrosoftAccountOnly: "MicrosoftAccountOnly", + + /** + * MixedAccount + */ + MixedAccount: "MixedAccount", + + /** + * OrganizationalAccountCrossTenant + */ + OrganizationalAccountCrossTenant: "OrganizationalAccountCrossTenant", + + /** + * OrganizationalAccountOnly + */ + OrganizationalAccountOnly: "OrganizationalAccountOnly", +} + +/** + * The policy that controls whether account owner can view charges. + */ +union EnrollmentAccountOwnerViewCharges { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * The policy that controls whether department admin can view charges. + */ +union EnrollmentDepartmentAdminViewCharges { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * The policy that controls invoice section label management at invoice section scope. This is allowed by default. + */ +union InvoiceSectionLabelManagementPolicy { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * The policy that controls whether Azure marketplace purchases are allowed. + */ +union MarketplacePurchasesPolicy { + string, + + /** + * Other + */ + Other: "Other", + + /** + * AllAllowed + */ + AllAllowed: "AllAllowed", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", + + /** + * OnlyFreeAllowed + */ + OnlyFreeAllowed: "OnlyFreeAllowed", +} + +/** + * The policy that controls whether Azure reservation purchases are allowed. + */ +union ReservationPurchasesPolicy { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * The policy that controls whether users with Azure savings plan purchase are allowed. + */ +union SavingsPlanPurchasesPolicy { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Allowed + */ + Allowed: "Allowed", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * NotAllowed + */ + NotAllowed: "NotAllowed", +} + +/** + * The status of the product. + */ +union ProductStatus { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Active + */ + Active: "Active", + + /** + * Disabled + */ + Disabled: "Disabled", + + /** + * Deleted + */ + Deleted: "Deleted", + + /** + * PastDue + */ + PastDue: "PastDue", + + /** + * Expiring + */ + Expiring: "Expiring", + + /** + * Expired + */ + Expired: "Expired", + + /** + * AutoRenew + */ + AutoRenew: "AutoRenew", + + /** + * Canceled + */ + Canceled: "Canceled", + + /** + * Suspended + */ + Suspended: "Suspended", +} + +/** + * Error code for the product transfer validation. + */ +union MoveValidationErrorCode { + string, + + /** + * Other + */ + Other: "Other", + + /** + * BillingAccountInactive + */ + BillingAccountInactive: "BillingAccountInactive", + + /** + * DestinationBillingProfileInactive + */ + DestinationBillingProfileInactive: "DestinationBillingProfileInactive", + + /** + * DestinationBillingProfileNotFound + */ + DestinationBillingProfileNotFound: "DestinationBillingProfileNotFound", + + /** + * DestinationBillingProfilePastDue + */ + DestinationBillingProfilePastDue: "DestinationBillingProfilePastDue", + + /** + * DestinationInvoiceSectionInactive + */ + DestinationInvoiceSectionInactive: "DestinationInvoiceSectionInactive", + + /** + * DestinationInvoiceSectionNotFound + */ + DestinationInvoiceSectionNotFound: "DestinationInvoiceSectionNotFound", + + /** + * InsufficientPermissionOnDestination + */ + InsufficientPermissionOnDestination: "InsufficientPermissionOnDestination", + + /** + * InsufficientPermissionOnSource + */ + InsufficientPermissionOnSource: "InsufficientPermissionOnSource", + + /** + * InvalidDestination + */ + InvalidDestination: "InvalidDestination", + + /** + * InvalidSource + */ + InvalidSource: "InvalidSource", + + /** + * MarketplaceNotEnabledOnDestination + */ + MarketplaceNotEnabledOnDestination: "MarketplaceNotEnabledOnDestination", + + /** + * ProductInactive + */ + ProductInactive: "ProductInactive", + + /** + * ProductNotFound + */ + ProductNotFound: "ProductNotFound", + + /** + * ProductTypeNotSupported + */ + ProductTypeNotSupported: "ProductTypeNotSupported", + + /** + * SourceBillingProfilePastDue + */ + SourceBillingProfilePastDue: "SourceBillingProfilePastDue", + + /** + * SourceInvoiceSectionInactive + */ + SourceInvoiceSectionInactive: "SourceInvoiceSectionInactive", +} + +/** + * Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + */ +union InstanceFlexibility { + string, + + /** + * On + */ + On: "On", + + /** + * Off + */ + Off: "Off", +} + +/** + * The status of the reservation. + */ +union ReservationStatusCode { + string, + + /** + * None + */ + None: "None", + + /** + * Pending + */ + Pending: "Pending", + + /** + * Processing + */ + Processing: "Processing", + + /** + * Active + */ + Active: "Active", + + /** + * PurchaseError + */ + PurchaseError: "PurchaseError", + + /** + * PaymentInstrumentError + */ + PaymentInstrumentError: "PaymentInstrumentError", + + /** + * Split + */ + Split: "Split", + + /** + * Merged + */ + Merged: "Merged", + + /** + * Expired + */ + Expired: "Expired", + + /** + * Succeeded + */ + Succeeded: "Succeeded", + + /** + * CapacityError + */ + CapacityError: "CapacityError", + + /** + * CapacityRestricted + */ + CapacityRestricted: "CapacityRestricted", + + /** + * Exchanged + */ + Exchanged: "Exchanged", + + /** + * UnknownError + */ + UnknownError: "UnknownError", + + /** + * RiskCheckFailed + */ + RiskCheckFailed: "RiskCheckFailed", + + /** + * CreditLineCheckFailed + */ + CreditLineCheckFailed: "CreditLineCheckFailed", + + /** + * Warning + */ + Warning: "Warning", + + /** + * NoBenefitDueToSubscriptionTransfer + */ + NoBenefitDueToSubscriptionTransfer: "NoBenefitDueToSubscriptionTransfer", + + /** + * NoBenefitDueToSubscriptionDeletion + */ + NoBenefitDueToSubscriptionDeletion: "NoBenefitDueToSubscriptionDeletion", + + /** + * NoBenefit + */ + NoBenefit: "NoBenefit", +} + +/** + * Represent the billing plans. + */ +union ReservationBillingPlan { + string, + + /** + * Upfront + */ + Upfront: "Upfront", + + /** + * Monthly + */ + Monthly: "Monthly", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union TransactionType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * Billed + */ + Billed: "Billed", + + /** + * Unbilled + */ + Unbilled: "Unbilled", +} + +/** + * The credit type of the transaction. Applies only to credited transactions. + */ +union CreditType { + string, + + /** + * Other + */ + Other: "Other", + + /** + * AzureFreeCredit + */ + AzureFreeCredit: "AzureFreeCredit", + + /** + * AzureCreditOffer + */ + AzureCreditOffer: "AzureCreditOffer", + + /** + * ServiceInterruption + */ + ServiceInterruption: "ServiceInterruption", + + /** + * Refund + */ + Refund: "Refund", +} + +/** + * Type of the transaction, billed or unbilled. + */ +union TransactionKind { + string, + + /** + * Other + */ + Other: "Other", + + /** + * All + */ + All: "All", + + /** + * Reservation + */ + Reservation: "Reservation", +} + +/** + * The status of a transfer. + */ +union TransferStatus { + string, + + /** + * Expired + */ + Expired: "Expired", + + /** + * Pending + */ + Pending: "Pending", + + /** + * InProgress + */ + InProgress: "InProgress", + + /** + * Completed + */ + Completed: "Completed", + + /** + * CompletedWithErrors + */ + CompletedWithErrors: "CompletedWithErrors", + + /** + * Failed + */ + Failed: "Failed", + + /** + * Canceled + */ + Canceled: "Canceled", + + /** + * Declined + */ + Declined: "Declined", +} + +/** + * The type of product that is transferred. + */ +union ProductType { + string, + + /** + * AzureSubscription + */ + AzureSubscription: "AzureSubscription", + + /** + * AzureReservation + */ + AzureReservation: "AzureReservation", + + /** + * Department + */ + Department: "Department", + + /** + * SavingsPlan + */ + SavingsPlan: "SavingsPlan", + + /** + * SAAS + */ + SAAS: "SAAS", +} + +/** + * The status of a transfer. + */ +union ProductTransferStatus { + string, + + /** + * NotStarted + */ + NotStarted: "NotStarted", + + /** + * InProgress + */ + InProgress: "InProgress", + + /** + * Completed + */ + Completed: "Completed", + + /** + * Failed + */ + Failed: "Failed", +} + +/** + * The type of customer of the transfer initiator. + */ +union InitiatorCustomerType { + string, + + /** + * Partner + */ + Partner: "Partner", + + /** + * EA + */ + EA: "EA", +} + +/** + * Type of the products that can be transferred. + */ +union EligibleProductType { + string, + + /** + * DevTestAzureSubscription + */ + DevTestAzureSubscription: "DevTestAzureSubscription", + + /** + * StandardAzureSubscription + */ + StandardAzureSubscription: "StandardAzureSubscription", + + /** + * AzureReservation + */ + AzureReservation: "AzureReservation", +} + +/** + * The supported account types. + */ +union SupportedAccountType { + string, + + /** + * None + */ + None: "None", + + /** + * Partner + */ + Partner: "Partner", + + /** + * Individual + */ + Individual: "Individual", + + /** + * Enterprise + */ + Enterprise: "Enterprise", +} + +/** + * An agreement. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AgreementProperties { + /** + * The mode of acceptance for an agreement. + */ + @visibility(Lifecycle.Read) + acceptanceMode?: AcceptanceMode; + + /** + * The URL to download the agreement. + */ + @visibility(Lifecycle.Read) + agreementLink?: string; + + /** + * The list of billing profiles associated with agreement and present only for specific agreements. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + billingProfileInfo?: BillingProfileInfo[]; + + /** + * The category of the agreement. + */ + @visibility(Lifecycle.Read) + category?: Category; + + /** + * The name of the agreement signed by a customer. + */ + @visibility(Lifecycle.Read) + displayName?: string; + + /** + * The date from which the agreement is effective. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveDate?: utcDateTime; + + /** + * The date when the agreement expires. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationDate?: utcDateTime; + + /** + * The list of participants that participates in acceptance of an agreement. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + participants?: Participant[]; + + /** + * The current status of the agreement. + */ + @visibility(Lifecycle.Read) + status?: string; + + /** + * The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms. + */ + @visibility(Lifecycle.Read) + leadBillingAccountName?: string; +} + +/** + * Details about billing profile associated with agreement and available only for specific agreements. + */ +model BillingProfileInfo { + /** + * The fully qualified ID that uniquely identifies a billing account. + */ + billingAccountId?: string; + + /** + * The name of the billing profile. + */ + billingProfileDisplayName?: string; + + /** + * The friendly ID that uniquely identifies a billing profile. + */ + billingProfileId?: string; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + billingProfileSystemId?: string; + + /** + * Billing account name. Available for a specific type of agreement. + */ + indirectRelationshipOrganizationName?: string; +} + +/** + * Billing account name. Available for a specific type of agreement. + */ +model Participant { + /** + * The email address of the participant. + */ + @visibility(Lifecycle.Read) + email?: string; + + /** + * The acceptance status of the participant. + */ + @visibility(Lifecycle.Read) + status?: string; + + /** + * The date when the status got changed. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + statusDate?: utcDateTime; +} + +/** + * Common fields that are returned in the response for all Azure Resource Manager resources. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProxyResourceWithTags + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +/** + * An associated tenant. + */ +model AssociatedTenantProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The name of the associated tenant. + */ + displayName?: string; + + /** + * The ID that uniquely identifies a tenant. + */ + tenantId?: string; + + /** + * 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. + */ + billingManagementState?: BillingManagementTenantState; + + /** + * 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. + */ + provisioningManagementState?: ProvisioningTenantState; + + /** + * The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. + */ + @visibility(Lifecycle.Read) + provisioningBillingRequestId?: string; +} + +/** + * The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AvailableBalanceProperties { + /** + * Credit amount for immediate payment. + */ + amount?: AvailableBalancePropertiesAmount; + + /** + * The list of payments on accounts. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + paymentsOnAccount?: PaymentOnAccount[]; + + /** + * Total amount of payments on accounts. + */ + totalPaymentsOnAccount?: AvailableBalancePropertiesTotalPaymentsOnAccount; +} + +/** + * Credit amount for immediate payment. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AvailableBalancePropertiesAmount extends Amount {} + +/** + * The amount. + */ +model Amount { + /** + * The currency for the amount value. + */ + @visibility(Lifecycle.Read) + currency?: string; + + /** + * The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. + */ + @visibility(Lifecycle.Read) + value?: float32; +} + +/** + * A Payment on Account. + */ +model PaymentOnAccount { + /** + * Payment on Account amount. + */ + amount?: PaymentOnAccountAmount; + + /** + * The ID of the billing profile for the payments on account. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * The name of the billing profile for the payments on account. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The ID of the invoice for which the payments on account was generated. + */ + @visibility(Lifecycle.Read) + invoiceId?: string; + + /** + * The name of the invoice for the payments on account. + */ + @visibility(Lifecycle.Read) + invoiceName?: string; + + /** + * The date of the payments on account. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + date?: utcDateTime; + + /** + * Payment on Account type. + */ + @visibility(Lifecycle.Read) + paymentMethodType?: PaymentMethodFamily; +} + +/** + * Payment on Account amount. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PaymentOnAccountAmount extends Amount {} + +/** + * Total amount of payments on accounts. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AvailableBalancePropertiesTotalPaymentsOnAccount extends Amount {} + +/** + * The properties of payment term. + */ +model PaymentTerm { + /** + * Represents duration in netXX format. Always in days. + */ + term?: string; + + /** + * The date on when the defined 'Payment Term' will be effective from and is always in UTC. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate?: utcDateTime; + + /** + * The date on when the defined 'Payment Term' will end and is always in UTC. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate?: utcDateTime; + + /** + * Indicates payment term is the standard payment term. + */ + @visibility(Lifecycle.Read) + isDefault?: boolean; +} + +/** + * A billing account. + */ +model BillingAccountProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The current status of the billing account. + */ + @visibility(Lifecycle.Read) + accountStatus?: AccountStatus; + + /** + * The type of customer. + */ + @visibility(Lifecycle.Read) + accountType?: AccountType; + + /** + * The tier of the account. + */ + @visibility(Lifecycle.Read) + accountSubType?: AccountSubType; + + /** + * Reason for the specified billing account status. + */ + @visibility(Lifecycle.Read) + accountStatusReasonCode?: BillingAccountStatusReasonCode; + + /** + * The type of agreement. + */ + @visibility(Lifecycle.Read) + agreementType?: AgreementType; + + /** + * The billing account name. + */ + displayName?: string; + + /** + * The properties of an enrollment. + */ + enrollmentDetails?: BillingAccountPropertiesEnrollmentDetails; + + /** + * Indicates whether user has read access to the billing account. + */ + hasReadAccess?: boolean; + + /** + * Indicates whether or not the billing account has any billing profiles. + */ + hasNoBillingProfiles?: boolean; + + /** + * Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. + */ + notificationEmailAddress?: string; + + /** + * 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. + */ + primaryBillingTenantId?: string; + + /** + * The address of the individual or organization that is responsible for the billing account. + */ + soldTo?: BillingAccountPropertiesSoldTo; + + /** + * Describes the registration number of the organization linked with the billing account. + */ + registrationNumber?: BillingAccountPropertiesRegistrationNumber; + + /** + * Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. + */ + @visibility(Lifecycle.Read) + billingRelationshipTypes?: BillingRelationshipType[]; + + /** + * Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. + */ + @visibility(Lifecycle.Read) + qualifications?: string[]; + + /** + * A list of tax identifiers for the billing account. + */ + @identifiers(#[]) + taxIds?: TaxIdentifier[]; +} + +/** + * The properties of an enrollment. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingAccountPropertiesEnrollmentDetails extends EnrollmentDetails {} + +/** + * The properties of an enrollment. + */ +model EnrollmentDetails { + /** + * The start date of the enrollment. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate?: utcDateTime; + + /** + * The end date of the enrollment. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate?: utcDateTime; + + /** + * The billing currency for the enrollment. + */ + @visibility(Lifecycle.Read) + currency?: string; + + /** + * The channel type of the enrollment. + */ + @visibility(Lifecycle.Read) + channel?: string; + + /** + * The language for the enrollment. + */ + @visibility(Lifecycle.Read) + language?: string; + + /** + * The country code of the enrollment. + */ + @visibility(Lifecycle.Read) + countryCode?: string; + + /** + * The billing cycle for the enrollment. + */ + @visibility(Lifecycle.Read) + billingCycle?: string; + + /** + * The billing account extension opted by the company. + */ + @visibility(Lifecycle.Read) + extendedTermOption?: ExtendedTermOption; + + /** + * The support level offer associated with an enrollment. + */ + @visibility(Lifecycle.Read) + supportLevel?: SupportLevel; + + /** + * The support coverage period for the enrollment. + */ + @visibility(Lifecycle.Read) + supportCoverage?: string; + + /** + * The cloud of the enrollment. + */ + @visibility(Lifecycle.Read) + cloud?: string; + + /** + * The purchase order number of the enrollment. + */ + poNumber?: string; + + /** + * Markup status of enrollment, applicable only for indirect enrollments. + */ + @visibility(Lifecycle.Read) + markupStatus?: MarkupStatus; + + /** + * The properties of an enrollment which are applicable only for indirect enrollments. + */ + indirectRelationshipInfo?: EnrollmentDetailsIndirectRelationshipInfo; + + /** + * The contact who receives invoices of the enrollment. + */ + @visibility(Lifecycle.Read) + invoiceRecipient?: string; +} + +/** + * The properties of an enrollment which are applicable only for indirect enrollments. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model EnrollmentDetailsIndirectRelationshipInfo + extends IndirectRelationshipInfo {} + +/** + * Identifies the billing profile that is linked to another billing profile in indirect purchase motion. + */ +model IndirectRelationshipInfo { + /** + * The billing account name of the partner or the customer for an indirect motion. + */ + billingAccountName?: string; + + /** + * The billing profile name of the partner or the customer for an indirect motion. + */ + billingProfileName?: string; + + /** + * The display name of the partner or customer for an indirect motion. + */ + displayName?: string; +} + +/** + * The address of the individual or organization that is responsible for the billing account. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingAccountPropertiesSoldTo extends AddressDetails {} + +/** + * Address details. + */ +model AddressDetails { + /** + * Address line 1. + */ + @minLength(1) + addressLine1: string; + + /** + * Address line 2. + */ + addressLine2?: string; + + /** + * Address line 3. + */ + addressLine3?: string; + + /** + * Address city. + */ + city?: string; + + /** + * Company name. Optional for MCA Individual (Pay-as-you-go). + */ + companyName?: string; + + /** + * Country code uses ISO 3166-1 Alpha-2 format. + */ + @minLength(1) + country: string; + + /** + * Address district. + */ + district?: string; + + /** + * Email address. + */ + email?: string; + + /** + * First name. Optional for MCA Enterprise. + */ + firstName?: string; + + /** + * Last name. Optional for MCA Enterprise. + */ + lastName?: string; + + /** + * Middle name. + */ + middleName?: string; + + /** + * Phone number. + */ + phoneNumber?: string; + + /** + * Postal code. + */ + postalCode?: string; + + /** + * Address region. + */ + region?: string; + + /** + * Indicates if the address is incomplete. + */ + isValidAddress?: boolean; +} + +/** + * Describes the registration number of the organization linked with the billing account. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingAccountPropertiesRegistrationNumber extends RegistrationNumber {} + +/** + * Describes the registration number of the organization linked with the billing account. + */ +model RegistrationNumber { + /** + * The unique identification number of the organization linked with the billing account. + */ + id?: string; + + /** + * Identifies if the registration number is required for the billing account. + */ + @visibility(Lifecycle.Read) + required?: boolean; + + /** + * The types of registration number allowed based on the country of the billing account. + */ + @visibility(Lifecycle.Read) + type?: string[]; +} + +/** + * A tax identifier for the billing account. + */ +model TaxIdentifier { + /** + * The id of the tax identifier. + */ + id?: string; + + /** + * The type of the tax identifier. + */ + type?: TaxIdentifierType; + + /** + * The scope of the tax identifier. + */ + scope?: string; + + /** + * The country of the tax identifier. + */ + country?: string; + + /** + * The status of the tax identifier. + */ + status?: TaxIdentifierStatus; +} + +/** + * The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement. + */ +model TransitionDetails { + /** + * The transition completion date. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + transitionDate?: utcDateTime; + + /** + * The anniversary day of the pre-transitioned account of type Microsoft Online Services Program. + */ + @visibility(Lifecycle.Read) + anniversaryDay?: int32; +} + +/** + * A container for a list of resources + */ +model InvoiceSectionWithCreateSubPermissionListResult + is Azure.Core.Page; + +/** + * Invoice section properties with create subscription permission. + */ +model InvoiceSectionWithCreateSubPermission { + /** + * The name of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * The system generated unique identifier for a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileSystemId?: string; + + /** + * The status of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileStatus?: BillingProfileStatus; + + /** + * Reason for the specified billing profile status. + */ + @visibility(Lifecycle.Read) + billingProfileStatusReasonCode?: BillingProfileStatusReasonCode; + + /** + * The billing profile spending limit. + */ + @visibility(Lifecycle.Read) + billingProfileSpendingLimit?: SpendingLimit; + + /** + * Enabled azure plans for the associated billing profile. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + enabledAzurePlans?: AzurePlan[]; + + /** + * The name of the invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionId?: string; + + /** + * The system generated unique identifier for an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionSystemId?: string; +} + +/** + * Details of the Azure plan. + */ +model AzurePlan { + /** + * The ID that uniquely identifies a product. + */ + productId?: string; + + /** + * The ID that uniquely identifies a sku. + */ + skuId?: string; + + /** + * The sku description. + */ + skuDescription?: string; +} + +/** + * Result of the payment terms eligibility. + */ +model PaymentTermsEligibilityResult { + /** + * Indicates the eligibility status of the payment terms. + */ + eligibilityStatus?: PaymentTermsEligibilityStatus; + + /** + * Details of the payment terms eligibility. + */ + @identifiers(#[]) + eligibilityDetails?: PaymentTermsEligibilityDetail[]; +} + +/** + * Details of the payment terms eligibility. + */ +model PaymentTermsEligibilityDetail { + /** + * Indicates the reason for the ineligibility of the payment terms. + */ + code?: PaymentTermsEligibilityCode; + + /** + * Indicates the message for the ineligibility of the payment terms. + */ + message?: string; +} + +/** + * A billing account. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingAccountPatch extends ProxyResourceWithTags { + /** + * A billing account. + */ + properties?: BillingAccountProperties; +} + +/** + * Result of the address validation. + */ +model AddressValidationResponse { + /** + * Status of the address validation. + */ + @visibility(Lifecycle.Read) + status?: AddressValidationStatus; + + /** + * The list of suggested addresses. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + suggestedAddresses?: AddressDetails[]; + + /** + * Validation error message. + */ + @visibility(Lifecycle.Read) + validationMessage?: string; +} + +/** + * A container for a list of resources + */ +model BillingPermissionListResult is Azure.Core.Page; + +/** + * The set of allowed action and not allowed actions a caller has on a resource. + */ +model BillingPermission { + /** + * The set of actions that the caller is allowed to perform. + */ + @visibility(Lifecycle.Read) + actions?: string[]; + + /** + * The set of actions that the caller is not allowed to perform. + */ + @visibility(Lifecycle.Read) + notActions?: string[]; +} + +/** + * Request to check access. + */ +model CheckAccessRequest { + /** + * List of actions passed in the request body against which the permissions will be checked. + */ + actions?: string[]; +} + +/** + * The properties of a check access response. + */ +model CheckAccessResponse { + /** + * Access Decision, specifies access is allowed or not. + */ + @visibility(Lifecycle.Read) + accessDecision?: AccessDecision; + + /** + * Gets or sets an action. + */ + @visibility(Lifecycle.Read) + action?: string; +} + +/** + * Eligibility to delete a billing profile result. + */ +model DeleteBillingProfileEligibilityResult { + /** + * Status describing if billing profile is eligible to be deleted. + */ + eligibilityStatus?: DeleteBillingProfileEligibilityStatus; + + /** + * Validation details of delete billing profile eligibility. + */ + @identifiers(#[]) + eligibilityDetails?: DeleteBillingProfileEligibilityDetail[]; +} + +/** + * Validation details of delete billing profile eligibility. + */ +model DeleteBillingProfileEligibilityDetail { + /** + * Code of the delete invoice section eligibility response. + */ + code?: DeleteBillingProfileEligibilityCode; + + /** + * Validation message. + */ + message?: string; +} + +/** + * A billing profile. + */ +model BillingProfileProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. + */ + @visibility(Lifecycle.Read) + billingRelationshipType?: BillingRelationshipType; + + /** + * Billing address. + */ + billTo?: BillingProfilePropertiesBillTo; + + /** + * The currency in which the charges for the billing profile are billed. + */ + @visibility(Lifecycle.Read) + currency?: string; + + /** + * The name of the billing profile. + */ + displayName?: string; + + /** + * Information about the enabled azure plans. + */ + @identifiers(#[]) + enabledAzurePlans?: AzurePlan[]; + + /** + * Indicates whether user has read access to the billing profile. + */ + @visibility(Lifecycle.Read) + hasReadAccess?: boolean; + + /** + * Identifies the billing profile that is linked to another billing profile in indirect purchase motion. + */ + indirectRelationshipInfo?: BillingProfilePropertiesIndirectRelationshipInfo; + + /** + * The day of the month when the invoice for the billing profile is generated. + */ + @visibility(Lifecycle.Read) + invoiceDay?: int32; + + /** + * Flag controlling whether the invoices for the billing profile are sent through email. + */ + invoiceEmailOptIn?: boolean; + + /** + * The list of email addresses to receive invoices by email for the billing profile. + */ + invoiceRecipients?: string[]; + + /** + * The default purchase order number that will appear on the invoices generated for the billing profile. + */ + poNumber?: string; + + /** + * 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. + */ + shipTo?: BillingProfilePropertiesShipTo; + + /** + * The address of the individual or organization that is responsible for the billing account. + */ + soldTo?: BillingProfilePropertiesSoldTo; + + /** + * The billing profile spending limit. + */ + @visibility(Lifecycle.Read) + spendingLimit?: SpendingLimit; + + /** + * The details of billing profile spending limit. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + spendingLimitDetails?: SpendingLimitDetails[]; + + /** + * The status of the billing profile. + */ + @visibility(Lifecycle.Read) + status?: BillingProfileStatus; + + /** + * Reason for the specified billing profile status. + */ + @visibility(Lifecycle.Read) + statusReasonCode?: BillingProfileStatusReasonCode; + + /** + * The system generated unique identifier for a billing profile. + */ + @visibility(Lifecycle.Read) + systemId?: string; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + targetClouds?: string[]; + + /** + * The current payment term of the billing profile. + */ + currentPaymentTerm?: BillingProfilePropertiesCurrentPaymentTerm; + + /** + * The other payment terms of the billing profile. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + otherPaymentTerms?: PaymentTerm[]; +} + +/** + * Billing address. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingProfilePropertiesBillTo extends AddressDetails {} + +/** + * Identifies the billing profile that is linked to another billing profile in indirect purchase motion. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingProfilePropertiesIndirectRelationshipInfo + extends IndirectRelationshipInfo {} + +/** + * 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. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingProfilePropertiesShipTo extends AddressDetails {} + +/** + * The address of the individual or organization that is responsible for the billing account. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingProfilePropertiesSoldTo extends AddressDetails {} + +/** + * The billing profile spending limit. + */ +model SpendingLimitDetails { + /** + * The initial amount for the billing profile. + */ + amount?: float32; + + /** + * The currency in which the charges for the billing profile are billed. + */ + currency?: string; + + /** + * The date when this spending limit goes into effect. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate?: utcDateTime; + + /** + * The date when this spending limit is no longer in effect. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate?: utcDateTime; + + /** + * The type of spending limit. + */ + type?: SpendingLimitType; + + /** + * The status of current spending limit. + */ + status?: SpendingLimitStatus; +} + +/** + * The current payment term of the billing profile. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingProfilePropertiesCurrentPaymentTerm extends PaymentTerm {} + +/** + * A billing property. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingPropertyProperties { + /** + * The type of agreement. + */ + @visibility(Lifecycle.Read) + billingAccountAgreementType?: AgreementType; + + /** + * The name of the billing account. + */ + @visibility(Lifecycle.Read) + billingAccountDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a billing account. + */ + @visibility(Lifecycle.Read) + billingAccountId?: string; + + /** + * Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. + */ + @visibility(Lifecycle.Read) + accountAdminNotificationEmailAddress?: string; + + /** + * The country of the individual or organization that is responsible for the billing account. + */ + @visibility(Lifecycle.Read) + billingAccountSoldToCountry?: string; + + /** + * The current status of the billing account. + */ + @visibility(Lifecycle.Read) + billingAccountStatus?: AccountStatus; + + /** + * Reason for the specified billing account status. + */ + @visibility(Lifecycle.Read) + billingAccountStatusReasonCode?: BillingAccountStatusReasonCode; + + /** + * The type of customer. + */ + @visibility(Lifecycle.Read) + billingAccountType?: AccountType; + + /** + * The tier of the account. + */ + @visibility(Lifecycle.Read) + billingAccountSubType?: AccountSubType; + + /** + * The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement + */ + @visibility(Lifecycle.Read) + billingCurrency?: string; + + /** + * The name of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * The billing profile spending limit. + */ + @visibility(Lifecycle.Read) + billingProfileSpendingLimit?: SpendingLimit; + + /** + * The details of billing profile spending limit. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + billingProfileSpendingLimitDetails?: SpendingLimitDetails[]; + + /** + * The status of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileStatus?: BillingProfileStatus; + + /** + * Reason for the specified billing profile status. + */ + @visibility(Lifecycle.Read) + billingProfileStatusReasonCode?: BillingProfileStatusReasonCode; + + /** + * The payment method family of the primary payment method for the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfilePaymentMethodFamily?: PaymentMethodFamily; + + /** + * The payment method type of the primary payment method for the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfilePaymentMethodType?: string; + + /** + * The Azure AD tenant ID of the billing account for the subscription. + */ + @visibility(Lifecycle.Read) + billingTenantId?: string; + + /** + * 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. + */ + costCenter?: string; + + /** + * The name of the customer. + */ + @visibility(Lifecycle.Read) + customerDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a customer. + */ + @visibility(Lifecycle.Read) + customerId?: string; + + /** + * Identifies the status of an customer. This is an upcoming property that will be populated in the future. + */ + @visibility(Lifecycle.Read) + customerStatus?: CustomerStatus; + + /** + * The name of the invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionId?: string; + + /** + * Identifies the status of an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionStatus?: InvoiceSectionState; + + /** + * Reason for the specified invoice section status. + */ + @visibility(Lifecycle.Read) + invoiceSectionStatusReasonCode?: InvoiceSectionStateReasonCode; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + isTransitionedBillingAccount?: boolean; + + /** + * The sku description. + */ + @visibility(Lifecycle.Read) + skuDescription?: string; + + /** + * The ID that uniquely identifies a sku. + */ + @visibility(Lifecycle.Read) + skuId?: string; + + /** + * The subscription status. + */ + @visibility(Lifecycle.Read) + subscriptionBillingStatus?: BillingSubscriptionStatus; + + /** + * The reason codes for the subscription status. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + subscriptionBillingStatusDetails?: BillingSubscriptionStatusDetails[]; + + /** + * The type of billing subscription. + */ + @visibility(Lifecycle.Read) + subscriptionBillingType?: SubscriptionBillingType; + + /** + * 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. + */ + subscriptionServiceUsageAddress?: BillingPropertyPropertiesSubscriptionServiceUsageAddress; + + /** + * The Azure workload type of the subscription. + */ + @visibility(Lifecycle.Read) + subscriptionWorkloadType?: SubscriptionWorkloadType; + + /** + * The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. + */ + enrollmentDetails?: BillingPropertyPropertiesEnrollmentDetails; + + /** + * Indicates whether user is the account admin. + */ + @visibility(Lifecycle.Read) + isAccountAdmin?: boolean; + + /** + * The ID that uniquely identifies a product. + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * The ID that uniquely identifies a product. + */ + @visibility(Lifecycle.Read) + productName?: string; +} + +/** + * The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. + */ +model BillingSubscriptionStatusDetails { + /** + * The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveDate?: utcDateTime; + + /** + * The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + reason?: SubscriptionStatusReason; +} + +/** + * 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. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingPropertyPropertiesSubscriptionServiceUsageAddress + extends AddressDetails {} + +/** + * The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingPropertyPropertiesEnrollmentDetails + extends SubscriptionEnrollmentDetails {} + +/** + * The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. + */ +model SubscriptionEnrollmentDetails { + /** + * The name of the department + */ + departmentDisplayName?: string; + + /** + * The ID that uniquely identifies the department. + */ + departmentId?: string; + + /** + * The status of the enrollment account. + */ + enrollmentAccountStatus?: string; + + /** + * The name of the enrollment account. + */ + enrollmentAccountDisplayName?: string; + + /** + * The ID that uniquely identifies an enrollment account. + */ + enrollmentAccountId?: string; +} + +/** + * A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. + */ +model BillingRequestProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * Additional information for the billing request. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + additionalInformation?: Record; + + /** + * The principal of the request reviewer. Will only be set if request is approved. + */ + reviewedBy?: BillingRequestPropertiesReviewedBy; + + /** + * The date and time when the request was reviewed. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + reviewalDate?: utcDateTime; + + /** + * The fully qualified ID that uniquely identifies a billing account. + */ + @visibility(Lifecycle.Read) + billingAccountId?: string; + + /** + * The ID that uniquely identifies a billing account. + */ + @visibility(Lifecycle.Read) + billingAccountName?: string; + + /** + * The name of the billing account. + */ + @visibility(Lifecycle.Read) + billingAccountDisplayName?: string; + + /** + * The primary tenant ID of the billing account for which the billing request was submitted. + */ + @visibility(Lifecycle.Read) + billingAccountPrimaryBillingTenantId?: string; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * The ID that uniquely identifies a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileName?: string; + + /** + * The name of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The principal of the entity who created the request. + */ + createdBy?: BillingRequestPropertiesCreatedBy; + + /** + * The date and time when the request was created. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + creationDate?: utcDateTime; + + /** + * The date and time when the request expires. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationDate?: utcDateTime; + + /** + * The reason to approve or decline the request. + */ + decisionReason?: string; + + /** + * The fully qualified ID that uniquely identifies an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionId?: string; + + /** + * The ID that uniquely identifies an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionName?: string; + + /** + * The name of the invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a customer. + */ + @visibility(Lifecycle.Read) + customerId?: string; + + /** + * The ID that uniquely identifies a customer. + */ + @visibility(Lifecycle.Read) + customerName?: string; + + /** + * The name of the customer. + */ + @visibility(Lifecycle.Read) + customerDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a billing subscription. + */ + @visibility(Lifecycle.Read) + subscriptionId?: string; + + /** + * The ID that uniquely identifies a billing subscription. + */ + @visibility(Lifecycle.Read) + subscriptionName?: string; + + /** + * The name of the billing subscription. + */ + @visibility(Lifecycle.Read) + subscriptionDisplayName?: string; + + /** + * Justification for submitting request. + */ + justification?: string; + + /** + * The recipients of the billing request. + */ + @identifiers(#[]) + recipients?: Principal[]; + + /** + * The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). + */ + requestScope?: string; + + /** + * The billing scope for which the request will be applied. This is a read only property derived by the service. + */ + @visibility(Lifecycle.Read) + billingScope?: string; + + /** + * Status of billing request. + */ + status?: BillingRequestStatus; + + /** + * Type of billing request. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + type?: BillingRequestType; + + /** + * The principal of the entity who last updated the request. + */ + lastUpdatedBy?: BillingRequestPropertiesLastUpdatedBy; + + /** + * Date and time of last update. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + lastUpdatedDate?: utcDateTime; +} + +/** + * The principal of the request reviewer. Will only be set if request is approved. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingRequestPropertiesReviewedBy extends Principal {} + +/** + * A principal who has interacted with a billing entity. + */ +model Principal { + /** + * The tenant id of the principal who has interacted with a billing entity. + */ + tenantId?: string; + + /** + * The object id of the principal who has interacted with a billing entity. + */ + objectId?: string; + + /** + * The user principal name of the principal who has interacted with a billing entity. + */ + upn?: string; +} + +/** + * The principal of the entity who created the request. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingRequestPropertiesCreatedBy extends Principal {} + +/** + * The principal of the entity who last updated the request. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingRequestPropertiesLastUpdatedBy extends Principal {} + +/** + * The properties of the billing role assignment. + */ +model BillingRoleAssignmentProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The date the role assignment was created. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdOn?: utcDateTime; + + /** + * The tenant Id of the user who created the role assignment. + */ + @visibility(Lifecycle.Read) + createdByPrincipalTenantId?: string; + + /** + * The object ID of the user who created the role assignment. + */ + @visibility(Lifecycle.Read) + createdByPrincipalId?: string; + + /** + * The principal PUID of the user who created the role assignment. + */ + @visibility(Lifecycle.Read) + createdByPrincipalPuid?: string; + + /** + * The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. + */ + @visibility(Lifecycle.Read) + createdByUserEmailAddress?: string; + + /** + * The date the role assignment was modified. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + modifiedOn?: utcDateTime; + + /** + * The principal PUID of the user who modified the role assignment. + */ + @visibility(Lifecycle.Read) + modifiedByPrincipalPuid?: string; + + /** + * The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. + */ + @visibility(Lifecycle.Read) + modifiedByUserEmailAddress?: string; + + /** + * The principal PUID of the user who modified the role assignment. + */ + @visibility(Lifecycle.Read) + modifiedByPrincipalId?: string; + + /** + * The tenant Id of the user who modified the role assignment. + */ + @visibility(Lifecycle.Read) + modifiedByPrincipalTenantId?: string; + + /** + * The principal PUID of the user to whom the role was assigned. + */ + principalPuid?: string; + + /** + * The object id of the user to whom the role was assigned. + */ + principalId?: string; + + /** + * The principal tenant id of the user to whom the role was assigned. + */ + principalTenantId?: string; + + /** + * The ID of the role definition. + */ + @minLength(1) + roleDefinitionId: string; + + /** + * The scope at which the role was assigned. + */ + scope?: string; + + /** + * 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. + */ + userAuthenticationType?: string; + + /** + * The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. + */ + userEmailAddress?: string; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + principalTenantName?: string; + + /** + * The display name of the principal to whom the role was assigned. + */ + @visibility(Lifecycle.Read) + principalDisplayName?: string; + + /** + * The type of a role Assignment. + */ + @visibility(Lifecycle.Read) + principalType?: PrincipalType; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + billingRequestId?: string; + + /** + * The fully qualified ID that uniquely identifies a billing account. + */ + @visibility(Lifecycle.Read) + billingAccountId?: string; + + /** + * The name of the billing account. + */ + @visibility(Lifecycle.Read) + billingAccountDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * The name of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionId?: string; + + /** + * The name of the invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a customer. + */ + @visibility(Lifecycle.Read) + customerId?: string; + + /** + * The name of the customer. + */ + @visibility(Lifecycle.Read) + customerDisplayName?: string; +} + +/** + * The properties of a role definition. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingRoleDefinitionProperties { + /** + * The role description. + */ + @visibility(Lifecycle.Read) + description?: string; + + /** + * The billingPermissions the role has. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + permissions?: BillingPermission[]; + + /** + * The name of the role. + */ + @minLength(1) + roleName: string; +} + +/** + * The SKU to be applied for this resource + */ +model Sku { + /** + * Name of the SKU to be applied + */ + name?: string; +} + +/** + * Savings plan order properties + */ +model SavingsPlanOrderModelProperties { + /** + * Display name + */ + displayName?: string; + + /** + * The provisioning state of the savings plan, e.g. Succeeded + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; + + /** + * Subscription that will be charged for purchasing SavingsPlan + */ + billingScopeId?: string; + + /** + * Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. + */ + @visibility(Lifecycle.Read) + customerId?: string; + + /** + * Fully-qualified identifier of the billing account where the savings plan is applied. + */ + @visibility(Lifecycle.Read) + billingAccountId?: string; + + /** + * Represents the Savings plan term in ISO 8601 format. + */ + term?: SavingsPlanTerm; + + /** + * Represents the billing plan in ISO 8601 format. Required only for monthly purchases. + */ + billingPlan?: BillingPlan; + + /** + * DateTime when the savings plan benefit started. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + benefitStartTime?: utcDateTime; + + /** + * DateTime when the savings plan will expire. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiryDateTime?: utcDateTime; + + /** + * Information describing the type of billing plan for this savings plan. + */ + planInformation?: BillingPlanInformation; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + savingsPlans?: string[]; + + /** + * Extended status information + */ + @visibility(Lifecycle.Read) + extendedStatusInfo?: ExtendedStatusInfo; + + /** + * Represents UPN + */ + productCode?: string; +} + +/** + * Information describing the type of billing plan for this savings plan. + */ +model BillingPlanInformation { + /** + * Amount of money to be paid for the Order. Tax is not included. + */ + pricingCurrencyTotal?: Price; + + /** + * Date when the billing plan has started. + */ + startDate?: plainDate; + + /** + * For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. + */ + nextPaymentDueDate?: plainDate; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @identifiers(#[]) + transactions?: PaymentDetail[]; +} + +/** + * The price. + */ +model Price { + /** + * The ISO 4217 3-letter currency code for the currency used by this purchase record. + */ + currencyCode?: string; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + amount?: float64; +} + +/** + * Information about payment related to a savings plan order. + */ +model PaymentDetail { + /** + * Date when the payment needs to be done. + */ + dueDate?: plainDate; + + /** + * Date when the transaction is completed. Null when it is scheduled. + */ + paymentDate?: plainDate; + + /** + * Amount in pricing currency. Tax not included. + */ + pricingCurrencyTotal?: Price; + + /** + * Amount charged in Billing currency. Tax not included. Is null for future payments + */ + billingCurrencyTotal?: Price; + + /** + * Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future. + */ + status?: PaymentStatus; + + /** + * Extended status information + */ + @visibility(Lifecycle.Read) + extendedStatusInfo?: ExtendedStatusInfo; +} + +/** + * Extended status information + */ +model ExtendedStatusInfo { + /** + * Status code providing additional information. + */ + statusCode?: string; + + /** + * The message giving detailed information about the status code. + */ + message?: string; + + /** + * Properties specific to credit line check failure + */ + properties?: ExtendedStatusInfoProperties; +} + +/** + * Properties specific to credit line check failure + */ +model ExtendedStatusInfoProperties { + /** + * The subscription that has failed credit line check. + */ + subscriptionId?: string; +} + +/** + * List of savings plan orders + */ +model SavingsPlanOrderModelList is Azure.Core.Page; + +/** + * List of savings plans + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model SavingsPlanModelListResult extends SavingsPlanModelList { + /** + * The roll out count summary of the savings plans + */ + summary: SavingsPlanSummaryCount; +} + +/** + * List of savings plans + */ +model SavingsPlanModelList is Azure.Core.Page; + +/** + * Savings plan properties + */ +model SavingsPlanModelProperties { + /** + * Display name + */ + displayName?: string; + + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The provisioning state of the savings plan for display, e.g. Succeeded + */ + @visibility(Lifecycle.Read) + displayProvisioningState?: string; + + /** + * The applied scope type of the savings plan for display, e.g. Shared + */ + @visibility(Lifecycle.Read) + userFriendlyAppliedScopeType?: string; + + /** + * Subscription that will be charged for purchasing SavingsPlan + */ + billingScopeId?: string; + + /** + * Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. + */ + @visibility(Lifecycle.Read) + customerId?: string; + + /** + * Fully-qualified identifier of the billing account where the savings plan is applied. + */ + @visibility(Lifecycle.Read) + billingAccountId?: string; + + /** + * Represents the Savings plan term in ISO 8601 format. + */ + term?: SavingsPlanTerm; + + /** + * Setting this to true will automatically purchase a new benefit on the expiration date time. + */ + renew?: boolean = false; + + /** + * SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. + */ + renewSource?: string; + + /** + * SavingsPlan Id of the SavingsPlan which is purchased because of renew. + */ + renewDestination?: string; + + /** + * Properties specific to renew. + */ + renewProperties?: RenewProperties; + + /** + * Represents the billing plan in ISO 8601 format. Required only for monthly purchases. + */ + billingPlan?: BillingPlan; + + /** + * Type of the Applied Scope. + */ + appliedScopeType?: AppliedScopeType; + + /** + * Properties specific to applied scope type. Not required if not applicable. + */ + appliedScopeProperties?: AppliedScopeProperties; + + /** + * Commitment towards the benefit. + */ + commitment?: Commitment; + + /** + * DateTime of the savings plan starting when this version is effective from. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveDateTime?: utcDateTime; + + /** + * This is the DateTime when the savings plan benefit starts. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + benefitStartTime?: utcDateTime; + + /** + * This is the date-time when the savings plan will expire. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiryDateTime?: utcDateTime; + + /** + * Date time when the savings plan was purchased. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + purchaseDateTime?: utcDateTime; + + /** + * Savings plan utilization + */ + @visibility(Lifecycle.Read) + utilization?: Utilization; + + /** + * Extended status information + */ + @visibility(Lifecycle.Read) + extendedStatusInfo?: ExtendedStatusInfo; + + /** + * Represents UPN + */ + productCode?: string; +} + +/** + * Properties specific to renew. + */ +model RenewProperties { + /** + * Purchase request. + */ + purchaseProperties?: PurchaseRequest; +} + +/** + * Purchase request. + */ +model PurchaseRequest { + /** + * The SKU to be applied for this resource + */ + sku?: Sku; + + /** + * Purchase request properties. + */ + properties?: PurchaseRequestProperties; +} + +/** + * Purchase request properties. + */ +model PurchaseRequestProperties { + /** + * Friendly name of the savings plan + */ + displayName?: string; + + /** + * Subscription that will be charged for purchasing SavingsPlan + */ + billingScopeId?: string; + + /** + * Represents the Savings plan term in ISO 8601 format. + */ + term?: SavingsPlanTerm; + + /** + * Represents the billing plan in ISO 8601 format. Required only for monthly purchases. + */ + billingPlan?: BillingPlan; + + /** + * Type of the Applied Scope. + */ + appliedScopeType?: AppliedScopeType; + + /** + * Commitment towards the benefit. + */ + commitment?: Commitment; + + /** + * Setting this to true will automatically purchase a new benefit on the expiration date time. + */ + renew?: boolean = false; + + /** + * Properties specific to applied scope type. Not required if not applicable. + */ + appliedScopeProperties?: AppliedScopeProperties; +} + +/** + * Commitment towards the benefit. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model Commitment extends Price { + /** + * Commitment grain. + */ + grain?: CommitmentGrain; +} + +/** + * Properties specific to applied scope type. Not required if not applicable. + */ +model AppliedScopeProperties { + /** + * Tenant ID where the savings plan where the benefit is applied. + */ + tenantId?: string; + + /** + * Fully-qualified identifier of the management group where the benefit is applied. + */ + managementGroupId?: string; + + /** + * Fully-qualified identifier of the subscription where the benefit is applied. + */ + subscriptionId?: string; + + /** + * Fully-qualified identifier of the resource group where the benefit is applied. + */ + resourceGroupId?: string; + + /** + * Display name + */ + displayName?: string; +} + +/** + * Savings plan utilization + */ +model Utilization { + /** + * The trend for a savings plan's utilization + */ + @visibility(Lifecycle.Read) + trend?: string; + + /** + * The array of aggregates of a savings plan's utilization + */ + @identifiers(#[]) + aggregates?: UtilizationAggregates[]; +} + +/** + * The aggregate values of savings plan utilization + */ +model UtilizationAggregates { + /** + * The grain of the aggregate + */ + @visibility(Lifecycle.Read) + grain?: float32; + + /** + * The grain unit of the aggregate + */ + @visibility(Lifecycle.Read) + grainUnit?: string; + + /** + * The aggregate value + */ + @visibility(Lifecycle.Read) + value?: float32; + + /** + * The aggregate value unit + */ + @visibility(Lifecycle.Read) + valueUnit?: string; +} + +/** + * Savings plan patch request + */ +model SavingsPlanUpdateRequest { + /** + * Savings plan patch request + */ + properties?: SavingsPlanUpdateRequestProperties; + + /** + * The SKU to be applied for this resource + */ + sku?: Sku; + + /** + * Tags for this reservation + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +/** + * Savings plan patch request + */ +model SavingsPlanUpdateRequestProperties { + /** + * Display name + */ + displayName?: string; + + /** + * Type of the Applied Scope. + */ + appliedScopeType?: AppliedScopeType; + + /** + * Properties specific to applied scope type. Not required if not applicable. + */ + appliedScopeProperties?: AppliedScopeProperties; + + /** + * Setting this to true will automatically purchase a new benefit on the expiration date time. + */ + renew?: boolean = false; + + /** + * Properties specific to renew. + */ + renewProperties?: RenewProperties; +} + +/** + * Savings plan update validate request. + */ +model SavingsPlanUpdateValidateRequest { + /** + * The benefits of a savings plan. + */ + @identifiers(#[]) + benefits?: SavingsPlanUpdateRequestProperties[]; +} + +/** + * Savings plan update validate response. + */ +model SavingsPlanValidateResponse { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @identifiers(#[]) + benefits?: SavingsPlanValidResponseProperty[]; + + /** + * Url to get the next page. + */ + nextLink?: string; +} + +/** + * Benefit scope response property + */ +model SavingsPlanValidResponseProperty { + /** + * Indicates if the provided input is valid + */ + valid?: boolean; + + /** + * Failure reason code if the provided input is invalid + */ + reasonCode?: string; + + /** + * Failure reason if the provided input is invalid + */ + reason?: string; +} + +/** + * The billing properties of a subscription. + */ +model BillingSubscriptionProperties { + /** + * Indicates whether auto renewal is turned on or off for a product. + */ + autoRenew?: AutoRenew; + + /** + * The provisioning tenant of the subscription. + */ + beneficiaryTenantId?: string; + + /** + * The beneficiary of the billing subscription. + */ + beneficiary?: Beneficiary; + + /** + * The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y + */ + billingFrequency?: string; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + billingProfileId?: string; + + /** + * Dictionary of billing policies associated with the subscription. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + billingPolicies?: Record; + + /** + * The name of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The ID that uniquely identifies a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileName?: string; + + /** + * 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. + */ + consumptionCostCenter?: string; + + /** + * The fully qualified ID that uniquely identifies a customer. + */ + customerId?: string; + + /** + * The name of the customer. + */ + @visibility(Lifecycle.Read) + customerDisplayName?: string; + + /** + * The ID that uniquely identifies a customer. + */ + @visibility(Lifecycle.Read) + customerName?: string; + + /** + * The name of the billing subscription. + */ + displayName?: string; + + /** + * The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. + */ + @visibility(Lifecycle.Read) + enrollmentAccountId?: string; + + /** + * The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. + */ + @visibility(Lifecycle.Read) + enrollmentAccountDisplayName?: string; + + /** + * Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. + */ + @visibility(Lifecycle.Read) + enrollmentAccountSubscriptionDetails?: EnrollmentAccountSubscriptionDetails; + + /** + * The fully qualified ID that uniquely identifies an invoice section. + */ + invoiceSectionId?: string; + + /** + * The name of the invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionDisplayName?: string; + + /** + * The ID that uniquely identifies an invoice section. + */ + @visibility(Lifecycle.Read) + invoiceSectionName?: string; + + /** + * The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + lastMonthCharges?: Amount; + + /** + * The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + monthToDateCharges?: Amount; + + /** + * Next billing cycle details of the subscription. + */ + @visibility(Lifecycle.Read) + nextBillingCycleDetails?: NextBillingCycleDetails; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + offerId?: string; + + /** + * The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. + */ + @visibility(Lifecycle.Read) + productCategory?: string; + + /** + * Type of the product for which the subscription is purchased. + */ + @visibility(Lifecycle.Read) + productType?: string; + + /** + * Id of the product for which the subscription is purchased. + */ + productTypeId?: string; + + /** + * Purchase date of the product in UTC time. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + purchaseDate?: utcDateTime; + + /** + * The quantity of licenses or fulfillment units for the subscription. + */ + quantity?: int64; + + /** + * Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + reseller?: Reseller; + + /** + * Details for the next renewal term of a subscription. + */ + @visibility(Lifecycle.Read) + renewalTermDetails?: RenewalTermDetails; + + /** + * The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. + */ + skuId?: string; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + skuDescription?: string; + + /** + * System imposed policies that regulate behavior of the subscription. + */ + systemOverrides?: SystemOverrides; + + /** + * Unique identifier of the linked resource. + */ + @visibility(Lifecycle.Read) + resourceUri?: string; + + /** + * The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y + */ + termDuration?: string; + + /** + * Start date of the term in UTC time. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + termStartDate?: utcDateTime; + + /** + * End date of the term in UTC time. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + termEndDate?: utcDateTime; + + /** + * The tenant in which the subscription is provisioned. + */ + provisioningTenantId?: string; + + /** + * The status of the subscription. This field is not available for Enterprise Agreement billing accounts + */ + @visibility(Lifecycle.Read) + status?: BillingSubscriptionStatus; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + operationStatus?: BillingSubscriptionOperationStatus; + + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The ID of the subscription. + */ + @visibility(Lifecycle.Read) + subscriptionId?: string; + + /** + * The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + suspensionReasons?: string[]; + + /** + * The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + suspensionReasonDetails?: BillingSubscriptionStatusDetails[]; +} + +/** + * Details of the beneficiary. + */ +model Beneficiary { + /** + * The ID that uniquely identifies a tenant. + */ + tenantId?: string; + + /** + * The ID that uniquely identifies a user in a tenant. + */ + objectId?: string; +} + +/** + * The billing properties that can be modified. Available only for the Enterprise Agreement Type. + */ +model EnrollmentAccountSubscriptionDetails { + /** + * The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + enrollmentAccountStartDate?: utcDateTime; + + /** + * The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. + */ + @visibility(Lifecycle.Read) + subscriptionEnrollmentAccountStatus?: SubscriptionEnrollmentAccountStatus; +} + +/** + * Billing cycle details of the product. + */ +model NextBillingCycleDetails { + /** + * Billing frequency of the product under the subscription. + */ + @visibility(Lifecycle.Read) + billingFrequency?: string; +} + +/** + * Details of the reseller. + */ +model Reseller { + /** + * The MPN ID of the reseller. + */ + @visibility(Lifecycle.Read) + resellerId?: string; + + /** + * The name of the reseller. + */ + @visibility(Lifecycle.Read) + description?: string; +} + +/** + * Details for the next renewal term of a subscription. + */ +model RenewalTermDetails { + /** + * The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y + */ + @visibility(Lifecycle.Read) + billingFrequency?: string; + + /** + * Id of the product for which the subscription is purchased. + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * Type Id of the product for which the subscription is purchased. + */ + @visibility(Lifecycle.Read) + productTypeId?: string; + + /** + * The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. + */ + @visibility(Lifecycle.Read) + skuId?: string; + + /** + * The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y + */ + @visibility(Lifecycle.Read) + termDuration?: string; + + /** + * The quantity of licenses or fulfillment units for the subscription. + */ + quantity?: int64; + + /** + * End date of the term in UTC time. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + termEndDate?: utcDateTime; +} + +/** + * System imposed policies that regulate behavior of the subscription. + */ +model SystemOverrides { + /** + * The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. + */ + @visibility(Lifecycle.Read) + cancellation?: Cancellation; + + /** + * The end date in UTC time by when the self-serve cancellation ends. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + cancellationAllowedEndDate?: utcDateTime; +} + +/** + * A billing subscription alias. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingSubscriptionAliasProperties extends BillingSubscriptionProperties { + /** + * The ID of the billing subscription with the subscription alias. + */ + @visibility(Lifecycle.Read) + billingSubscriptionId?: string; + + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +/** + * Request parameters for cancel customer subscription. + */ +model CancelSubscriptionRequest { + /** + * Cancellation reason. + */ + cancellationReason: CancellationReason; + + /** + * The fully qualified ID that uniquely identifies a customer. + */ + customerId?: string; +} + +/** + * Request parameters that are provided to merge the two billing subscriptions. + */ +model BillingSubscriptionMergeRequest { + /** + * The ID of the target billing subscription that will be merged with the source subscription provided in the request. + */ + targetBillingSubscriptionName?: string; + + /** + * The quantity of the source billing subscription that will be merged with the target billing subscription. + */ + quantity?: int32; +} + +/** + * Request parameters to transfer billing subscription. + */ +model MoveBillingSubscriptionRequest { + /** + * The destination invoice section id. + */ + destinationInvoiceSectionId?: string; + + /** + * The destination enrollment account id. + */ + destinationEnrollmentAccountId?: string; +} + +/** + * Request parameters that are provided to split the billing subscription. + */ +model BillingSubscriptionSplitRequest { + /** + * 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. + */ + targetProductTypeId?: string; + + /** + * 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. + */ + targetSkuId?: string; + + /** + * The quantity of the target product to which the subscription needs to be split into. + */ + quantity?: int32; + + /** + * The term duration of the target in ISO8601 format product to which the subscription needs to be split into. Example: P1M, P1Y + */ + termDuration?: string; + + /** + * The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y" + */ + billingFrequency?: string; +} + +/** + * Result of the transfer eligibility validation. + */ +model MoveBillingSubscriptionEligibilityResult { + /** + * Specifies whether the subscription is eligible to be transferred. + */ + @visibility(Lifecycle.Read) + isMoveEligible?: boolean; + + /** + * Error details of the transfer eligibility validation. + */ + errorDetails?: MoveBillingSubscriptionErrorDetails; +} + +/** + * Error details of the transfer eligibility validation. + */ +model MoveBillingSubscriptionErrorDetails { + /** + * Error code of the transfer validation response. + */ + code?: SubscriptionTransferValidationErrorCode; + + /** + * The error message. + */ + message?: string; + + /** + * Detailed error message explaining the error. + */ + details?: string; +} + +/** + * The billing properties of a subscription. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingSubscriptionPatch extends ProxyResourceWithTags { + /** + * The properties of a(n) BillingSubscription + */ + properties?: BillingSubscriptionProperties; +} + +/** + * A partner's customer. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model CustomerProperties { + /** + * The name of the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * The name of the customer. + */ + @visibility(Lifecycle.Read) + displayName?: string; + + /** + * The system generated unique identifier for a customer. + */ + @visibility(Lifecycle.Read) + systemId?: string; + + /** + * Identifies the status of an customer. This is an upcoming property that will be populated in the future. + */ + @visibility(Lifecycle.Read) + status?: CustomerStatus; + + /** + * Azure plans enabled for the customer. + */ + @identifiers(#[]) + enabledAzurePlans?: AzurePlan[]; + + /** + * The list of resellers for which an Azure plan is enabled for the customer. + */ + @identifiers(#[]) + resellers?: Reseller[]; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +/** + * Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DepartmentProperties { + /** + * The cost center associated with the department. + */ + costCenter?: string; + + /** + * The name of the department. + */ + displayName?: string; + + /** + * The ID that uniquely identifies the department. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + id?: string; + + /** + * The status of the department. + */ + @visibility(Lifecycle.Read) + status?: string; +} + +/** + * It is an organizational hierarchy within a billing account to administer and manage azure costs. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model EnrollmentAccountProperties { + /** + * The cost center associated with the enrollment account. + */ + costCenter?: string; + + /** + * The name of the enrollment account. + */ + displayName?: string; + + /** + * The name of the department under which the enrollment account exists. + */ + @visibility(Lifecycle.Read) + departmentDisplayName?: string; + + /** + * The ID that uniquely identifies the department. + */ + @visibility(Lifecycle.Read) + departmentId?: string; + + /** + * Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. + */ + isDevTestEnabled?: boolean; + + /** + * The owner of the enrollment account. + */ + @visibility(Lifecycle.Read) + accountOwner?: string; + + /** + * The authorization type of the enrollment account. + */ + @visibility(Lifecycle.Read) + authType?: string; + + /** + * The status of the enrollment account. + */ + @visibility(Lifecycle.Read) + status?: string; + + /** + * The date from which the enrollment account became valid and functional. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate?: utcDateTime; + + /** + * The date of expiration of the enrollment account. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate?: utcDateTime; +} + +/** + * An invoice. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoiceProperties { + /** + * The amount due as of now. + */ + amountDue?: InvoicePropertiesAmountDue; + + /** + * The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ + azurePrepaymentApplied?: InvoicePropertiesAzurePrepaymentApplied; + + /** + * The total charges for the invoice billing period. + */ + billedAmount?: InvoicePropertiesBilledAmount; + + /** + * The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. + */ + @visibility(Lifecycle.Read) + billedDocumentId?: string; + + /** + * The name of the billing profile for which the invoice is generated. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The ID of the billing profile for which the invoice is generated. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * 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. + */ + creditAmount?: InvoicePropertiesCreditAmount; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + creditForDocumentId?: string; + + /** + * List of documents available to download and view such as invoice, credit note, or tax receipt. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + documents?: InvoiceDocument[]; + + /** + * The type of the document. + */ + @visibility(Lifecycle.Read) + documentType?: InvoiceDocumentType; + + /** + * The due date for the invoice. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + dueDate?: utcDateTime; + + /** + * List of failed payments. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + failedPayments?: FailedPayment[]; + + /** + * The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ + freeAzureCreditApplied?: InvoicePropertiesFreeAzureCreditApplied; + + /** + * The date when the invoice was generated. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + invoiceDate?: utcDateTime; + + /** + * The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + invoicePeriodEndDate?: utcDateTime; + + /** + * The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + invoicePeriodStartDate?: utcDateTime; + + /** + * Invoice type. + */ + @visibility(Lifecycle.Read) + invoiceType?: InvoiceType; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + isMonthlyInvoice?: boolean; + + /** + * List of payments. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + payments?: Payment[]; + + /** + * An optional purchase order number for the invoice. + */ + @visibility(Lifecycle.Read) + purchaseOrderNumber?: string; + + /** + * Rebill details for an invoice. + */ + rebillDetails?: InvoicePropertiesRebillDetails; + + /** + * The current status of the invoice. + */ + @visibility(Lifecycle.Read) + status?: InvoiceStatus; + + /** + * The name of the billing subscription for which the invoice is generated. + */ + @visibility(Lifecycle.Read) + subscriptionDisplayName?: string; + + /** + * The ID of the subscription for which the invoice is generated. + */ + @visibility(Lifecycle.Read) + subscriptionId?: string; + + /** + * Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. + */ + @visibility(Lifecycle.Read) + specialTaxationType?: SpecialTaxationType; + + /** + * The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ + subTotal?: InvoicePropertiesSubTotal; + + /** + * The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ + taxAmount?: InvoicePropertiesTaxAmount; + + /** + * The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ + totalAmount?: InvoicePropertiesTotalAmount; + + /** + * The details of a refund request. + */ + refundDetails?: InvoicePropertiesRefundDetails; +} + +/** + * The amount due as of now. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesAmountDue extends Amount {} + +/** + * The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesAzurePrepaymentApplied extends Amount {} + +/** + * The total charges for the invoice billing period. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesBilledAmount extends Amount {} + +/** + * 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. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesCreditAmount extends Amount {} + +/** + * The properties of a document. + */ +model InvoiceDocument { + /** + * The document numbers for the invoice document. + */ + @visibility(Lifecycle.Read) + documentNumbers?: string[]; + + /** + * The URL to download the invoice document if the source is external to Microsoft.Billing. + */ + @visibility(Lifecycle.Read) + externalUrl?: string; + + /** + * The type of the document. + */ + @visibility(Lifecycle.Read) + kind?: InvoiceDocumentType; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * The URL to download the invoice document if the source is internal to Microsoft.Billing. + */ + @visibility(Lifecycle.Read) + url?: string; + + /** + * The source of the document. ENF for Brazil and DRS for rest of the world. + */ + @visibility(Lifecycle.Read) + source?: DocumentSource; +} + +/** + * A failed payment. + */ +model FailedPayment { + /** + * The date when the payment was attempted. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + date?: utcDateTime; + + /** + * The reason that the payment failed. + */ + @visibility(Lifecycle.Read) + failedPaymentReason?: FailedPaymentReason; +} + +/** + * The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesFreeAzureCreditApplied extends Amount {} + +/** + * An invoice payment. + */ +model Payment { + /** + * The paid amount. + */ + amount?: PaymentAmount; + + /** + * The date when the payment was made. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + date?: utcDateTime; + + /** + * The ID that uniquely identifies the payment method used for the invoice. + */ + @visibility(Lifecycle.Read) + paymentMethodId?: string; + + /** + * The family of payment method. + */ + @visibility(Lifecycle.Read) + paymentMethodFamily?: PaymentMethodFamily; + + /** + * The type of payment method. + */ + @visibility(Lifecycle.Read) + paymentMethodType?: string; + + /** + * The type of payment. + */ + @visibility(Lifecycle.Read) + paymentType?: string; +} + +/** + * The paid amount. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PaymentAmount extends Amount {} + +/** + * Rebill details for an invoice. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesRebillDetails extends RebillDetails {} + +/** + * The rebill details of an invoice. + */ +model RebillDetails { + /** + * The ID of invoice. + */ + @visibility(Lifecycle.Read) + invoiceDocumentId?: string; + + /** + * The ID of credit note. + */ + @visibility(Lifecycle.Read) + creditNoteDocumentId?: string; + + /** + * The rebill details of an invoice. + */ + #suppress "@azure-tools/typespec-client-generator-core/property-name-conflict" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + rebillDetails?: RebillDetails; +} + +/** + * The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesSubTotal extends Amount {} + +/** + * The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesTaxAmount extends Amount {} + +/** + * The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesTotalAmount extends Amount {} + +/** + * The details of a refund request. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model InvoicePropertiesRefundDetails extends RefundDetailsSummary {} + +/** + * The details of refund request. + */ +model RefundDetailsSummary { + /** + * Date when the refund was requested. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + requestedOn?: utcDateTime; + + /** + * Date when the refund was approved. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + approvedOn?: utcDateTime; + + /** + * Date when the refund was completed. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + completedOn?: utcDateTime; + + /** + * The amount of refund requested. + */ + amountRequested?: RefundDetailsSummaryAmountRequested; + + /** + * The amount refunded. + */ + amountRefunded?: RefundDetailsSummaryAmountRefunded; + + /** + * The invoice ID of the rebill invoice for a refund. + */ + @visibility(Lifecycle.Read) + rebillInvoiceId?: string; + + /** + * The number of transactions refunded. + */ + @visibility(Lifecycle.Read) + transactionCount?: int32; + + /** + * The status of refund request. + */ + @visibility(Lifecycle.Read) + refundStatus?: RefundStatus; + + /** + * The ID of refund operation. + */ + @visibility(Lifecycle.Read) + refundOperationId?: string; + + /** + * The reason for refund. + */ + @visibility(Lifecycle.Read) + refundReason?: RefundReasonCode; +} + +/** + * The amount of refund requested. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model RefundDetailsSummaryAmountRequested extends Amount {} + +/** + * The amount refunded. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model RefundDetailsSummaryAmountRefunded extends Amount {} + +/** + * A list of download details for individual documents. + */ +model DocumentDownloadRequest { + /** + * 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. + */ + documentName?: string; + + /** + * The ID that uniquely identifies an invoice. + */ + invoiceName?: string; +} + +/** + * A secure URL that can be used to download a an entity until the URL expires. + */ +model DocumentDownloadResult { + /** + * The time in UTC when the download URL will expire. + */ + @visibility(Lifecycle.Read) + expiryTime?: string; + + /** + * The URL to the PDF or .zip file. + */ + @visibility(Lifecycle.Read) + url?: string; +} + +/** + * Eligibility to delete an invoice section result. + */ +model DeleteInvoiceSectionEligibilityResult { + /** + * Status describing if invoice section is eligible to be deleted. + */ + eligibilityStatus?: DeleteInvoiceSectionEligibilityStatus; + + /** + * A list of delete invoice section eligibility result details. + */ + @identifiers(#[]) + eligibilityDetails?: DeleteInvoiceSectionEligibilityDetail[]; +} + +/** + * The details of delete invoice section eligibility result. + */ +model DeleteInvoiceSectionEligibilityDetail { + /** + * Code for the delete invoice section validation. + */ + code?: DeleteInvoiceSectionEligibilityCode; + + /** + * Validation message. + */ + message?: string; +} + +/** + * An invoice section. + */ +model InvoiceSectionProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The name of the invoice section. + */ + displayName?: string; + + /** + * Identifies the status of an invoice section. + */ + state?: InvoiceSectionState; + + /** + * Reason for the specified invoice section status. + */ + reasonCode?: InvoiceSectionStateReasonCode; + + /** + * The system generated unique identifier for an invoice section. + */ + @visibility(Lifecycle.Read) + systemId?: string; + + /** + * 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. + */ + targetCloud?: string; + + /** + * 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 < > % & \ ? / + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +/** + * 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. + */ +model OperationListResult { + /** + * List of billing operations supported by the Microsoft.Billing resource provider. + */ + @visibility(Lifecycle.Read) + @identifiers(#["name"]) + @pageItems + value?: Operation[]; + + /** + * URL to get the next set of operation list results if there are any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: url; +} + +/** + * Details of a REST API operation, returned from the Resource Provider Operations API. + */ +model Operation { + /** + * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action". + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. + */ + @visibility(Lifecycle.Read) + isDataAction?: boolean; + + /** + * Localized display information for this particular operation. + */ + display?: OperationDisplay; +} + +/** + * Localized display information for this particular operation. + */ +model OperationDisplay { + /** + * The short, localized friendly description of the operation; suitable for tool tips and detailed views. + */ + @visibility(Lifecycle.Read) + description?: string; + + /** + * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". + */ + @visibility(Lifecycle.Read) + operation?: string; + + /** + * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". + */ + @visibility(Lifecycle.Read) + provider?: string; + + /** + * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". + */ + @visibility(Lifecycle.Read) + resource?: string; +} + +/** + * The properties of a payment method link. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PaymentMethodLinkProperties { + /** + * The account holder name for the payment method. This is only supported for payment methods with family CreditCard. + */ + @visibility(Lifecycle.Read) + accountHolderName?: string; + + /** + * The display name of the payment method. + */ + @visibility(Lifecycle.Read) + displayName?: string; + + /** + * The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. + */ + @visibility(Lifecycle.Read) + expiration?: string; + + /** + * The family of payment method. + */ + @visibility(Lifecycle.Read) + family?: PaymentMethodFamily; + + /** + * Last four digits of payment method. + */ + @visibility(Lifecycle.Read) + lastFourDigits?: string; + + /** + * The list of logos for the payment method. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + logos?: PaymentMethodLogo[]; + + /** + * Projection of a payment method. Will not be returned in this or future versions. + */ + paymentMethod?: PaymentMethodProperties; + + /** + * Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0 + */ + paymentMethodId?: string; + + /** + * The type of payment method. + */ + @visibility(Lifecycle.Read) + paymentMethodType?: string; + + /** + * Status of the payment method. + */ + @visibility(Lifecycle.Read) + status?: PaymentMethodStatus; +} + +/** + * Logo of payment method. + */ +model PaymentMethodLogo { + /** + * MIME type of the logo. + */ + @visibility(Lifecycle.Read) + mimeType?: string; + + /** + * Public URL of image of the logo. + */ + @visibility(Lifecycle.Read) + url?: string; +} + +/** + * The properties of a payment method. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PaymentMethodProperties { + /** + * Id of payment method. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + id?: string; + + /** + * The account holder name for the payment method. This is only supported for payment methods with family CreditCard. + */ + @visibility(Lifecycle.Read) + accountHolderName?: string; + + /** + * The display name of the payment method. + */ + @visibility(Lifecycle.Read) + displayName?: string; + + /** + * The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. + */ + @visibility(Lifecycle.Read) + expiration?: string; + + /** + * The family of payment method. + */ + family?: PaymentMethodFamily; + + /** + * Last four digits of payment method. + */ + @visibility(Lifecycle.Read) + lastFourDigits?: string; + + /** + * The list of logos for the payment method. + */ + @identifiers(#[]) + logos?: PaymentMethodLogo[]; + + /** + * The type of payment method. + */ + @visibility(Lifecycle.Read) + paymentMethodType?: string; + + /** + * Status of the payment method. + */ + status?: PaymentMethodStatus; +} + +/** + * A policy at customer scope. + */ +model CustomerPolicyProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. + */ + viewCharges: ViewChargesPolicy; + + /** + * List of all policies defined at the billing scope. + */ + @identifiers(#["name"]) + policies?: PolicySummary[]; +} + +/** + * The summary of the policy. + */ +model PolicySummary { + /** + * The name of the policy. + */ + name?: string; + + /** + * The value of the policy. + */ + value?: string; + + /** + * The type of the policy. + */ + policyType?: PolicyType; + + /** + * The scope at which the policy is defined. + */ + scope?: string; +} + +/** + * A policy at billing profile scope. + */ +model BillingProfilePolicyProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The policies for Enterprise Agreement enrollments. + */ + enterpriseAgreementPolicies?: BillingProfilePolicyPropertiesEnterpriseAgreementPolicies; + + /** + * The policy that controls invoice section label management at invoice section scope. This is allowed by default. + */ + invoiceSectionLabelManagement?: InvoiceSectionLabelManagementPolicy; + + /** + * The policy that controls whether Azure marketplace purchases are allowed. + */ + marketplacePurchases?: MarketplacePurchasesPolicy; + + /** + * The policy that controls whether Azure reservation purchases are allowed. + */ + reservationPurchases?: ReservationPurchasesPolicy; + + /** + * The policy that controls whether users with Azure savings plan purchase are allowed. + */ + savingsPlanPurchases?: SavingsPlanPurchasesPolicy; + + /** + * The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. + */ + viewCharges?: ViewChargesPolicy; + + /** + * List of all policies defined at the billing scope. + */ + @identifiers(#["name"]) + policies?: PolicySummary[]; +} + +/** + * The policies for Enterprise Agreement enrollments. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingProfilePolicyPropertiesEnterpriseAgreementPolicies + extends EnterpriseAgreementPolicies {} + +/** + * The policies for Enterprise Agreement enrollments. + */ +model EnterpriseAgreementPolicies { + /** + * The state showing the enrollment auth level. + */ + authenticationType?: EnrollmentAuthLevelState; + + /** + * The policy that controls whether account owner can view charges. + */ + accountOwnerViewCharges?: EnrollmentAccountOwnerViewCharges; + + /** + * The policy that controls whether department admin can view charges. + */ + departmentAdminViewCharges?: EnrollmentDepartmentAdminViewCharges; +} + +/** + * A policy at billing account scope. + */ +model BillingAccountPolicyProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * The policies for Enterprise Agreement enrollments. + */ + enterpriseAgreementPolicies?: BillingAccountPolicyPropertiesEnterpriseAgreementPolicies; + + /** + * The policy that controls whether Azure marketplace purchases are allowed. + */ + marketplacePurchases?: MarketplacePurchasesPolicy; + + /** + * The policy that controls whether Azure reservation purchases are allowed. + */ + reservationPurchases?: ReservationPurchasesPolicy; + + /** + * The policy that controls whether users with Azure savings plan purchase are allowed. + */ + savingsPlanPurchases?: SavingsPlanPurchasesPolicy; + + /** + * List of all policies defined at the billing scope. + */ + @identifiers(#["name"]) + policies?: PolicySummary[]; +} + +/** + * The policies for Enterprise Agreement enrollments. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BillingAccountPolicyPropertiesEnterpriseAgreementPolicies + extends EnterpriseAgreementPolicies {} + +/** + * A policy at subscription scope. + */ +model SubscriptionPolicyProperties { + /** + * The provisioning state of the resource during a long-running operation. + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * List of all policies defined at the billing scope. + */ + @identifiers(#["name"]) + policies?: PolicySummary[]; +} + +/** + * A product. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductProperties { + /** + * Indicates whether auto renewal is turned on or off for a product. + */ + autoRenew?: AutoRenew; + + /** + * The availability of the product. + */ + @visibility(Lifecycle.Read) + availabilityId?: string; + + /** + * The frequency at which the product will be billed. + */ + @visibility(Lifecycle.Read) + billingFrequency?: string; + + /** + * The ID of the billing profile to which the product is billed. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * The name of the billing profile to which the product is billed. + */ + @visibility(Lifecycle.Read) + billingProfileDisplayName?: string; + + /** + * The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. + */ + @visibility(Lifecycle.Read) + customerId?: string; + + /** + * The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. + */ + @visibility(Lifecycle.Read) + customerDisplayName?: string; + + /** + * The display name of the product. + */ + @visibility(Lifecycle.Read) + displayName?: string; + + /** + * The date when the product will be renewed or canceled. + */ + @visibility(Lifecycle.Read) + endDate?: string; + + /** + * The ID of the invoice section to which the product is billed. + */ + @visibility(Lifecycle.Read) + invoiceSectionId?: string; + + /** + * The name of the invoice section to which the product is billed. + */ + @visibility(Lifecycle.Read) + invoiceSectionDisplayName?: string; + + /** + * The last month charges. + */ + lastCharge?: ProductPropertiesLastCharge; + + /** + * The date of the last charge. + */ + @visibility(Lifecycle.Read) + lastChargeDate?: string; + + /** + * The description of the type of product. + */ + @visibility(Lifecycle.Read) + productType?: string; + + /** + * The ID of the type of product. + */ + @visibility(Lifecycle.Read) + productTypeId?: string; + + /** + * The sku ID of the product. + */ + @visibility(Lifecycle.Read) + skuId?: string; + + /** + * The sku description of the product. + */ + @visibility(Lifecycle.Read) + skuDescription?: string; + + /** + * The date when the product was purchased. + */ + @visibility(Lifecycle.Read) + purchaseDate?: string; + + /** + * The quantity purchased for the product. + */ + @visibility(Lifecycle.Read) + quantity?: int64; + + /** + * The status of the product. + */ + @visibility(Lifecycle.Read) + status?: ProductStatus; + + /** + * The id of the tenant in which the product is used. + */ + @visibility(Lifecycle.Read) + tenantId?: string; + + /** + * Reseller for this product. The fields is not available for Microsoft Partner Agreement products. + */ + reseller?: ProductPropertiesReseller; +} + +/** + * The last month charges. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductPropertiesLastCharge extends Amount {} + +/** + * Reseller for this product. The fields is not available for Microsoft Partner Agreement products. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductPropertiesReseller extends Reseller {} + +/** + * The properties of the product to initiate a transfer. + */ +model MoveProductRequest { + /** + * The destination invoice section id. + */ + @minLength(1) + destinationInvoiceSectionId: string; +} + +/** + * Result of the transfer eligibility validation. + */ +model MoveProductEligibilityResult { + /** + * Specifies whether the subscription is eligible to be transferred. + */ + isMoveEligible?: boolean; + + /** + * Error details of the transfer eligibility validation. + */ + errorDetails?: MoveProductEligibilityResultErrorDetails; +} + +/** + * Error details of the transfer eligibility validation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model MoveProductEligibilityResultErrorDetails + extends MoveProductErrorDetails {} + +/** + * Error details of the transfer eligibility validation. + */ +model MoveProductErrorDetails { + /** + * Error code for the product transfer validation. + */ + @visibility(Lifecycle.Read) + code?: MoveValidationErrorCode; + + /** + * The error message. + */ + @visibility(Lifecycle.Read) + message?: string; + + /** + * Error details of the transfer eligibility validation. + */ + @visibility(Lifecycle.Read) + details?: string; +} + +/** + * A product. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductPatch extends ProxyResourceWithTags { + /** + * A product. + */ + properties?: ProductProperties; +} + +/** + * The roll up count summary of reservations in each state + */ +model ReservationSummary { + /** + * The number of reservation in Cancelled state + */ + @visibility(Lifecycle.Read) + cancelledCount?: float32; + + /** + * The number of reservation in Expired state + */ + @visibility(Lifecycle.Read) + expiredCount?: float32; + + /** + * The number of reservation in Expiring state + */ + @visibility(Lifecycle.Read) + expiringCount?: float32; + + /** + * The number of reservation in Failed state + */ + @visibility(Lifecycle.Read) + failedCount?: float32; + + /** + * The number of reservation in Pending state + */ + @visibility(Lifecycle.Read) + pendingCount?: float32; + + /** + * The number of reservation in Succeeded state + */ + @visibility(Lifecycle.Read) + succeededCount?: float32; + + /** + * The number of reservation in 'No Benefit' state + */ + @visibility(Lifecycle.Read) + noBenefitCount?: float32; + + /** + * The number of reservation in Warning state + */ + @visibility(Lifecycle.Read) + warningCount?: float32; + + /** + * The number of reservation in Processing state + */ + @visibility(Lifecycle.Read) + processingCount?: float32; +} + +/** + * The property of reservation object. + */ +model ReservationProperty { + /** + * The reserved source type of the reservation, e.g. virtual machine. + */ + @visibility(Lifecycle.Read) + reservedResourceType?: string; + + /** + * Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. + */ + instanceFlexibility?: InstanceFlexibility; + + /** + * The display name of the reservation + */ + @visibility(Lifecycle.Read) + displayName?: string; + + /** + * The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope + */ + appliedScopes?: string[]; + + /** + * The applied scope type of the reservation. + */ + @visibility(Lifecycle.Read) + appliedScopeType?: string; + + /** + * Indicates if the reservation is archived + */ + archived?: boolean; + + /** + * Capabilities of the reservation + */ + capabilities?: string; + + /** + * The number of the reservation. + */ + @visibility(Lifecycle.Read) + quantity?: float32; + + /** + * The provisioning state of the reservation, e.g. Succeeded + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; + + /** + * The effective date time of the reservation + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveDateTime?: utcDateTime; + + /** + * This is the DateTime when the reservation benefit started. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + benefitStartTime?: utcDateTime; + + /** + * DateTime of the last time the reservation was updated. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + lastUpdatedDateTime?: utcDateTime; + + /** + * The expiry date of the reservation + */ + @visibility(Lifecycle.Read) + expiryDate?: string; + + /** + * This is the date-time when the reservation will expire. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiryDateTime?: utcDateTime; + + /** + * This is the date-time when the Azure Hybrid Benefit needs to be reviewed. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + reviewDateTime?: utcDateTime; + + /** + * The sku description of the reservation + */ + @visibility(Lifecycle.Read) + skuDescription?: string; + + /** + * The message giving detailed information about the status code. + */ + extendedStatusInfo?: ReservationExtendedStatusInfo; + + /** + * The billing plan options available for this sku. + */ + billingPlan?: ReservationBillingPlan; + + /** + * The provisioning state of the reservation for display, e.g. Succeeded + */ + @visibility(Lifecycle.Read) + displayProvisioningState?: string; + + /** + * The provisioning state of the reservation, e.g. Succeeded + */ + @visibility(Lifecycle.Read) + provisioningSubState?: string; + + /** + * This is the date when the reservation was purchased. + */ + purchaseDate?: plainDate; + + /** + * This is the date-time when the reservation was purchased. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + purchaseDateTime?: utcDateTime; + + /** + * Properties of reservation split + */ + splitProperties?: ReservationSplitProperties; + + /** + * Properties of reservation merge + */ + mergeProperties?: ReservationMergeProperties; + + /** + * Properties of reservation swap + */ + swapProperties?: ReservationSwapProperties; + + /** + * Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup + */ + appliedScopeProperties?: ReservationAppliedScopeProperties; + + /** + * Subscription that will be charged for purchasing reservation or savings plan + */ + @visibility(Lifecycle.Read) + billingScopeId?: string; + + /** + * The renew state of the reservation + */ + @visibility(Lifecycle.Read) + renew?: boolean; + + /** + * The renew source of the reservation + */ + @visibility(Lifecycle.Read) + renewSource?: string; + + /** + * Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. + */ + renewDestination?: string; + + /** + * The renew properties for a reservation. + */ + renewProperties?: RenewPropertiesResponse; + + /** + * The term of the reservation, e.g. P1Y + */ + @visibility(Lifecycle.Read) + term?: string; + + /** + * The applied scope type of the reservation for display, e.g. Shared + */ + @visibility(Lifecycle.Read) + userFriendlyAppliedScopeType?: string; + + /** + * The renew state of the reservation for display, e.g. On + */ + @visibility(Lifecycle.Read) + userFriendlyRenewState?: string; + + /** + * Reservation utilization + */ + @visibility(Lifecycle.Read) + utilization?: ReservationPropertyUtilization; + + /** + * Represents UPN + */ + productCode?: string; +} + +/** + * Extended status information for the reservation. + */ +model ReservationExtendedStatusInfo { + /** + * The status of the reservation. + */ + statusCode?: ReservationStatusCode; + + /** + * The message giving detailed information about the status code. + */ + message?: string; + + /** + * Properties for extended status information + */ + properties?: ExtendedStatusDefinitionProperties; +} + +/** + * Extended status definition properties + */ +model ExtendedStatusDefinitionProperties { + /** + * Subscription Id + */ + subscriptionId?: string; +} + +/** + * Properties of reservation split + */ +model ReservationSplitProperties { + /** + * List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + */ + splitDestinations?: string[]; + + /** + * Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + */ + splitSource?: string; +} + +/** + * Properties of reservation merge + */ +model ReservationMergeProperties { + /** + * Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + */ + mergeDestination?: string; + + /** + * 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} + */ + mergeSources?: string[]; +} + +/** + * Properties of reservation swap + */ +model ReservationSwapProperties { + /** + * Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + */ + swapSource?: string; + + /** + * Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + */ + swapDestination?: string; +} + +/** + * Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup + */ +model ReservationAppliedScopeProperties { + /** + * Tenant ID where the reservation should apply benefit. + */ + tenantId?: string; + + /** + * Fully-qualified identifier of the management group where the benefit must be applied. + */ + managementGroupId?: string; + + /** + * Fully-qualified identifier of the subscription. + */ + subscriptionId?: string; + + /** + * Fully-qualified identifier of the resource group. + */ + resourceGroupId?: string; + + /** + * Display name + */ + displayName?: string; +} + +/** + * The renew properties for a reservation. + */ +model RenewPropertiesResponse { + /** + * The request for reservation purchase + */ + purchaseProperties?: ReservationPurchaseRequest; + + /** + * 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. + */ + pricingCurrencyTotal?: Price; + + /** + * Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. + */ + billingCurrencyTotal?: Price; +} + +/** + * The request for reservation purchase + */ +model ReservationPurchaseRequest { + /** + * The name of sku + */ + sku?: SkuName; + + /** + * The Azure region where the reserved resource lives. + */ + @visibility(Lifecycle.Read, Lifecycle.Create) + location?: string; + + /** + * Properties of reservation purchase request + */ + properties?: ReservationPurchaseRequestProperties; +} + +/** + * The name of sku + */ +model SkuName { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + name?: string; +} + +/** + * Properties of reservation purchase request + */ +model ReservationPurchaseRequestProperties { + /** + * The reserved source type of the reservation, e.g. virtual machine. + */ + @visibility(Lifecycle.Read) + reservedResourceType?: string; + + /** + * Subscription that will be charged for purchasing reservation or savings plan + */ + @visibility(Lifecycle.Read) + billingScopeId?: string; + + /** + * The term of the reservation, e.g. P1Y + */ + @visibility(Lifecycle.Read) + term?: string; + + /** + * Represent the billing plans. + */ + billingPlan?: ReservationBillingPlan; + + /** + * Quantity of the skus that are part of the reservation. Must be greater than zero. + */ + quantity?: int32; + + /** + * Friendly name of the reservation + */ + displayName?: string; + + /** + * Type of the Applied Scope. + */ + appliedScopeType?: AppliedScopeType; + + /** + * List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. + */ + appliedScopes?: string[]; + + /** + * Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup + */ + appliedScopeProperties?: ReservationAppliedScopeProperties; + + /** + * Setting this to true will automatically purchase a new benefit on the expiration date time. + */ + renew?: boolean = false; + + /** + * Properties specific to each reserved resource type. Not required if not applicable. + */ + reservedResourceProperties?: ReservationPurchaseRequestPropertiesReservedResourceProperties; + + /** + * Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. + */ + instanceFlexibility?: InstanceFlexibility; + + /** + * This is the date-time when the Azure hybrid benefit needs to be reviewed. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + reviewDateTime?: utcDateTime; +} + +/** + * Properties specific to each reserved resource type. Not required if not applicable. + */ +model ReservationPurchaseRequestPropertiesReservedResourceProperties { + /** + * Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + */ + instanceFlexibility?: InstanceFlexibility; +} + +/** + * Reservation utilization + */ +model ReservationPropertyUtilization { + /** + * last 7 day utilization trend for a reservation + */ + @visibility(Lifecycle.Read) + trend?: string; + + /** + * The array of aggregates of a reservation's utilization + */ + @identifiers(#[]) + aggregates?: ReservationUtilizationAggregates[]; +} + +/** + * The aggregate values of reservation utilization + */ +model ReservationUtilizationAggregates { + /** + * The grain of the aggregate + */ + @visibility(Lifecycle.Read) + grain?: float32; + + /** + * The grain unit of the aggregate + */ + @visibility(Lifecycle.Read) + grainUnit?: string; + + /** + * The aggregate value + */ + @visibility(Lifecycle.Read) + value?: float32; + + /** + * The aggregate value unit + */ + @visibility(Lifecycle.Read) + valueUnit?: string; +} + +/** + * The property of reservation sku object. + */ +model ReservationSkuProperty { + /** + * The name of the reservation sku. + */ + @visibility(Lifecycle.Read) + name?: string; +} + +/** + * The request for reservation patch + */ +model Patch { + /** + * Properties for reservation patch + */ + properties?: PatchProperties; + + /** + * The sku information associated to this reservation + */ + sku?: ReservationSkuProperty; + + /** + * Tags for this reservation + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +/** + * Properties for reservation patch + */ +model PatchProperties { + /** + * Type of the Applied Scope. + */ + appliedScopeType?: AppliedScopeType; + + /** + * Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup + */ + appliedScopeProperties?: ReservationAppliedScopeProperties; + + /** + * Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + */ + instanceFlexibility?: InstanceFlexibility; + + /** + * Display name of the reservation + */ + displayName?: string; + + /** + * Setting this to true will automatically purchase a new benefit on the expiration date time. + */ + renew?: boolean = false; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + renewProperties?: PatchPropertiesRenewProperties; + + /** + * This is the date-time when the Azure hybrid benefit needs to be reviewed. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + reviewDateTime?: utcDateTime; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PatchPropertiesRenewProperties { + /** + * The request for reservation purchase + */ + purchaseProperties?: ReservationPurchaseRequest; +} + +/** + * List of `Reservations` + */ +model ReservationList is Azure.Core.Page; + +/** + * Properties of a reservation order. + */ +model ReservationOrderProperty { + /** + * Friendly name for user to easily identified the reservation order. + */ + displayName?: string; + + /** + * Enrollment id of the reservation order. + */ + enrollmentId?: string; + + /** + * Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers. + */ + customerId?: string; + + /** + * Billing profile Id associated to this reservation order. + */ + billingProfileId?: string; + + /** + * Billing account Id associated to this reservation order. + */ + billingAccountId?: string; + + /** + * This is the DateTime when the reservation order was initially requested for purchase. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + requestDateTime?: utcDateTime; + + /** + * This is the DateTime when the reservation order was created. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDateTime?: utcDateTime; + + /** + * This is the date when the reservation order will expire. + */ + expiryDate?: plainDate; + + /** + * This is the date-time when the reservation order will expire. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiryDateTime?: utcDateTime; + + /** + * This is the DateTime when the reservation benefit started. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + benefitStartTime?: utcDateTime; + + /** + * Total original quantity of the skus purchased in the reservation order. + */ + originalQuantity?: int32; + + /** + * The term of the reservation, e.g. P1Y + */ + @visibility(Lifecycle.Read) + term?: string; + + /** + * The provisioning state of the reservation, e.g. Succeeded + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; + + /** + * Represent the billing plans. + */ + billingPlan?: ReservationBillingPlan; + + /** + * Information describing the type of billing plan for this reservation order. + */ + planInformation?: ReservationOrderBillingPlanInformation; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + reservations?: Reservation[]; + + /** + * This is the date-time when the Azure Hybrid Benefit needs to be reviewed. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + reviewDateTime?: utcDateTime; + + /** + * Extended status information for the reservation. + */ + extendedStatusInfo?: ReservationExtendedStatusInfo; + + /** + * Represents UPN + */ + productCode?: string; +} + +/** + * Information describing the type of billing plan for this reservation order. + */ +model ReservationOrderBillingPlanInformation { + /** + * Amount of money to be paid for the Order. Tax is not included. + */ + pricingCurrencyTotal?: Price; + + /** + * Date when the billing plan has started. + */ + startDate?: plainDate; + + /** + * For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. + */ + nextPaymentDueDate?: plainDate; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @identifiers(#[]) + transactions?: ReservationPaymentDetail[]; +} + +/** + * Information about payment related to a reservation order. + */ +model ReservationPaymentDetail { + /** + * Date when the payment needs to be done. + */ + dueDate?: plainDate; + + /** + * Date when the transaction is completed. Is null when it is scheduled. + */ + paymentDate?: plainDate; + + /** + * Amount in pricing currency. Tax not included. + */ + pricingCurrencyTotal?: Price; + + /** + * Amount charged in Billing currency. Tax not included. Is null for future payments + */ + billingCurrencyTotal?: Price; + + /** + * Shows the Account that is charged for this payment. + */ + billingAccount?: string; + + /** + * Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future. + */ + status?: PaymentStatus; + + /** + * Extended status information for the reservation. + */ + extendedStatusInfo?: ReservationExtendedStatusInfo; +} + +/** + * A transaction. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model Transaction extends ProxyResourceWithTags { + /** + * A transaction. + */ + properties?: TransactionProperties; +} + +/** + * A transaction. + */ +model TransactionProperties { + /** + * The amount of any Azure credits automatically applied to this transaction. + */ + azureCreditApplied?: TransactionPropertiesAzureCreditApplied; + + /** + * Details of the Azure plan. + */ + azurePlan?: string; + + /** + * The ISO 4217 code for the currency in which this transaction is billed. + */ + billingCurrency?: string; + + /** + * The name of the billing profile. + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + billingProfileDisplayName?: unknown; + + /** + * The fully qualified ID that uniquely identifies a billing profile. + */ + billingProfileId?: string; + + /** + * The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. + */ + consumptionCommitmentDecremented?: TransactionPropertiesConsumptionCommitmentDecremented; + + /** + * The name of the customer. + */ + customerDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies a customer. + */ + customerId?: string; + + /** + * The credit type of the transaction. Applies only to credited transactions. + */ + creditType?: CreditType; + + /** + * The date of transaction. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + date?: utcDateTime; + + /** + * The percentage discount, if any, applied to this transaction. + */ + discount?: float32; + + /** + * The price of the product after applying any discounts. + */ + effectivePrice?: TransactionPropertiesEffectivePrice; + + /** + * The exchange rate used to convert charged amount to billing currency, if applicable. + */ + exchangeRate?: float32; + + /** + * Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. + */ + invoice?: string; + + /** + * The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. + */ + invoiceId?: string; + + /** + * The name of the invoice section. + */ + invoiceSectionDisplayName?: string; + + /** + * The fully qualified ID that uniquely identifies an invoice section. + */ + invoiceSectionId?: string; + + /** + * Whether or not the transaction is third party. + */ + isThirdParty?: boolean; + + /** + * Type of the transaction, billed or unbilled. + */ + kind?: TransactionKind; + + /** + * The retail price of the product. + */ + marketPrice?: TransactionPropertiesMarketPrice; + + /** + * The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. + */ + partNumber?: string; + + /** + * The ISO 4217 code for the currency in which the product is priced. + */ + pricingCurrency?: string; + + /** + * The description of the product for which the transaction took place. + */ + productDescription?: string; + + /** + * The family of the product for which the transaction took place. + */ + productFamily?: string; + + /** + * The ID of the product type for which the transaction took place. + */ + productTypeId?: string; + + /** + * The type of the product for which the transaction took place. + */ + productType?: string; + + /** + * The quantity purchased in the transaction. + */ + quantity?: int32; + + /** + * There reason code for the transaction. + */ + reasonCode?: string; + + /** + * The date of the purchase of the product, or the start date of the month in which usage started. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + servicePeriodStartDate?: utcDateTime; + + /** + * The end date of the product term, or the end date of the month in which usage ended. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + servicePeriodEndDate?: utcDateTime; + + /** + * The pre-tax charged amount for the transaction. + */ + subTotal?: TransactionPropertiesSubTotal; + + /** + * The tax amount applied to the transaction. + */ + tax?: TransactionPropertiesTax; + + /** + * The charge associated with the transaction. + */ + transactionAmount?: TransactionPropertiesTransactionAmount; + + /** + * The type of transaction. + */ + transactionType?: string; + + /** + * The number of units used for a given product. + */ + units?: float32; + + /** + * The unit of measure used to bill for the product. For example, compute services are billed per hour. + */ + unitOfMeasure?: string; + + /** + * The description for the unit of measure for a given product. + */ + unitType?: string; + + /** + * Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. + */ + specialTaxationType?: SpecialTaxationType; + + /** + * The refund details of a transaction. + */ + refundTransactionDetails?: TransactionPropertiesRefundTransactionDetails; +} + +/** + * The amount of any Azure credits automatically applied to this transaction. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesAzureCreditApplied extends Amount {} + +/** + * The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesConsumptionCommitmentDecremented extends Amount {} + +/** + * The price of the product after applying any discounts. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesEffectivePrice extends Amount {} + +/** + * The retail price of the product. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesMarketPrice extends Amount {} + +/** + * The pre-tax charged amount for the transaction. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesSubTotal extends Amount {} + +/** + * The tax amount applied to the transaction. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesTax extends Amount {} + +/** + * The charge associated with the transaction. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesTransactionAmount extends Amount {} + +/** + * The refund details of a transaction. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransactionPropertiesRefundTransactionDetails + extends RefundTransactionDetails {} + +/** + * The refund details of a transaction. + */ +model RefundTransactionDetails { + /** + * The amount of refund requested. + */ + amountRequested?: RefundTransactionDetailsAmountRequested; + + /** + * The amount refunded. + */ + amountRefunded?: RefundTransactionDetailsAmountRefunded; + + /** + * The ID of refund operation. + */ + refundOperationId?: string; +} + +/** + * The amount of refund requested. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model RefundTransactionDetailsAmountRequested extends Amount {} + +/** + * The amount refunded. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model RefundTransactionDetailsAmountRefunded extends Amount {} + +/** + * A transaction summary. + */ +model TransactionSummary { + /** + * The total amount of any Azure credits applied. + */ + @visibility(Lifecycle.Read) + azureCreditApplied?: float32; + + /** + * The ISO 4217 code for the currency in which the transactions are billed. + */ + @visibility(Lifecycle.Read) + billingCurrency?: string; + + /** + * The total Microsoft Azure Consumption Commitment (MACC) decrement through the invoice. + */ + @visibility(Lifecycle.Read) + consumptionCommitmentDecremented?: float32; + + /** + * The total pre-tax charged amount. + */ + @visibility(Lifecycle.Read) + subTotal?: float32; + + /** + * The total tax amount applied. + */ + @visibility(Lifecycle.Read) + tax?: float32; + + /** + * The total charges. + */ + @visibility(Lifecycle.Read) + total?: float32; +} + +/** + * Transfer details + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TransferProperties { + /** + * The time at which the transfer request expires. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationTime?: utcDateTime; + + /** + * Overall transfer status. + */ + @visibility(Lifecycle.Read) + transferStatus?: TransferStatus; + + /** + * The email ID of the user to whom the transfer request was sent. + */ + @visibility(Lifecycle.Read) + recipientEmailId?: string; + + /** + * The email ID of the user who sent the transfer request. + */ + @visibility(Lifecycle.Read) + initiatorEmailId?: string; + + /** + * The email ID of the user who canceled the transfer request. + */ + @visibility(Lifecycle.Read) + canceledBy?: string; + + /** + * Detailed transfer status. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + detailedTransferStatus?: DetailedTransferStatus[]; +} + +/** + * Detailed transfer status. + */ +model DetailedTransferStatus { + /** + * Type of product that is transferred. + */ + @visibility(Lifecycle.Read) + productType?: ProductType; + + /** + * The ID of the product that is transferred. + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * The name of the product that is transferred. + */ + @visibility(Lifecycle.Read) + productName?: string; + + /** + * The SKU of the product that is transferred. + */ + @visibility(Lifecycle.Read) + skuDescription?: string; + + /** + * Transfer status. + */ + @visibility(Lifecycle.Read) + transferStatus?: ProductTransferStatus; + + /** + * Error details for transfer execution. + */ + errorDetails?: TransferError; +} + +/** + * Error details for transfer execution. + */ +model TransferError { + /** + * Error code. + */ + @visibility(Lifecycle.Read) + code?: string; + + /** + * Error message. + */ + @visibility(Lifecycle.Read) + message?: string; +} + +/** + * Request parameters to initiate transfer. + */ +model InitiateTransferRequest { + /** + * Request parameters to initiate transfer. + */ + properties?: InitiateTransferProperties; +} + +/** + * Request parameters to initiate transfer. + */ +model InitiateTransferProperties { + /** + * The email ID of the recipient to whom the transfer request is sent. + */ + recipientEmailId?: string; +} + +/** + * Transfer Details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PartnerTransferProperties { + /** + * The time at which the transfer request expires. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationTime?: utcDateTime; + + /** + * Overall transfer status. + */ + @visibility(Lifecycle.Read) + transferStatus?: TransferStatus; + + /** + * The email ID of the user to whom the transfer request was sent. + */ + @visibility(Lifecycle.Read) + recipientEmailId?: string; + + /** + * The type of customer who sent the transfer request. + */ + @visibility(Lifecycle.Read) + initiatorCustomerType?: InitiatorCustomerType; + + /** + * The email ID of the user who sent the transfer request. + */ + @visibility(Lifecycle.Read) + initiatorEmailId?: string; + + /** + * Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. + */ + @visibility(Lifecycle.Read) + resellerId?: string; + + /** + * Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. + */ + @visibility(Lifecycle.Read) + resellerName?: string; + + /** + * The email ID of the user who canceled the transfer request. + */ + @visibility(Lifecycle.Read) + canceledBy?: string; + + /** + * Detailed transfer status. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + detailedTransferStatus?: DetailedTransferStatus[]; +} + +/** + * Request parameters to initiate partner transfer. + */ +model PartnerInitiateTransferRequest { + /** + * Request parameters to initiate partner transfer. + */ + properties?: PartnerInitiateTransferProperties; +} + +/** + * Request parameters to initiate transfer. + */ +model PartnerInitiateTransferProperties { + /** + * The email ID of the recipient to whom the transfer request is sent. + */ + recipientEmailId?: string; + + /** + * Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. + */ + resellerId?: string; +} + +/** + * Request parameters to accept transfer. + */ +model AcceptTransferRequest { + /** + * Request parameters to accept transfer. + */ + properties?: AcceptTransferProperties; +} + +/** + * Request parameters to accept transfer. + */ +model AcceptTransferProperties { + /** + * Request parameters to accept transfer. + */ + @identifiers(#[]) + productDetails?: ProductDetails[]; +} + +/** + * Details of the product that is transferred. + */ +model ProductDetails { + /** + * Type of the product that is transferred. + */ + productType?: ProductType; + + /** + * The ID of the product that is transferred. + */ + productId?: string; +} + +/** + * Transfer Details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model RecipientTransferProperties { + /** + * The time at which the transfer request expires. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationTime?: utcDateTime; + + /** + * Type of subscriptions that can be transferred. + */ + @visibility(Lifecycle.Read) + allowedProductType?: EligibleProductType[]; + + /** + * Overall transfer status. + */ + @visibility(Lifecycle.Read) + transferStatus?: TransferStatus; + + /** + * The email ID of the user to whom the transfer request was sent. + */ + @visibility(Lifecycle.Read) + recipientEmailId?: string; + + /** + * The email ID of the user who sent the transfer request. + */ + @visibility(Lifecycle.Read) + initiatorEmailId?: string; + + /** + * Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. + */ + @visibility(Lifecycle.Read) + resellerId?: string; + + /** + * Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. + */ + @visibility(Lifecycle.Read) + resellerName?: string; + + /** + * The type of customer who sent the transfer request. + */ + @visibility(Lifecycle.Read) + initiatorCustomerType?: InitiatorCustomerType; + + /** + * The email ID of the user who canceled the transfer request. + */ + @visibility(Lifecycle.Read) + canceledBy?: string; + + /** + * Detailed transfer status. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + detailedTransferStatus?: DetailedTransferStatus[]; + + /** + * The customer tenant id. + */ + @visibility(Lifecycle.Read) + customerTenantId?: string; + + /** + * List of supported account types. + */ + @visibility(Lifecycle.Read) + supportedAccounts?: SupportedAccountType[]; +} + +/** + * Result of transfer validation. + */ +model ValidateTransferListResponse { + /** + * The list of transfer validation results. + */ + @visibility(Lifecycle.Read) + @pageItems + @identifiers(#[]) + value?: ValidateTransferResponse[]; +} + +/** + * Transfer validation response. + */ +model ValidateTransferResponse { + /** + * The properties of transfer validation response. + */ + properties?: ValidateTransferResponseProperties; +} + +/** + * The properties of transfer validation response. + */ +model ValidateTransferResponseProperties { + /** + * The status of validation + */ + @visibility(Lifecycle.Read) + status?: string; + + /** + * The product id for which this result applies. + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * The array of validation results. + */ + @identifiers(#[]) + results?: ValidationResultProperties[]; +} + +/** + * The properties of the validation result. + */ +model ValidationResultProperties { + /** + * Result Level. + */ + @visibility(Lifecycle.Read) + level?: string; + + /** + * Result Code. + */ + @visibility(Lifecycle.Read) + code?: string; + + /** + * The validation message. + */ + @visibility(Lifecycle.Read) + message?: string; +} + +/** + * The roll up count summary of savings plans in each state + */ +model SavingsPlanSummaryCount { + /** + * The number of savings plans in Succeeded state + */ + @visibility(Lifecycle.Read) + succeededCount?: float32; + + /** + * The number of savings plans in Failed state + */ + @visibility(Lifecycle.Read) + failedCount?: float32; + + /** + * The number of savings plans in Expiring state + */ + @visibility(Lifecycle.Read) + expiringCount?: float32; + + /** + * The number of savings plans in Expired state + */ + @visibility(Lifecycle.Read) + expiredCount?: float32; + + /** + * The number of savings plans in Pending state + */ + @visibility(Lifecycle.Read) + pendingCount?: float32; + + /** + * The number of savings plans in Cancelled state + */ + @visibility(Lifecycle.Read) + cancelledCount?: float32; + + /** + * The number of savings plans in Processing state + */ + @visibility(Lifecycle.Read) + processingCount?: float32; + + /** + * The number of savings plans in No Benefit state + */ + @visibility(Lifecycle.Read) + noBenefitCount?: float32; + + /** + * The number of savings plans in Warning state + */ + @visibility(Lifecycle.Read) + warningCount?: float32; +} + +/** + * An external reference. + */ +model ExternalReference { + /** + * The ID that uniquely identifies an external reference. + */ + @visibility(Lifecycle.Read) + id?: string; + + /** + * The URL of the external reference. + */ + @visibility(Lifecycle.Read) + url?: string; +} + +/** + * List of ReservationOrders + */ +model ReservationOrderList is Azure.Core.Page; + +/** + * Query parameter to enumerate transfer requests. + */ +model TransferItemQueryParameter { + /** + * State of the transfer request query filter. + */ + state?: string; +} + +/** + * The response of a PaymentMethodLink list operation. + */ +model PaymentMethodLinksListResult is Azure.Core.Page; + +/** + * The response of a PaymentMethod list operation. + */ +model PaymentMethodsListResult is Azure.Core.Page; + +/** + * The list of reservations and summary of roll out count of reservations in each state. + */ +model ReservationsListResult { + /** The link (url) to the next page of results. */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: url; + + /** The roll out count summary of the reservations */ + summary?: ReservationSummary; + + /** The list of reservations. */ + @pageItems + @visibility(Lifecycle.Read) + value?: Reservation[]; +} + +/** + * A container for a list of resources + */ +model BillingSubscriptionListResult { + /** The link (url) to the next page of results. */ + @visibility(Lifecycle.Read) + @nextLink + nextLink?: url; + + /** + * Total number of records. + */ + @visibility(Lifecycle.Read) + totalCount?: int32; + + /** The list of resources. */ + @visibility(Lifecycle.Read) + @pageItems + @identifiers(#["id"]) + value?: BillingSubscription[]; +} + +model AgreementListResult is Azure.Core.Page; + +model AssociatedTenantListResult is Azure.Core.Page; + +model BillingProfileListResult is Azure.Core.Page; + +model BillingRequestListResult is Azure.Core.Page; + +model BillingRoleAssignmentListResult is Azure.Core.Page; + +model BillingRoleDefinitionListResult is Azure.Core.Page; + +model BillingSubscriptionAliasListResult + is Azure.Core.Page; + +model CustomerListResult is Azure.Core.Page; + +model DepartmentListResult is Azure.Core.Page; + +model EnrollmentAccountListResult is Azure.Core.Page; + +model InvoiceListResult is Azure.Core.Page; + +model InvoiceSectionListResult is Azure.Core.Page; + +model ProductListResult is Azure.Core.Page; + +model TransactionListResult is Azure.Core.Page; + +model BillingAccountListResult is Azure.Core.Page; + +model PartnerTransferDetailsListResult + is Azure.Core.Page; + +model RecipientTransferDetailsListResult + is Azure.Core.Page; + +model TransferDetailsListResult is Azure.Core.Page; diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/readme.md b/specification/billing/resource-manager/Microsoft.Billing/Billing/readme.md index 4181340f2bbd..39dd9b38bfc4 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/readme.md +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/readme.md @@ -39,31 +39,7 @@ These settings apply only when `--tag=package-2024-04` is specified on the comma title: BillingManagementClient description: Billing Client input-file: -- stable/2024-04-01/agreement.json -- stable/2024-04-01/associatedTenant.json -- stable/2024-04-01/availableBalance.json -- stable/2024-04-01/billingAccount.json -- stable/2024-04-01/billingPermission.json -- stable/2024-04-01/billingProfile.json -- stable/2024-04-01/billingProperty.json -- stable/2024-04-01/billingRequest.json -- stable/2024-04-01/billingRoleAssignment.json -- stable/2024-04-01/billingRoleDefinition.json -- stable/2024-04-01/billingSavingsPlan.json -- stable/2024-04-01/billingSubscription.json -- stable/2024-04-01/customer.json -- stable/2024-04-01/department.json -- stable/2024-04-01/enrollmentAccount.json -- stable/2024-04-01/invoice.json -- stable/2024-04-01/invoiceSection.json -- stable/2024-04-01/operation.json -- stable/2024-04-01/payment.json -- stable/2024-04-01/policy.json -- stable/2024-04-01/product.json -- stable/2024-04-01/reservation.json -- stable/2024-04-01/transaction.json -- stable/2024-04-01/transfers.json -- stable/2024-04-01/types.json +- stable/2024-04-01/openapi.json suppressions: - code: AllProxyResourcesShouldHaveDelete from: billingRequest.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/routes.tsp b/specification/billing/resource-manager/Microsoft.Billing/Billing/routes.tsp new file mode 100644 index 000000000000..268afd6c5dd5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/routes.tsp @@ -0,0 +1,75 @@ +// FIXME: Operations in this file are not detected as a resource operation, please confirm the conversion result manually + +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using TypeSpec.OpenAPI; + +namespace Microsoft.Billing; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface AddressOperationGroup { + /** + * Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("BillingAccount") + @autoRoute + @action("validateAddress") + validate is ArmProviderActionSync< + Request = AddressDetails, + Response = AddressValidationResponse + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface InvoicesOperationGroup { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/billing/") + @tag("Invoice") + @autoRoute + @action("downloadDocuments") + @post + downloadDocumentsByBillingSubscription( + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.Billing", + + /** undefined */ + @path + @segment("billingAccounts") + @key + default: "default", + + /** The ID that uniquely identifies a billing subscription. */ + @path + @segment("billingSubscriptions") + @key + @pattern("^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$") + subscriptionId: string, + + ...ApiVersionParameter, + + /** A list of download details for individual documents. */ + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @body + @identifiers(#[]) + downloadUrls: DocumentDownloadRequest[], + ): ArmResponse | ArmAcceptedLroResponse< + "Resource operation accepted.", + LroHeaders = ArmLroLocationHeader + > | ErrorResponse; +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/agreement.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/agreement.json deleted file mode 100644 index 87b5c026063e..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/agreement.json +++ /dev/null @@ -1,315 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}": { - "get": { - "tags": [ - "Agreement" - ], - "description": "Gets an agreement by ID.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "Agreements_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "in": "path", - "name": "agreementName", - "description": "The ID that uniquely identifies an agreement.", - "required": true, - "type": "string", - "pattern": "^[a-fA-F0-9]{1,12}$" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A billing account.", - "schema": { - "$ref": "#/definitions/Agreement" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AgreementByName": { - "$ref": "./examples/agreementByName.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": { - "get": { - "tags": [ - "Agreement" - ], - "description": "Lists the agreements for a billing account.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "Agreements_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "May be used to expand the participants.", - "type": "string" - } - ], - "responses": { - "200": { - "description": "Result of listing agreements.", - "schema": { - "$ref": "#/definitions/AgreementListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AgreementsListByBillingAccount": { - "$ref": "./examples/agreementsListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Agreement": { - "description": "An agreement.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AgreementProperties" - } - }, - "x-ms-azure-resource": true - }, - "AgreementListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Agreement" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "AgreementProperties": { - "description": "An agreement.", - "type": "object", - "properties": { - "acceptanceMode": { - "description": "The mode of acceptance for an agreement.", - "enum": [ - "Other", - "ClickToAccept", - "ESignEmbedded", - "ESignOffline", - "Implicit", - "Offline", - "PhysicalSign" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AcceptanceMode", - "modelAsString": true - } - }, - "agreementLink": { - "description": "The URL to download the agreement.", - "type": "string", - "readOnly": true - }, - "billingProfileInfo": { - "description": "The list of billing profiles associated with agreement and present only for specific agreements.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingProfileInfo" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "category": { - "description": "The category of the agreement.", - "enum": [ - "Other", - "AffiliatePurchaseTerms", - "IndirectForGovernmentAgreement", - "MicrosoftCustomerAgreement", - "MicrosoftPartnerAgreement", - "UKCloudComputeFramework" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "Category", - "modelAsString": true - } - }, - "displayName": { - "description": "The name of the agreement signed by a customer.", - "type": "string", - "readOnly": true - }, - "effectiveDate": { - "format": "date-time", - "description": "The date from which the agreement is effective.", - "type": "string", - "readOnly": true - }, - "expirationDate": { - "format": "date-time", - "description": "The date when the agreement expires.", - "type": "string", - "readOnly": true - }, - "participants": { - "description": "The list of participants that participates in acceptance of an agreement.", - "type": "array", - "items": { - "$ref": "#/definitions/Participant" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "status": { - "description": "The current status of the agreement.", - "type": "string", - "readOnly": true - }, - "leadBillingAccountName": { - "description": "The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms.", - "type": "string", - "readOnly": true - } - } - }, - "BillingProfileInfo": { - "description": "Details about billing profile associated with agreement and available only for specific agreements.", - "type": "object", - "properties": { - "billingAccountId": { - "description": "The fully qualified ID that uniquely identifies a billing account.", - "type": "string" - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile.", - "type": "string" - }, - "billingProfileId": { - "description": "The friendly ID that uniquely identifies a billing profile.", - "type": "string" - }, - "billingProfileSystemId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string" - }, - "indirectRelationshipOrganizationName": { - "description": "Billing account name. Available for a specific type of agreement.", - "type": "string" - } - } - }, - "Participant": { - "description": "Billing account name. Available for a specific type of agreement.", - "type": "object", - "properties": { - "email": { - "description": "The email address of the participant.", - "type": "string", - "readOnly": true - }, - "status": { - "description": "The acceptance status of the participant.", - "type": "string", - "readOnly": true - }, - "statusDate": { - "format": "date-time", - "description": "The date when the status got changed.", - "type": "string", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/associatedTenant.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/associatedTenant.json deleted file mode 100644 index 3a02437cc66a..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/associatedTenant.json +++ /dev/null @@ -1,387 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}": { - "delete": { - "tags": [ - "AssociatedTenant" - ], - "description": "Deletes an associated tenant for a billing account.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "AssociatedTenants_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/associatedTenantName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "AssociatedTenantsDelete": { - "$ref": "./examples/associatedTenantsDelete.json" - } - } - }, - "get": { - "tags": [ - "AssociatedTenant" - ], - "description": "Gets an associated tenant by ID.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "AssociatedTenants_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/associatedTenantName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An associated tenant.", - "schema": { - "$ref": "#/definitions/AssociatedTenant" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssociatedTenantsGet": { - "$ref": "./examples/associatedTenantsGet.json" - } - } - }, - "put": { - "tags": [ - "AssociatedTenant" - ], - "description": "Create or update an associated tenant for the billing account.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "AssociatedTenants_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/associatedTenantName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "An associated tenant.", - "required": true, - "schema": { - "$ref": "#/definitions/AssociatedTenant" - } - } - ], - "responses": { - "200": { - "description": "An associated tenant.", - "schema": { - "$ref": "#/definitions/AssociatedTenant" - } - }, - "201": { - "description": "An associated tenant.", - "schema": { - "$ref": "#/definitions/AssociatedTenant" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "AssociatedTenantsCreateOrUpdate": { - "$ref": "./examples/associatedTenantsCreateOrUpdate.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants": { - "get": { - "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/" - }, - "operationId": "AssociatedTenants_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "in": "query", - "name": "includeRevoked", - "description": "Can be used to get revoked associated tenants.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "A list of associated tenants.", - "schema": { - "$ref": "#/definitions/AssociatedTenantListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssociatedTenantsListByBillingAccount": { - "$ref": "./examples/associatedTenantsListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "AssociatedTenant": { - "description": "An associated tenant.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AssociatedTenantProperties" - } - }, - "x-ms-azure-resource": true - }, - "AssociatedTenantListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/AssociatedTenant" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "AssociatedTenantProperties": { - "description": "An associated tenant.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "displayName": { - "description": "The name of the associated tenant.", - "type": "string" - }, - "tenantId": { - "description": "The ID that uniquely identifies a tenant.", - "type": "string" - }, - "billingManagementState": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "BillingManagementTenantState", - "modelAsString": true - } - }, - "provisioningManagementState": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningTenantState", - "modelAsString": true - } - }, - "provisioningBillingRequestId": { - "description": "The unique identifier for the billing request that is created when enabling provisioning for an associated tenant.", - "type": "string", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/availableBalance.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/availableBalance.json deleted file mode 100644 index e7ffa84543f0..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/availableBalance.json +++ /dev/null @@ -1,230 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/availableBalance/default": { - "get": { - "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/" - }, - "operationId": "AvailableBalances_GetByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", - "schema": { - "$ref": "#/definitions/AvailableBalance" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AvailableBalanceGetByBillingAccount": { - "$ref": "./examples/availableBalanceGetByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default": { - "get": { - "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/" - }, - "operationId": "AvailableBalances_GetByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", - "schema": { - "$ref": "#/definitions/AvailableBalance" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AvailableBalanceGetByBillingProfile": { - "$ref": "./examples/availableBalanceGetByBillingProfile.json" - } - } - } - } - }, - "definitions": { - "AvailableBalance": { - "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AvailableBalanceProperties" - } - }, - "x-ms-azure-resource": true - }, - "AvailableBalanceProperties": { - "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", - "type": "object", - "properties": { - "amount": { - "description": "Credit amount for immediate payment.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "paymentsOnAccount": { - "description": "The list of payments on accounts.", - "type": "array", - "items": { - "$ref": "#/definitions/PaymentOnAccount" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "totalPaymentsOnAccount": { - "description": "Total amount of payments on accounts.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - } - } - }, - "PaymentOnAccount": { - "description": "A Payment on Account.", - "type": "object", - "properties": { - "amount": { - "description": "Payment on Account amount.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "billingProfileId": { - "description": "The ID of the billing profile for the payments on account.", - "type": "string", - "readOnly": true - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile for the payments on account.", - "type": "string", - "readOnly": true - }, - "invoiceId": { - "description": "The ID of the invoice for which the payments on account was generated.", - "type": "string", - "readOnly": true - }, - "invoiceName": { - "description": "The name of the invoice for the payments on account.", - "type": "string", - "readOnly": true - }, - "date": { - "format": "date-time", - "description": "The date of the payments on account.", - "type": "string", - "readOnly": true - }, - "paymentMethodType": { - "description": "Payment on Account type.", - "enum": [ - "Other", - "None", - "CreditCard", - "Credits", - "CheckWire", - "EWallet", - "TaskOrder", - "DirectDebit" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PaymentMethodFamily", - "modelAsString": true - } - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingAccount.json deleted file mode 100644 index 4ae337a93b5c..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingAccount.json +++ /dev/null @@ -1,1324 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms": { - "post": { - "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/" - }, - "operationId": "BillingAccounts_AddPaymentTerms", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of payment term.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/PaymentTerm" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The list of billing accounts.", - "schema": { - "$ref": "#/definitions/BillingAccount" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "PaymentTermsAdd": { - "$ref": "./examples/paymentTermsAdd.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/cancelPaymentTerms": { - "post": { - "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/" - }, - "operationId": "BillingAccounts_CancelPaymentTerms", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "Date after which any payment terms that needs to be cancelled.", - "required": true, - "schema": { - "format": "date-time", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of billing accounts.", - "schema": { - "$ref": "#/definitions/BillingAccount" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "PaymentTermsCancel": { - "$ref": "./examples/paymentTermsCancel.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/confirmTransition": { - "post": { - "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/" - }, - "operationId": "BillingAccounts_ConfirmTransition", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.", - "schema": { - "$ref": "#/definitions/TransitionDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingAccountsConfirmTransition": { - "$ref": "./examples/billingAccountsConfirmTransition.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission": { - "post": { - "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/" - }, - "operationId": "BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/InvoiceSectionWithCreateSubPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/validatePaymentTerms": { - "post": { - "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/" - }, - "operationId": "BillingAccounts_ValidatePaymentTerms", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of payment term.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/PaymentTerm" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "Result of the payment terms eligibility.", - "schema": { - "$ref": "#/definitions/PaymentTermsEligibilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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/{billingAccountName}": { - "get": { - "tags": [ - "BillingAccount" - ], - "description": "Gets a billing account by its ID.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingAccounts_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A billing account.", - "schema": { - "$ref": "#/definitions/BillingAccount" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingAccountsGet": { - "$ref": "./examples/billingAccountsGet.json" - }, - "BillingAccountsGetWithExpand": { - "$ref": "./examples/billingAccountsGetWithExpand.json" - }, - "BillingAccountWithRegistrationNumberWithDefaultType": { - "$ref": "./examples/billingAccountWithRegistrationNumberWithDefaultType.json" - }, - "BillingAccountWithRegistrationNumberWithType": { - "$ref": "./examples/billingAccountWithRegistrationNumberWithType.json" - }, - "BillingAccountsGetEA": { - "$ref": "./examples/billingAccountsGetEA.json" - }, - "BillingAccountWithExpandForPONumber": { - "$ref": "./examples/billingAccountWithExpandForPONumber.json" - } - } - }, - "patch": { - "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/" - }, - "operationId": "BillingAccounts_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A billing account.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingAccountPatch" - } - } - ], - "responses": { - "200": { - "description": "A billing account.", - "schema": { - "$ref": "#/definitions/BillingAccount" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingAccountsUpdate": { - "$ref": "./examples/billingAccountsUpdate.json" - }, - "BillingAccountUpdateWithPONumber": { - "$ref": "./examples/billingAccountUpdateWithPONumber.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts": { - "get": { - "tags": [ - "BillingAccount" - ], - "description": "Lists the billing accounts that a user has access to.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingAccounts_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "includeAll", - "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.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includeAllWithoutBillingProfiles", - "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.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includeDeleted", - "description": "When true, results will include any billing accounts in a deleted state.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includePendingAgreement", - "description": "Includes billing accounts with agreement pending signature that the user has access to.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includeResellee", - "description": "Includes the customer's billing account of Microsoft Partner Agreement that the user has access to.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "legalOwnerTID", - "description": "Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.", - "type": "string" - }, - { - "in": "query", - "name": "legalOwnerOID", - "description": "Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "in": "query", - "name": "expand", - "description": "Expand is allowed for SoldTo and EnrollmentDetails/PONumber.", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing accounts.", - "schema": { - "$ref": "#/definitions/BillingAccountListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingAccountsList": { - "$ref": "./examples/billingAccountsList.json" - }, - "BillingAccountForLegacyAccountDetails": { - "$ref": "./examples/billingAccountForLegacyAccountDetails.json" - }, - "BillingAccountsListWithExpandForPONumber": { - "$ref": "./examples/billingAccountsListWithExpandForPONumber.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/validateAddress": { - "post": { - "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/" - }, - "operationId": "Address_Validate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "Address details.", - "required": true, - "schema": { - "$ref": "./types.json#/definitions/AddressDetails" - } - } - ], - "responses": { - "200": { - "description": "Result of the address validation.", - "schema": { - "$ref": "#/definitions/AddressValidationResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AddressValidateValid": { - "$ref": "./examples/addressValidateValid.json" - }, - "AddressValidateInvalid": { - "$ref": "./examples/addressValidateInvalid.json" - } - } - } - } - }, - "definitions": { - "AddressValidationResponse": { - "description": "Result of the address validation.", - "type": "object", - "properties": { - "status": { - "description": "Status of the address validation.", - "enum": [ - "Other", - "Valid", - "Invalid" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AddressValidationStatus", - "modelAsString": true - } - }, - "suggestedAddresses": { - "description": "The list of suggested addresses.", - "type": "array", - "items": { - "$ref": "./types.json#/definitions/AddressDetails" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "validationMessage": { - "description": "Validation error message.", - "type": "string", - "readOnly": true - } - }, - "readOnly": true - }, - "BillingAccount": { - "description": "A billing account.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingAccountProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingAccountListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingAccount" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "BillingAccountPatch": { - "description": "A billing account.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingAccountProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingAccountProperties": { - "description": "A billing account.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "accountStatus": { - "description": "The current status of the billing account.", - "enum": [ - "Other", - "Active", - "UnderReview", - "Disabled", - "Deleted", - "Extended", - "Pending", - "New", - "Expired", - "Terminated", - "Transferred" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": true - } - }, - "accountType": { - "description": "The type of customer.", - "enum": [ - "Other", - "Enterprise", - "Individual", - "Partner", - "Reseller", - "ClassicPartner", - "Internal", - "Tenant", - "Business" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AccountType", - "modelAsString": true - } - }, - "accountSubType": { - "description": "The tier of the account.", - "enum": [ - "Other", - "None", - "Individual", - "Professional", - "Enterprise" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AccountSubType", - "modelAsString": true - } - }, - "accountStatusReasonCode": { - "description": "Reason for the specified billing account status.", - "enum": [ - "Other", - "UnusualActivity", - "ManuallyTerminated", - "Expired", - "Transferred", - "TerminateProcessing" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingAccountStatusReasonCode", - "modelAsString": true - } - }, - "agreementType": { - "description": "The type of agreement.", - "enum": [ - "Other", - "MicrosoftCustomerAgreement", - "EnterpriseAgreement", - "MicrosoftOnlineServicesProgram", - "MicrosoftPartnerAgreement" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AgreementType", - "modelAsString": true - } - }, - "displayName": { - "description": "The billing account name.", - "type": "string" - }, - "enrollmentDetails": { - "description": "The properties of an enrollment.", - "allOf": [ - { - "$ref": "#/definitions/EnrollmentDetails" - } - ] - }, - "hasReadAccess": { - "description": "Indicates whether user has read access to the billing account.", - "type": "boolean" - }, - "hasNoBillingProfiles": { - "description": "Indicates whether or not the billing account has any billing profiles.", - "type": "boolean" - }, - "notificationEmailAddress": { - "description": "Notification email address for legacy account. Available for agreement type Microsoft Online Services Program.", - "type": "string" - }, - "primaryBillingTenantId": { - "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.", - "type": "string" - }, - "soldTo": { - "description": "The address of the individual or organization that is responsible for the billing account.", - "allOf": [ - { - "$ref": "./types.json#/definitions/AddressDetails" - } - ] - }, - "registrationNumber": { - "description": "Describes the registration number of the organization linked with the billing account.", - "allOf": [ - { - "$ref": "#/definitions/RegistrationNumber" - } - ] - }, - "billingRelationshipTypes": { - "description": "Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party.", - "type": "array", - "items": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "BillingRelationshipType", - "modelAsString": true - } - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "qualifications": { - "description": "Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "taxIds": { - "description": "A list of tax identifiers for the billing account.", - "type": "array", - "items": { - "$ref": "#/definitions/TaxIdentifier" - }, - "x-ms-identifiers": [] - } - } - }, - "EnrollmentDetails": { - "description": "The properties of an enrollment.", - "type": "object", - "properties": { - "startDate": { - "format": "date-time", - "description": "The start date of the enrollment.", - "type": "string" - }, - "endDate": { - "format": "date-time", - "description": "The end date of the enrollment.", - "type": "string" - }, - "currency": { - "description": "The billing currency for the enrollment.", - "type": "string", - "readOnly": true - }, - "channel": { - "description": "The channel type of the enrollment.", - "type": "string", - "readOnly": true - }, - "language": { - "description": "The language for the enrollment.", - "type": "string", - "readOnly": true - }, - "countryCode": { - "description": "The country code of the enrollment.", - "type": "string", - "readOnly": true - }, - "billingCycle": { - "description": "The billing cycle for the enrollment.", - "type": "string", - "readOnly": true - }, - "extendedTermOption": { - "description": "The billing account extension opted by the company.", - "enum": [ - "Other", - "Opted-In", - "Opted-Out" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ExtendedTermOption", - "modelAsString": true - } - }, - "supportLevel": { - "description": "The support level offer associated with an enrollment.", - "enum": [ - "Other", - "Standard", - "Pro-Direct", - "Developer" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SupportLevel", - "modelAsString": true - } - }, - "supportCoverage": { - "description": "The support coverage period for the enrollment.", - "type": "string", - "readOnly": true - }, - "cloud": { - "description": "The cloud of the enrollment.", - "type": "string", - "readOnly": true - }, - "poNumber": { - "description": "The purchase order number of the enrollment.", - "type": "string" - }, - "markupStatus": { - "description": "Markup status of enrollment, applicable only for indirect enrollments.", - "enum": [ - "Other", - "Disabled", - "Preview", - "Published", - "Locked" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "MarkupStatus", - "modelAsString": true - } - }, - "indirectRelationshipInfo": { - "description": "The properties of an enrollment which are applicable only for indirect enrollments.", - "allOf": [ - { - "$ref": "./types.json#/definitions/IndirectRelationshipInfo" - } - ] - }, - "invoiceRecipient": { - "description": "The contact who receives invoices of the enrollment.", - "type": "string", - "readOnly": true - } - } - }, - "InvoiceSectionWithCreateSubPermission": { - "description": "Invoice section properties with create subscription permission.", - "type": "object", - "properties": { - "billingProfileDisplayName": { - "description": "The name of the billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileSystemId": { - "description": "The system generated unique identifier for a billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileStatus": { - "description": "The status of the billing profile.", - "enum": [ - "Other", - "Active", - "Disabled", - "Warned", - "Deleted", - "UnderReview" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingProfileStatus", - "modelAsString": true - } - }, - "billingProfileStatusReasonCode": { - "description": "Reason for the specified billing profile status.", - "enum": [ - "Other", - "PastDue", - "UnusualActivity", - "SpendingLimitReached", - "SpendingLimitExpired" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingProfileStatusReasonCode", - "modelAsString": true - } - }, - "billingProfileSpendingLimit": { - "description": "The billing profile spending limit.", - "enum": [ - "Off", - "On" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SpendingLimit", - "modelAsString": true - } - }, - "enabledAzurePlans": { - "description": "Enabled azure plans for the associated billing profile.", - "type": "array", - "items": { - "$ref": "./types.json#/definitions/AzurePlan" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "invoiceSectionDisplayName": { - "description": "The name of the invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionId": { - "description": "The fully qualified ID that uniquely identifies an invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionSystemId": { - "description": "The system generated unique identifier for an invoice section.", - "type": "string", - "readOnly": true - } - } - }, - "InvoiceSectionWithCreateSubPermissionListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/InvoiceSectionWithCreateSubPermission" - }, - "readOnly": true, - "x-ms-identifiers": [ - "invoiceSectionId" - ] - } - } - }, - "PaymentTerm": { - "description": "The properties of payment term.", - "type": "object", - "properties": { - "term": { - "description": "Represents duration in netXX format. Always in days.", - "type": "string" - }, - "startDate": { - "format": "date-time", - "description": "The date on when the defined 'Payment Term' will be effective from and is always in UTC.", - "type": "string" - }, - "endDate": { - "format": "date-time", - "description": "The date on when the defined 'Payment Term' will end and is always in UTC.", - "type": "string" - }, - "isDefault": { - "description": "Indicates payment term is the standard payment term.", - "type": "boolean", - "readOnly": true - } - } - }, - "PaymentTermsEligibilityDetail": { - "description": "Details of the payment terms eligibility.", - "type": "object", - "properties": { - "code": { - "description": "Indicates the reason for the ineligibility of the payment terms.", - "enum": [ - "Other", - "OverlappingPaymentTerms", - "InvalidDateFormat", - "InvalidDateRange", - "InactiveBillingAccount", - "InvalidBillingAccountType", - "NullOrEmptyPaymentTerms", - "BillingAccountNotFound", - "IneligibleBillingAccountStatus", - "InvalidTerms" - ], - "type": "string", - "x-ms-enum": { - "name": "PaymentTermsEligibilityCode", - "modelAsString": true - } - }, - "message": { - "description": "Indicates the message for the ineligibility of the payment terms.", - "type": "string" - } - } - }, - "PaymentTermsEligibilityResult": { - "description": "Result of the payment terms eligibility.", - "type": "object", - "properties": { - "eligibilityStatus": { - "description": "Indicates the eligibility status of the payment terms.", - "enum": [ - "Other", - "Valid", - "Invalid" - ], - "type": "string", - "x-ms-enum": { - "name": "PaymentTermsEligibilityStatus", - "modelAsString": true - } - }, - "eligibilityDetails": { - "description": "Details of the payment terms eligibility.", - "type": "array", - "items": { - "$ref": "#/definitions/PaymentTermsEligibilityDetail" - }, - "x-ms-identifiers": [] - } - } - }, - "RegistrationNumber": { - "description": "Describes the registration number of the organization linked with the billing account.", - "type": "object", - "properties": { - "id": { - "description": "The unique identification number of the organization linked with the billing account.", - "type": "string" - }, - "required": { - "description": "Identifies if the registration number is required for the billing account.", - "type": "boolean", - "readOnly": true - }, - "type": { - "description": "The types of registration number allowed based on the country of the billing account.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "TaxIdentifier": { - "description": "A tax identifier for the billing account.", - "type": "object", - "properties": { - "id": { - "description": "The id of the tax identifier.", - "type": "string" - }, - "type": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "TaxIdentifierType", - "modelAsString": true - } - }, - "scope": { - "description": "The scope of the tax identifier.", - "type": "string" - }, - "country": { - "description": "The country of the tax identifier.", - "type": "string" - }, - "status": { - "description": "The status of the tax identifier.", - "enum": [ - "Other", - "Valid", - "Invalid" - ], - "type": "string", - "x-ms-enum": { - "name": "TaxIdentifierStatus", - "modelAsString": true - } - } - } - }, - "TransitionDetails": { - "description": "The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.", - "type": "object", - "properties": { - "transitionDate": { - "format": "date-time", - "description": "The transition completion date.", - "type": "string", - "readOnly": true - }, - "anniversaryDay": { - "format": "int32", - "description": "The anniversary day of the pre-transitioned account of type Microsoft Online Services Program.", - "type": "integer", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingPermission.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingPermission.json deleted file mode 100644 index 2f7370d11edc..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingPermission.json +++ /dev/null @@ -1,830 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions": { - "get": { - "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/" - }, - "operationId": "BillingPermissions_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of billingPermissions a caller has on a billing account.", - "schema": { - "$ref": "#/definitions/BillingPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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/{billingProfileName}/billingPermissions": { - "get": { - "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/" - }, - "operationId": "BillingPermissions_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of billingPermissions a caller has on a billing profile.", - "schema": { - "$ref": "#/definitions/BillingPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/checkAccess": { - "post": { - "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/" - }, - "operationId": "BillingPermissions_CheckAccessByBillingProfile", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The request object against which access of the caller will be checked.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckAccessRequest" - } - } - ], - "responses": { - "200": { - "description": "The list of check access response objects for a billing profile.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CheckAccessResponse" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/customers/{customerName}/billingPermissions": { - "get": { - "tags": [ - "BillingPermission" - ], - "description": "Lists the billing permissions the caller has for a customer.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingPermissions_ListByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of billingPermissions a caller has on a customer.", - "schema": { - "$ref": "#/definitions/BillingPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/checkAccess": { - "post": { - "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/" - }, - "operationId": "BillingPermissions_CheckAccessByCustomer", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The request object against which access of the caller will be checked.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckAccessRequest" - } - } - ], - "responses": { - "200": { - "description": "The list of check access response objects for a customer.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CheckAccessResponse" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/invoiceSections/{invoiceSectionName}/billingPermissions": { - "get": { - "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/" - }, - "operationId": "BillingPermissions_ListByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of billingPermissions a caller has on an invoice section.", - "schema": { - "$ref": "#/definitions/BillingPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/checkAccess": { - "post": { - "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/" - }, - "operationId": "BillingPermissions_CheckAccessByInvoiceSection", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The request object against which access of the caller will be checked.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckAccessRequest" - } - } - ], - "responses": { - "200": { - "description": "The list of check access response objects for an invoice section.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CheckAccessResponse" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CheckAccessByInvoiceSection": { - "$ref": "./examples/checkAccessByInvoiceSection.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/checkAccess": { - "post": { - "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/" - }, - "operationId": "BillingPermissions_CheckAccessByBillingAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The request object against which access of the caller will be checked.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckAccessRequest" - } - } - ], - "responses": { - "200": { - "description": "The list of check access response objects for a billing account.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CheckAccessResponse" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CheckAccessByBillingAccount": { - "$ref": "./examples/checkAccessByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingPermissions": { - "get": { - "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/" - }, - "operationId": "BillingPermissions_ListByCustomerAtBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of billingPermissions a caller has on a customer.", - "schema": { - "$ref": "#/definitions/BillingPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/departments/{departmentName}/billingPermissions": { - "get": { - "tags": [ - "BillingPermission" - ], - "description": "Lists the billing permissions the caller has for a department.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingPermissions_ListByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of billingPermissions a caller has on a department.", - "schema": { - "$ref": "#/definitions/BillingPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/checkAccess": { - "post": { - "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/" - }, - "operationId": "BillingPermissions_CheckAccessByDepartment", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The request object against which access of the caller will be checked.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckAccessRequest" - } - } - ], - "responses": { - "200": { - "description": "The list of check access response objects for a department.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CheckAccessResponse" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CheckAccessByDepartment": { - "$ref": "./examples/checkAccessByDepartment.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingPermissions": { - "get": { - "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/" - }, - "operationId": "BillingPermissions_ListByEnrollmentAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of billingPermissions a caller has on an enrollment account.", - "schema": { - "$ref": "#/definitions/BillingPermissionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/checkAccess": { - "post": { - "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/" - }, - "operationId": "BillingPermissions_CheckAccessByEnrollmentAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The request object against which access of the caller will be checked.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckAccessRequest" - } - } - ], - "responses": { - "200": { - "description": "The list of check access response objects for an enrollment account.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CheckAccessResponse" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CheckAccessByEnrollmentAccount": { - "$ref": "./examples/checkAccessByEnrollmentAccount.json" - } - } - } - } - }, - "definitions": { - "BillingPermission": { - "description": "The set of allowed action and not allowed actions a caller has on a resource.", - "type": "object", - "properties": { - "actions": { - "description": "The set of actions that the caller is allowed to perform.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "notActions": { - "description": "The set of actions that the caller is not allowed to perform.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - }, - "readOnly": true - }, - "BillingPermissionListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingPermission" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "CheckAccessRequest": { - "description": "Request to check access.", - "type": "object", - "properties": { - "actions": { - "description": "List of actions passed in the request body against which the permissions will be checked.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-identifiers": [] - } - } - }, - "CheckAccessResponse": { - "description": "The properties of a check access response.", - "type": "object", - "properties": { - "accessDecision": { - "description": "Access Decision, specifies access is allowed or not.", - "enum": [ - "Other", - "Allowed", - "NotAllowed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AccessDecision", - "modelAsString": true - } - }, - "action": { - "description": "Gets or sets an action.", - "type": "string", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingProfile.json deleted file mode 100644 index 3f1ec1e7ba51..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingProfile.json +++ /dev/null @@ -1,724 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/validateDeleteEligibility": { - "post": { - "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/" - }, - "operationId": "BillingProfiles_ValidateDeleteEligibility", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Eligibility to delete a billing profile result.", - "schema": { - "$ref": "#/definitions/DeleteBillingProfileEligibilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingProfilesValidateDeleteEligibilitySuccess": { - "$ref": "./examples/billingProfilesValidateDeleteEligibilitySuccess.json" - }, - "BillingProfilesValidateDeleteEligibilityFailure": { - "$ref": "./examples/billingProfilesValidateDeleteEligibilityFailure.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}": { - "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/" - }, - "operationId": "BillingProfiles_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "204": { - "description": "The request has succeeded with no response body." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingProfilesDelete": { - "$ref": "./examples/billingProfilesDelete.json" - } - } - }, - "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/" - }, - "operationId": "BillingProfiles_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A billing profile.", - "schema": { - "$ref": "#/definitions/BillingProfile" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingProfilesGet": { - "$ref": "./examples/billingProfilesGet.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "BillingProfiles_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A billing profile.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingProfile" - } - } - ], - "responses": { - "200": { - "description": "A billing profile.", - "schema": { - "$ref": "#/definitions/BillingProfile" - } - }, - "201": { - "description": "A billing profile.", - "schema": { - "$ref": "#/definitions/BillingProfile" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingProfilesCreateOrUpdate": { - "$ref": "./examples/billingProfilesCreateOrUpdate.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles": { - "get": { - "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/" - }, - "operationId": "BillingProfiles_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted billing profiles.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing profiles.", - "schema": { - "$ref": "#/definitions/BillingProfileListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingProfilesListByBillingAccount": { - "$ref": "./examples/billingProfilesListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "BillingProfile": { - "description": "A billing profile.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingProfileProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingProfileListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingProfile" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "BillingProfileProperties": { - "description": "A billing profile.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "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.", - "enum": [ - "Other", - "Direct", - "IndirectCustomer", - "IndirectPartner", - "CSPPartner", - "CSPCustomer" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingRelationshipType", - "modelAsString": true - } - }, - "billTo": { - "description": "Billing address.", - "allOf": [ - { - "$ref": "./types.json#/definitions/AddressDetails" - } - ] - }, - "currency": { - "description": "The currency in which the charges for the billing profile are billed.", - "type": "string", - "readOnly": true - }, - "displayName": { - "description": "The name of the billing profile.", - "type": "string" - }, - "enabledAzurePlans": { - "description": "Information about the enabled azure plans.", - "type": "array", - "items": { - "$ref": "./types.json#/definitions/AzurePlan" - }, - "x-ms-identifiers": [] - }, - "hasReadAccess": { - "description": "Indicates whether user has read access to the billing profile.", - "type": "boolean", - "readOnly": true - }, - "indirectRelationshipInfo": { - "description": "Identifies the billing profile that is linked to another billing profile in indirect purchase motion.", - "allOf": [ - { - "$ref": "./types.json#/definitions/IndirectRelationshipInfo" - } - ] - }, - "invoiceDay": { - "format": "int32", - "description": "The day of the month when the invoice for the billing profile is generated.", - "type": "integer", - "readOnly": true - }, - "invoiceEmailOptIn": { - "description": "Flag controlling whether the invoices for the billing profile are sent through email.", - "type": "boolean" - }, - "invoiceRecipients": { - "description": "The list of email addresses to receive invoices by email for the billing profile.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-identifiers": [] - }, - "poNumber": { - "description": "The default purchase order number that will appear on the invoices generated for the billing profile.", - "type": "string" - }, - "shipTo": { - "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": "./types.json#/definitions/AddressDetails" - } - ] - }, - "soldTo": { - "description": "The address of the individual or organization that is responsible for the billing account.", - "allOf": [ - { - "$ref": "./types.json#/definitions/AddressDetails" - } - ] - }, - "spendingLimit": { - "description": "The billing profile spending limit.", - "enum": [ - "Off", - "On" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SpendingLimit", - "modelAsString": true - } - }, - "spendingLimitDetails": { - "description": "The details of billing profile spending limit.", - "type": "array", - "items": { - "$ref": "#/definitions/SpendingLimitDetails" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "status": { - "description": "The status of the billing profile.", - "enum": [ - "Other", - "Active", - "Disabled", - "Warned", - "Deleted", - "UnderReview" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingProfileStatus", - "modelAsString": true - } - }, - "statusReasonCode": { - "description": "Reason for the specified billing profile status.", - "enum": [ - "Other", - "PastDue", - "UnusualActivity", - "SpendingLimitReached", - "SpendingLimitExpired" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingProfileStatusReasonCode", - "modelAsString": true - } - }, - "systemId": { - "description": "The system generated unique identifier for a billing profile.", - "type": "string", - "readOnly": true - }, - "tags": { - "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 < > % & \\ ? /", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "targetClouds": { - "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.", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "currentPaymentTerm": { - "description": "The current payment term of the billing profile.", - "allOf": [ - { - "$ref": "#/definitions/PaymentTerm" - } - ] - }, - "otherPaymentTerms": { - "description": "The other payment terms of the billing profile.", - "type": "array", - "items": { - "$ref": "#/definitions/PaymentTerm" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "DeleteBillingProfileEligibilityDetail": { - "description": "Validation details of delete billing profile eligibility.", - "type": "object", - "properties": { - "code": { - "description": "Code of the delete invoice section eligibility response.", - "enum": [ - "None", - "ActiveCredits", - "ActiveCreditCard", - "LastBillingProfile", - "NotSupported", - "OutstandingCharges", - "PendingCharges", - "ReservedInstances", - "ActiveBillingSubscriptions" - ], - "type": "string", - "x-ms-enum": { - "name": "DeleteBillingProfileEligibilityCode", - "modelAsString": true - } - }, - "message": { - "description": "Validation message.", - "type": "string" - } - } - }, - "DeleteBillingProfileEligibilityResult": { - "description": "Eligibility to delete a billing profile result.", - "type": "object", - "properties": { - "eligibilityStatus": { - "description": "Status describing if billing profile is eligible to be deleted.", - "enum": [ - "Allowed", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "DeleteBillingProfileEligibilityStatus", - "modelAsString": true - } - }, - "eligibilityDetails": { - "description": "Validation details of delete billing profile eligibility.", - "type": "array", - "items": { - "$ref": "#/definitions/DeleteBillingProfileEligibilityDetail" - }, - "x-ms-identifiers": [] - } - } - }, - "PaymentTerm": { - "description": "The properties of payment term.", - "type": "object", - "properties": { - "term": { - "description": "Represents duration in netXX format. Always in days.", - "type": "string" - }, - "startDate": { - "format": "date-time", - "description": "The date on when the defined 'Payment Term' will be effective from and is always in UTC.", - "type": "string" - }, - "endDate": { - "format": "date-time", - "description": "The date on when the defined 'Payment Term' will end and is always in UTC.", - "type": "string" - }, - "isDefault": { - "description": "Indicates payment term is the standard payment term.", - "type": "boolean", - "readOnly": true - } - } - }, - "SpendingLimitDetails": { - "description": "The billing profile spending limit.", - "type": "object", - "properties": { - "amount": { - "description": "The initial amount for the billing profile.", - "type": "number" - }, - "currency": { - "description": "The currency in which the charges for the billing profile are billed.", - "type": "string" - }, - "startDate": { - "format": "date-time", - "description": "The date when this spending limit goes into effect.", - "type": "string" - }, - "endDate": { - "format": "date-time", - "description": "The date when this spending limit is no longer in effect.", - "type": "string" - }, - "type": { - "description": "The type of spending limit.", - "enum": [ - "Other", - "None", - "FreeAccount", - "Sandbox", - "AzureForStudents", - "AcademicSponsorship", - "AzureConsumptionCredit", - "AzurePassSponsorship", - "MpnSponsorship", - "MSDN", - "NonProfitSponsorship", - "Sponsorship", - "StartupSponsorship", - "AzureForStudentsStarter", - "VisualStudio" - ], - "type": "string", - "x-ms-enum": { - "name": "SpendingLimitType", - "modelAsString": true - } - }, - "status": { - "description": "The status of current spending limit.", - "enum": [ - "Other", - "None", - "Active", - "Expired", - "LimitReached", - "LimitRemoved" - ], - "type": "string", - "x-ms-enum": { - "name": "SpendingLimitStatus", - "modelAsString": true - } - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingProperty.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingProperty.json deleted file mode 100644 index 960b7809be9c..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingProperty.json +++ /dev/null @@ -1,694 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default": { - "get": { - "tags": [ - "BillingProperty" - ], - "description": "Gets the billing properties for a subscription", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingProperty_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/subscriptionId" - }, - { - "in": "query", - "name": "includeBillingCountry", - "description": "A flag that specifies whether or not to include billing country.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includeTransitionStatus", - "description": "A flag that specifies whether or not to include transition status for billing accounts with agreement type Microsoft Customer Agreement.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A billing property.", - "schema": { - "$ref": "#/definitions/BillingProperty" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "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/" - }, - "operationId": "BillingProperty_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/subscriptionId" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A billing property.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingProperty" - } - } - ], - "responses": { - "200": { - "description": "A billing property.", - "schema": { - "$ref": "#/definitions/BillingProperty" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingPropertyPatchCostCenter": { - "$ref": "./examples/billingPropertyPatchCostCenter.json" - }, - "BillingPropertyPatchSubscriptionServiceUsageAddress": { - "$ref": "./examples/billingPropertyPatchSubscriptionServiceUsageAddress.json" - } - } - } - } - }, - "definitions": { - "BillingProperty": { - "description": "A billing property.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingPropertyProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingPropertyProperties": { - "description": "A billing property.", - "type": "object", - "properties": { - "billingAccountAgreementType": { - "description": "The type of agreement.", - "enum": [ - "Other", - "MicrosoftCustomerAgreement", - "EnterpriseAgreement", - "MicrosoftOnlineServicesProgram", - "MicrosoftPartnerAgreement" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AgreementType", - "modelAsString": true - } - }, - "billingAccountDisplayName": { - "description": "The name of the billing account.", - "type": "string", - "readOnly": true - }, - "billingAccountId": { - "description": "The fully qualified ID that uniquely identifies a billing account.", - "type": "string", - "readOnly": true - }, - "accountAdminNotificationEmailAddress": { - "description": "Notification email address for legacy account. Available for agreement type Microsoft Online Services Program.", - "type": "string", - "readOnly": true - }, - "billingAccountSoldToCountry": { - "description": "The country of the individual or organization that is responsible for the billing account.", - "type": "string", - "readOnly": true - }, - "billingAccountStatus": { - "description": "The current status of the billing account.", - "enum": [ - "Other", - "Active", - "UnderReview", - "Disabled", - "Deleted", - "Extended", - "Pending", - "New", - "Expired", - "Terminated", - "Transferred" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": true - } - }, - "billingAccountStatusReasonCode": { - "description": "Reason for the specified billing account status.", - "enum": [ - "Other", - "UnusualActivity", - "ManuallyTerminated", - "Expired", - "Transferred", - "TerminateProcessing" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingAccountStatusReasonCode", - "modelAsString": true - } - }, - "billingAccountType": { - "description": "The type of customer.", - "enum": [ - "Other", - "Enterprise", - "Individual", - "Partner", - "Reseller", - "ClassicPartner", - "Internal", - "Tenant", - "Business" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AccountType", - "modelAsString": true - } - }, - "billingAccountSubType": { - "description": "The tier of the account.", - "enum": [ - "Other", - "None", - "Individual", - "Professional", - "Enterprise" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AccountSubType", - "modelAsString": true - } - }, - "billingCurrency": { - "description": "The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement", - "type": "string", - "readOnly": true - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileSpendingLimit": { - "description": "The billing profile spending limit.", - "enum": [ - "Off", - "On" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SpendingLimit", - "modelAsString": true - } - }, - "billingProfileSpendingLimitDetails": { - "description": "The details of billing profile spending limit.", - "type": "array", - "items": { - "$ref": "#/definitions/SpendingLimitDetails" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "billingProfileStatus": { - "description": "The status of the billing profile.", - "enum": [ - "Other", - "Active", - "Disabled", - "Warned", - "Deleted", - "UnderReview" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingProfileStatus", - "modelAsString": true - } - }, - "billingProfileStatusReasonCode": { - "description": "Reason for the specified billing profile status.", - "enum": [ - "Other", - "PastDue", - "UnusualActivity", - "SpendingLimitReached", - "SpendingLimitExpired" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingProfileStatusReasonCode", - "modelAsString": true - } - }, - "billingProfilePaymentMethodFamily": { - "description": "The payment method family of the primary payment method for the billing profile.", - "enum": [ - "Other", - "None", - "CreditCard", - "Credits", - "CheckWire", - "EWallet", - "TaskOrder", - "DirectDebit" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PaymentMethodFamily", - "modelAsString": true - } - }, - "billingProfilePaymentMethodType": { - "description": "The payment method type of the primary payment method for the billing profile.", - "type": "string", - "readOnly": true - }, - "billingTenantId": { - "description": "The Azure AD tenant ID of the billing account for the subscription.", - "type": "string", - "readOnly": true - }, - "costCenter": { - "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.", - "type": "string" - }, - "customerDisplayName": { - "description": "The name of the customer.", - "type": "string", - "readOnly": true - }, - "customerId": { - "description": "The fully qualified ID that uniquely identifies a customer.", - "type": "string", - "readOnly": true - }, - "customerStatus": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "CustomerStatus", - "modelAsString": true - } - }, - "invoiceSectionDisplayName": { - "description": "The name of the invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionId": { - "description": "The fully qualified ID that uniquely identifies an invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionStatus": { - "description": "Identifies the status of an invoice section.", - "enum": [ - "Other", - "Active", - "Deleted", - "Disabled", - "UnderReview", - "Warned", - "Restricted" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "InvoiceSectionState", - "modelAsString": true - } - }, - "invoiceSectionStatusReasonCode": { - "description": "Reason for the specified invoice section status.", - "enum": [ - "Other", - "PastDue", - "UnusualActivity", - "SpendingLimitReached", - "SpendingLimitExpired" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "InvoiceSectionStateReasonCode", - "modelAsString": true - } - }, - "isTransitionedBillingAccount": { - "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.", - "type": "boolean", - "readOnly": true - }, - "skuDescription": { - "description": "The sku description.", - "type": "string", - "readOnly": true - }, - "skuId": { - "description": "The ID that uniquely identifies a sku.", - "type": "string", - "readOnly": true - }, - "subscriptionBillingStatus": { - "description": "The subscription status.", - "enum": [ - "Other", - "Unknown", - "Active", - "Disabled", - "Deleted", - "Warned", - "Expiring", - "Expired", - "AutoRenew", - "Cancelled", - "Suspended", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingSubscriptionStatus", - "modelAsString": true - } - }, - "subscriptionBillingStatusDetails": { - "description": "The reason codes for the subscription status.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingSubscriptionStatusDetails" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "subscriptionBillingType": { - "description": "The type of billing subscription.", - "enum": [ - "None", - "Benefit", - "Free", - "Paid", - "PrePaid" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SubscriptionBillingType", - "modelAsString": true - } - }, - "subscriptionServiceUsageAddress": { - "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": "./types.json#/definitions/AddressDetails" - } - ] - }, - "subscriptionWorkloadType": { - "description": "The Azure workload type of the subscription.", - "enum": [ - "None", - "Production", - "DevTest", - "Internal" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SubscriptionWorkloadType", - "modelAsString": true - } - }, - "enrollmentDetails": { - "description": "The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.", - "allOf": [ - { - "$ref": "#/definitions/SubscriptionEnrollmentDetails" - } - ] - }, - "isAccountAdmin": { - "description": "Indicates whether user is the account admin.", - "type": "boolean", - "readOnly": true - }, - "productId": { - "description": "The ID that uniquely identifies a product.", - "type": "string", - "readOnly": true - }, - "productName": { - "description": "The ID that uniquely identifies a product.", - "type": "string", - "readOnly": true - } - } - }, - "BillingSubscriptionStatusDetails": { - "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", - "type": "object", - "properties": { - "effectiveDate": { - "format": "date-time", - "description": "The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts.", - "type": "string", - "readOnly": true - }, - "reason": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SubscriptionStatusReason", - "modelAsString": true - } - } - } - }, - "SpendingLimitDetails": { - "description": "The billing profile spending limit.", - "type": "object", - "properties": { - "amount": { - "description": "The initial amount for the billing profile.", - "type": "number" - }, - "currency": { - "description": "The currency in which the charges for the billing profile are billed.", - "type": "string" - }, - "startDate": { - "format": "date-time", - "description": "The date when this spending limit goes into effect.", - "type": "string" - }, - "endDate": { - "format": "date-time", - "description": "The date when this spending limit is no longer in effect.", - "type": "string" - }, - "type": { - "description": "The type of spending limit.", - "enum": [ - "Other", - "None", - "FreeAccount", - "Sandbox", - "AzureForStudents", - "AcademicSponsorship", - "AzureConsumptionCredit", - "AzurePassSponsorship", - "MpnSponsorship", - "MSDN", - "NonProfitSponsorship", - "Sponsorship", - "StartupSponsorship", - "AzureForStudentsStarter", - "VisualStudio" - ], - "type": "string", - "x-ms-enum": { - "name": "SpendingLimitType", - "modelAsString": true - } - }, - "status": { - "description": "The status of current spending limit.", - "enum": [ - "Other", - "None", - "Active", - "Expired", - "LimitReached", - "LimitRemoved" - ], - "type": "string", - "x-ms-enum": { - "name": "SpendingLimitStatus", - "modelAsString": true - } - } - } - }, - "SubscriptionEnrollmentDetails": { - "description": "The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.", - "type": "object", - "properties": { - "departmentDisplayName": { - "description": "The name of the department", - "type": "string" - }, - "departmentId": { - "description": "The ID that uniquely identifies the department.", - "type": "string" - }, - "enrollmentAccountStatus": { - "description": "The status of the enrollment account.", - "type": "string" - }, - "enrollmentAccountDisplayName": { - "description": "The name of the enrollment account.", - "type": "string" - }, - "enrollmentAccountId": { - "description": "The ID that uniquely identifies an enrollment account.", - "type": "string" - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRequest.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRequest.json deleted file mode 100644 index 26e1cf263c4f..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRequest.json +++ /dev/null @@ -1,751 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRequests": { - "get": { - "tags": [ - "BillingRequest" - ], - "description": "The list of billing requests submitted for the billing profile.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingRequests_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing requests.", - "schema": { - "$ref": "#/definitions/BillingRequestListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/customers/{customerName}/billingRequests": { - "get": { - "tags": [ - "BillingRequest" - ], - "description": "The list of billing requests submitted for the customer.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingRequests_ListByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing requests.", - "schema": { - "$ref": "#/definitions/BillingRequestListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/invoiceSections/{invoiceSectionName}/billingRequests": { - "get": { - "tags": [ - "BillingRequest" - ], - "description": "The list of billing requests submitted for the invoice section.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingRequests_ListByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing requests.", - "schema": { - "$ref": "#/definitions/BillingRequestListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingRequests": { - "get": { - "tags": [ - "BillingRequest" - ], - "description": "The list of billing requests submitted for the billing account.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingRequests_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing requests.", - "schema": { - "$ref": "#/definitions/BillingRequestListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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/billingRequests/{billingRequestName}": { - "get": { - "tags": [ - "BillingRequest" - ], - "description": "Gets a billing request by its ID.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingRequests_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingRequestName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", - "schema": { - "$ref": "#/definitions/BillingRequest" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRequestsGet": { - "$ref": "./examples/billingRequestsGet.json" - } - } - }, - "put": { - "tags": [ - "BillingRequest" - ], - "description": "Create or update a billing request.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingRequests_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingRequestName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "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": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", - "schema": { - "$ref": "#/definitions/BillingRequest" - } - }, - "201": { - "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", - "schema": { - "$ref": "#/definitions/BillingRequest" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingRequestsCreateOrUpdate": { - "$ref": "./examples/billingRequestsCreateOrUpdate.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingRequests": { - "get": { - "tags": [ - "BillingRequest" - ], - "description": "The list of billing requests submitted by a user.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingRequests_ListByUser", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing requests.", - "schema": { - "$ref": "#/definitions/BillingRequestListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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" - } - } - } - }, - "definitions": { - "BillingRequest": { - "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingRequestProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingRequestListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingRequest" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "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.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "additionalInformation": { - "description": "Additional information for the billing request.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "reviewedBy": { - "description": "The principal of the request reviewer. Will only be set if request is approved.", - "allOf": [ - { - "$ref": "#/definitions/Principal" - } - ] - }, - "reviewalDate": { - "format": "date-time", - "description": "The date and time when the request was reviewed.", - "type": "string", - "readOnly": true - }, - "billingAccountId": { - "description": "The fully qualified ID that uniquely identifies a billing account.", - "type": "string", - "readOnly": true - }, - "billingAccountName": { - "description": "The ID that uniquely identifies a billing account.", - "type": "string", - "readOnly": true - }, - "billingAccountDisplayName": { - "description": "The name of the billing account.", - "type": "string", - "readOnly": true - }, - "billingAccountPrimaryBillingTenantId": { - "description": "The primary tenant ID of the billing account for which the billing request was submitted.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileName": { - "description": "The ID that uniquely identifies a billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile.", - "type": "string", - "readOnly": true - }, - "createdBy": { - "description": "The principal of the entity who created the request.", - "allOf": [ - { - "$ref": "#/definitions/Principal" - } - ] - }, - "creationDate": { - "format": "date-time", - "description": "The date and time when the request was created.", - "type": "string", - "readOnly": true - }, - "expirationDate": { - "format": "date-time", - "description": "The date and time when the request expires.", - "type": "string", - "readOnly": true - }, - "decisionReason": { - "description": "The reason to approve or decline the request.", - "type": "string" - }, - "invoiceSectionId": { - "description": "The fully qualified ID that uniquely identifies an invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionName": { - "description": "The ID that uniquely identifies an invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionDisplayName": { - "description": "The name of the invoice section.", - "type": "string", - "readOnly": true - }, - "customerId": { - "description": "The fully qualified ID that uniquely identifies a customer.", - "type": "string", - "readOnly": true - }, - "customerName": { - "description": "The ID that uniquely identifies a customer.", - "type": "string", - "readOnly": true - }, - "customerDisplayName": { - "description": "The name of the customer.", - "type": "string", - "readOnly": true - }, - "subscriptionId": { - "description": "The fully qualified ID that uniquely identifies a billing subscription.", - "type": "string", - "readOnly": true - }, - "subscriptionName": { - "description": "The ID that uniquely identifies a billing subscription.", - "type": "string", - "readOnly": true - }, - "subscriptionDisplayName": { - "description": "The name of the billing subscription.", - "type": "string", - "readOnly": true - }, - "justification": { - "description": "Justification for submitting request.", - "type": "string" - }, - "recipients": { - "description": "The recipients of the billing request.", - "type": "array", - "items": { - "$ref": "#/definitions/Principal" - }, - "x-ms-identifiers": [] - }, - "requestScope": { - "description": "The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}').", - "type": "string" - }, - "billingScope": { - "description": "The billing scope for which the request will be applied. This is a read only property derived by the service.", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Status of billing request.", - "enum": [ - "Other", - "Pending", - "Approved", - "Declined", - "Cancelled", - "Completed", - "Expired" - ], - "type": "string", - "x-ms-enum": { - "name": "BillingRequestStatus", - "modelAsString": true - } - }, - "type": { - "description": "Type of billing request.", - "enum": [ - "Other", - "InvoiceAccess", - "ProvisioningAccess", - "RoleAssignment", - "UpdateBillingPolicy" - ], - "type": "string", - "x-ms-enum": { - "name": "BillingRequestType", - "modelAsString": true - } - }, - "lastUpdatedBy": { - "description": "The principal of the entity who last updated the request.", - "allOf": [ - { - "$ref": "#/definitions/Principal" - } - ] - }, - "lastUpdatedDate": { - "format": "date-time", - "description": "Date and time of last update.", - "type": "string", - "readOnly": true - } - } - }, - "Principal": { - "description": "A principal who has interacted with a billing entity.", - "type": "object", - "properties": { - "tenantId": { - "description": "The tenant id of the principal who has interacted with a billing entity.", - "type": "string" - }, - "objectId": { - "description": "The object id of the principal who has interacted with a billing entity.", - "type": "string" - }, - "upn": { - "description": "The user principal name of the principal who has interacted with a billing entity.", - "type": "string" - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRoleAssignment.json deleted file mode 100644 index 30de45d304a3..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRoleAssignment.json +++ /dev/null @@ -1,1953 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "delete": { - "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/" - }, - "operationId": "BillingRoleAssignments_DeleteByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "The request has succeeded with no response body." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentDeleteByBillingProfile": { - "$ref": "./examples/billingRoleAssignmentDeleteByBillingProfile.json" - } - } - }, - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_GetByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentGetByBillingProfile": { - "$ref": "./examples/billingRoleAssignmentGetByBillingProfile.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments": { - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/createBillingRoleAssignment": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_CreateByBillingProfile", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the billing role assignment.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentProperties" - } - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "202": { - "description": "The properties of the billing role assignment.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingRoleAssignmentCreateByBillingProfile": { - "$ref": "./examples/billingRoleAssignmentCreateByBillingProfile.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "delete": { - "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/" - }, - "operationId": "BillingRoleAssignments_DeleteByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "The request has succeeded with no response body." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentDeleteByCustomer": { - "$ref": "./examples/billingRoleAssignmentDeleteByCustomer.json" - } - } - }, - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_GetByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentGetByCustomer": { - "$ref": "./examples/billingRoleAssignmentGetByCustomer.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments": { - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_ListByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/createBillingRoleAssignment": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_CreateByCustomer", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the billing role assignment.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentProperties" - } - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "202": { - "description": "The properties of the billing role assignment.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingRoleAssignmentCreateByCustomer": { - "$ref": "./examples/billingRoleAssignmentCreateByCustomer.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/resolveBillingRoleAssignments": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_ResolveByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "in": "query", - "name": "resolveScopeDisplayNames", - "description": "Resolves the scope display name for each of the role assignments.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "202": { - "description": "The list of the billing role assignments.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "ResolveBillingRoleAssignmentByCustomer": { - "$ref": "./examples/resolveBillingRoleAssignmentByCustomer.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "delete": { - "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/" - }, - "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "The request has succeeded with no response body." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentDeleteByInvoiceSection": { - "$ref": "./examples/billingRoleAssignmentDeleteByInvoiceSection.json" - } - } - }, - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_GetByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentGetByInvoiceSection": { - "$ref": "./examples/billingRoleAssignmentGetByInvoiceSection.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments": { - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_ListByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/createBillingRoleAssignment": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_CreateByInvoiceSection", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the billing role assignment.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentProperties" - } - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "202": { - "description": "The properties of the billing role assignment.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingRoleAssignmentCreateByInvoiceSection": { - "$ref": "./examples/billingRoleAssignmentCreateByInvoiceSection.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/resolveBillingRoleAssignments": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_ResolveByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "in": "query", - "name": "resolveScopeDisplayNames", - "description": "Resolves the scope display name for each of the role assignments.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "202": { - "description": "The list of the billing role assignments.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "ResolveBillingRoleAssignmentByInvoiceSection": { - "$ref": "./examples/resolveBillingRoleAssignmentByInvoiceSection.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/resolveBillingRoleAssignments": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_ResolveByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "in": "query", - "name": "resolveScopeDisplayNames", - "description": "Resolves the scope display name for each of the role assignments.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "202": { - "description": "The list of the billing role assignments.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "ResolveBillingRoleAssignmentByBillingProfile": { - "$ref": "./examples/resolveBillingRoleAssignmentByBillingProfile.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "delete": { - "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/" - }, - "operationId": "BillingRoleAssignments_DeleteByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "The request has succeeded with no response body." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentDeleteByBillingAccount": { - "$ref": "./examples/billingRoleAssignmentDeleteByBillingAccount.json" - } - } - }, - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_GetByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentGetByBillingAccount": { - "$ref": "./examples/billingRoleAssignmentGetByBillingAccount.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "BillingRoleAssignments_CreateOrUpdateByBillingAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the billing role assignment.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "201": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "BillingRoleAssignmentCreateOrUpdateByBillingAccount": { - "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments": { - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/createBillingRoleAssignment": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_CreateByBillingAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the billing role assignment.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentProperties" - } - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "202": { - "description": "The properties of the billing role assignment.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingRoleAssignmentCreateByBillingAccount": { - "$ref": "./examples/billingRoleAssignmentCreateByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "delete": { - "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/" - }, - "operationId": "BillingRoleAssignments_DeleteByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "The request has succeeded with no response body." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentDeleteByDepartment": { - "$ref": "./examples/billingRoleAssignmentDeleteByDepartment.json" - } - } - }, - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_GetByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentGetByDepartment": { - "$ref": "./examples/billingRoleAssignmentGetByDepartment.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "BillingRoleAssignments_CreateOrUpdateByDepartment", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the billing role assignment.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "201": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "BillingRoleAssignmentCreateOrUpdateByDepartment": { - "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByDepartment.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments": { - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_ListByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "delete": { - "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/" - }, - "operationId": "BillingRoleAssignments_DeleteByEnrollmentAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "The request has succeeded with no response body." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentDeleteByEnrollmentAccount": { - "$ref": "./examples/billingRoleAssignmentDeleteByEnrollmentAccount.json" - } - } - }, - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_GetByEnrollmentAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleAssignmentGetByEnrollmentAccount": { - "$ref": "./examples/billingRoleAssignmentGetByEnrollmentAccount.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/billingRoleAssignmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the billing role assignment.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - } - ], - "responses": { - "200": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - } - }, - "201": { - "description": "The properties of the billing role assignment.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignment" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount": { - "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments": { - "get": { - "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/" - }, - "operationId": "BillingRoleAssignments_ListByEnrollmentAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/resolveBillingRoleAssignments": { - "post": { - "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/" - }, - "operationId": "BillingRoleAssignments_ResolveByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "in": "query", - "name": "resolveScopeDisplayNames", - "description": "Resolves the scope display name for each of the role assignments.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - } - ], - "responses": { - "200": { - "description": "The list of the billing role assignments.", - "schema": { - "$ref": "#/definitions/BillingRoleAssignmentListResult" - } - }, - "202": { - "description": "The list of the billing role assignments.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "ResolveBillingRoleAssignmentByBillingAccount": { - "$ref": "./examples/resolveBillingRoleAssignmentByBillingAccount.json" - } - } - } - } - }, - "definitions": { - "BillingRoleAssignment": { - "description": "The properties of the billing role assignment.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingRoleAssignmentProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingRoleAssignmentListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingRoleAssignment" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "BillingRoleAssignmentProperties": { - "description": "The properties of the billing role assignment.", - "required": [ - "roleDefinitionId" - ], - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "createdOn": { - "format": "date-time", - "description": "The date the role assignment was created.", - "type": "string", - "readOnly": true - }, - "createdByPrincipalTenantId": { - "description": "The tenant Id of the user who created the role assignment.", - "type": "string", - "readOnly": true - }, - "createdByPrincipalId": { - "description": "The object ID of the user who created the role assignment.", - "type": "string", - "readOnly": true - }, - "createdByPrincipalPuid": { - "description": "The principal PUID of the user who created the role assignment.", - "type": "string", - "readOnly": true - }, - "createdByUserEmailAddress": { - "description": "The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.", - "type": "string", - "readOnly": true - }, - "modifiedOn": { - "format": "date-time", - "description": "The date the role assignment was modified.", - "type": "string", - "readOnly": true - }, - "modifiedByPrincipalPuid": { - "description": "The principal PUID of the user who modified the role assignment.", - "type": "string", - "readOnly": true - }, - "modifiedByUserEmailAddress": { - "description": "The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.", - "type": "string", - "readOnly": true - }, - "modifiedByPrincipalId": { - "description": "The principal PUID of the user who modified the role assignment.", - "type": "string", - "readOnly": true - }, - "modifiedByPrincipalTenantId": { - "description": "The tenant Id of the user who modified the role assignment.", - "type": "string", - "readOnly": true - }, - "principalPuid": { - "description": "The principal PUID of the user to whom the role was assigned.", - "type": "string" - }, - "principalId": { - "description": "The object id of the user to whom the role was assigned.", - "type": "string" - }, - "principalTenantId": { - "description": "The principal tenant id of the user to whom the role was assigned.", - "type": "string" - }, - "roleDefinitionId": { - "description": "The ID of the role definition.", - "minLength": 1, - "type": "string" - }, - "scope": { - "description": "The scope at which the role was assigned.", - "type": "string" - }, - "userAuthenticationType": { - "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.", - "type": "string" - }, - "userEmailAddress": { - "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.", - "type": "string" - }, - "principalTenantName": { - "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.", - "type": "string", - "readOnly": true - }, - "principalDisplayName": { - "description": "The display name of the principal to whom the role was assigned.", - "type": "string", - "readOnly": true - }, - "principalType": { - "description": "The type of a role Assignment.", - "enum": [ - "Unknown", - "None", - "User", - "Group", - "DirectoryRole", - "ServicePrincipal", - "Everyone" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PrincipalType", - "modelAsString": true - } - }, - "billingRequestId": { - "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.", - "type": "string", - "readOnly": true - }, - "billingAccountId": { - "description": "The fully qualified ID that uniquely identifies a billing account.", - "type": "string", - "readOnly": true - }, - "billingAccountDisplayName": { - "description": "The name of the billing account.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile.", - "type": "string", - "readOnly": true - }, - "invoiceSectionId": { - "description": "The fully qualified ID that uniquely identifies an invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionDisplayName": { - "description": "The name of the invoice section.", - "type": "string", - "readOnly": true - }, - "customerId": { - "description": "The fully qualified ID that uniquely identifies a customer.", - "type": "string", - "readOnly": true - }, - "customerDisplayName": { - "description": "The name of the customer.", - "type": "string", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRoleDefinition.json deleted file mode 100644 index abf079f5b983..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingRoleDefinition.json +++ /dev/null @@ -1,710 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{roleDefinitionName}": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_GetByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/roleDefinitionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of a role definition.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingRoleDefinitions": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of role definitions.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/customers/{customerName}/billingRoleDefinitions/{roleDefinitionName}": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_GetByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/roleDefinitionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of a role definition.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingRoleDefinitions": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_ListByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of role definitions.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{roleDefinitionName}": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_GetByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/roleDefinitionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of a role definition.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingRoleDefinitions": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_ListByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of role definitions.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingRoleDefinitions/{roleDefinitionName}": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_GetByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/roleDefinitionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of a role definition.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleDefinitionGetByBillingAccount": { - "$ref": "./examples/billingRoleDefinitionGetByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of role definitions.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/departments/{departmentName}/billingRoleDefinitions/{roleDefinitionName}": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_GetByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/roleDefinitionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of a role definition.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingRoleDefinitions": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_ListByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of a role definition.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions/{roleDefinitionName}": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_GetByEnrollmentAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/roleDefinitionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The properties of a role definition.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingRoleDefinitions": { - "get": { - "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/" - }, - "operationId": "BillingRoleDefinition_ListByEnrollmentAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of role definitions.", - "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingRoleDefinitionListByEnrollmentAccount": { - "$ref": "./examples/billingRoleDefinitionListByEnrollmentAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "BillingPermission": { - "description": "The set of allowed action and not allowed actions a caller has on a resource.", - "type": "object", - "properties": { - "actions": { - "description": "The set of actions that the caller is allowed to perform.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "notActions": { - "description": "The set of actions that the caller is not allowed to perform.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - }, - "readOnly": true - }, - "BillingRoleDefinition": { - "description": "The properties of a role definition.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingRoleDefinitionProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingRoleDefinitionListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingRoleDefinition" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "BillingRoleDefinitionProperties": { - "description": "The properties of a role definition.", - "required": [ - "roleName" - ], - "type": "object", - "properties": { - "description": { - "description": "The role description.", - "type": "string", - "readOnly": true - }, - "permissions": { - "description": "The billingPermissions the role has.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingPermission" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "roleName": { - "description": "The name of the role.", - "minLength": 1, - "type": "string" - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingSavingsPlan.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingSavingsPlan.json deleted file mode 100644 index 77e0803e69df..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingSavingsPlan.json +++ /dev/null @@ -1,1246 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2024-04-01", - "title": "BillingManagementClient", - "description": "Billing client provides access to billing resources for Azure subscriptions." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}": { - "get": { - "description": "Get a savings plan order by billing account.", - "operationId": "SavingsPlanOrders_GetByBillingAccount", - "tags": [ - "Savings plan order" - ], - "x-ms-examples": { - "SavingsPlanOrderGet": { - "$ref": "./examples/savingsPlanOrderGetByBillingAccount.json" - }, - "SavingsPlanOrderWithExpandedPaymentsGet": { - "$ref": "./examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/SavingsPlanOrderIdParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/ExpandParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/SavingsPlanOrderModel" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders": { - "get": { - "description": "List all Savings plan orders by billing account.", - "operationId": "SavingsPlanOrders_ListByBillingAccount", - "tags": [ - "Savings plan order" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SavingsPlanOrderList": { - "$ref": "./examples/savingsPlanOrderListByBillingAccount.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "#/parameters/SkipTokenParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/SavingsPlanOrderModelList" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans": { - "get": { - "description": "List savings plans in an order by billing account.", - "operationId": "SavingsPlans_ListBySavingsPlanOrder", - "tags": [ - "Savings plan" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SavingsPlansInOrderList": { - "$ref": "./examples/savingsPlansListBySavingsPlanOrders.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/SavingsPlanOrderIdParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/SavingsPlanModelList" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans": { - "get": { - "description": "List savings plans by billing account.", - "operationId": "SavingsPlans_ListByBillingAccount", - "tags": [ - "Savings plan" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SavingsPlansList": { - "$ref": "./examples/savingsPlansListByBillingAccount.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "#/parameters/SkipTokenParameter" - }, - { - "$ref": "#/parameters/TakeParameter" - }, - { - "$ref": "#/parameters/SelectedStateParameter" - }, - { - "$ref": "#/parameters/RefreshSummaryParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/SavingsPlanModelListResult" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}": { - "get": { - "description": "Get savings plan by billing account.", - "operationId": "SavingsPlans_GetByBillingAccount", - "tags": [ - "Savings plan" - ], - "x-ms-examples": { - "SavingsPlanGet": { - "$ref": "./examples/savingsPlanGetByBillingAccount.json" - }, - "SavingsPlanGetExpandRenewProperties": { - "$ref": "./examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/SavingsPlanOrderIdParameter" - }, - { - "$ref": "#/parameters/SavingsPlanIdParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/ExpandParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/SavingsPlanModel" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Update savings plan by billing account.", - "operationId": "SavingsPlans_UpdateByBillingAccount", - "tags": [ - "Savings plan" - ], - "x-ms-examples": { - "SavingsPlanUpdate": { - "$ref": "./examples/savingsPlanUpdateByBillingAccount.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/SavingsPlanOrderIdParameter" - }, - { - "$ref": "#/parameters/SavingsPlanIdParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/SavingsPlanUpdateRequestParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/SavingsPlanModel" - } - }, - "202": { - "description": "The request is accepted.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "URL for checking the ongoing status of the operation." - }, - "Location": { - "type": "string", - "description": "URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned." - }, - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "Clients should wait for the Retry-After interval before polling again" - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate": { - "post": { - "description": "Validate savings plan patch by billing account.", - "operationId": "SavingsPlans_ValidateUpdateByBillingAccount", - "tags": [ - "Savings plan" - ], - "x-ms-examples": { - "SavingsPlanValidateUpdate": { - "$ref": "./examples/savingsPlanValidateUpdateByBillingAccount.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/SavingsPlanOrderIdParameter" - }, - { - "$ref": "#/parameters/SavingsPlanIdParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/SavingsPlanUpdateValidateRequestParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/SavingsPlanValidateResponse" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Sku": { - "type": "object", - "description": "The SKU to be applied for this resource", - "properties": { - "name": { - "type": "string", - "description": "Name of the SKU to be applied" - } - } - }, - "BillingScopeId": { - "type": "string", - "description": "Subscription that will be charged for purchasing SavingsPlan" - }, - "BillingProfileId": { - "type": "string", - "readOnly": true, - "description": "Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers." - }, - "CustomerId": { - "type": "string", - "readOnly": true, - "description": "Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers." - }, - "BillingAccountId": { - "type": "string", - "readOnly": true, - "description": "Fully-qualified identifier of the billing account where the savings plan is applied." - }, - "ProvisioningState": { - "type": "string", - "description": "Provisioning state", - "readOnly": true, - "enum": [ - "PendingBilling", - "ConfirmedBilling", - "Creating", - "Failed", - "Created", - "Succeeded", - "Canceled", - "Expired" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "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 - } - }, - "Renew": { - "type": "boolean", - "default": false, - "description": "Setting this to true will automatically purchase a new benefit on the expiration date time." - }, - "BenefitTerm": { - "type": "string", - "description": "Represents the Savings plan term in ISO 8601 format.", - "enum": [ - "P1Y", - "P3Y", - "P5Y" - ], - "x-ms-enum": { - "name": "SavingsPlanTerm", - "modelAsString": true - } - }, - "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 - } - }, - "AppliedScopeProperties": { - "type": "object", - "description": "Properties specific to applied scope type. Not required if not applicable.", - "properties": { - "tenantId": { - "$ref": "#/definitions/TenantId" - }, - "managementGroupId": { - "$ref": "#/definitions/ManagementGroupId" - }, - "subscriptionId": { - "$ref": "#/definitions/SubscriptionId" - }, - "resourceGroupId": { - "$ref": "#/definitions/ResourceGroupId" - }, - "displayName": { - "type": "string", - "description": "Display name" - } - } - }, - "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." - }, - "Commitment": { - "type": "object", - "description": "Commitment towards the benefit.", - "allOf": [ - { - "$ref": "#/definitions/Price" - } - ], - "properties": { - "grain": { - "type": "string", - "description": "Commitment grain.", - "enum": [ - "Hourly" - ], - "x-ms-enum": { - "name": "CommitmentGrain", - "modelAsString": true - } - } - } - }, - "SavingsPlanId": { - "type": "string", - "description": "Identifier of the savings plan", - "readOnly": true - }, - "SavingsPlanModelList": { - "type": "object", - "description": "List of savings plans", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SavingsPlanModel" - } - }, - "nextLink": { - "type": "string", - "description": "Url to get the next page." - } - } - }, - "SavingsPlanModelListResult": { - "type": "object", - "description": "List of savings plans", - "allOf": [ - { - "$ref": "#/definitions/SavingsPlanModelList" - } - ], - "properties": { - "summary": { - "description": "The roll out count summary of the savings plans", - "$ref": "#/definitions/SavingsPlanSummaryCount" - } - } - }, - "SavingsPlanModel": { - "type": "object", - "description": "Savings plan", - "required": [ - "sku" - ], - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "sku": { - "description": "Savings plan SKU", - "$ref": "#/definitions/Sku" - }, - "properties": { - "description": "Savings plan properties", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SavingsPlanModelProperties" - } - } - }, - "SavingsPlanModelProperties": { - "type": "object", - "description": "Savings plan properties", - "properties": { - "displayName": { - "$ref": "#/definitions/DisplayName" - }, - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "displayProvisioningState": { - "description": "The provisioning state of the savings plan for display, e.g. Succeeded", - "type": "string", - "readOnly": true - }, - "userFriendlyAppliedScopeType": { - "description": "The applied scope type of the savings plan for display, e.g. Shared", - "type": "string", - "readOnly": true - }, - "billingScopeId": { - "$ref": "#/definitions/BillingScopeId" - }, - "billingProfileId": { - "$ref": "#/definitions/BillingProfileId" - }, - "customerId": { - "$ref": "#/definitions/CustomerId" - }, - "billingAccountId": { - "$ref": "#/definitions/BillingAccountId" - }, - "term": { - "$ref": "#/definitions/BenefitTerm" - }, - "renew": { - "$ref": "#/definitions/Renew" - }, - "renewSource": { - "$ref": "#/definitions/RenewSource" - }, - "renewDestination": { - "$ref": "#/definitions/RenewDestination" - }, - "renewProperties": { - "$ref": "#/definitions/RenewProperties" - }, - "billingPlan": { - "$ref": "#/definitions/BillingPlan" - }, - "appliedScopeType": { - "$ref": "#/definitions/AppliedScopeType" - }, - "appliedScopeProperties": { - "$ref": "#/definitions/AppliedScopeProperties" - }, - "commitment": { - "$ref": "#/definitions/Commitment" - }, - "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" - }, - "extendedStatusInfo": { - "$ref": "#/definitions/ExtendedStatusInfo" - }, - "productCode": { - "$ref": "#/definitions/ProductCode" - } - } - }, - "SavingsPlanSummaryCount": { - "description": "The roll up count summary of savings plans in each state", - "type": "object", - "properties": { - "succeededCount": { - "description": "The number of savings plans in Succeeded state", - "readOnly": true, - "type": "number" - }, - "failedCount": { - "description": "The number of savings plans in Failed state", - "readOnly": true, - "type": "number" - }, - "expiringCount": { - "description": "The number of savings plans in Expiring state", - "readOnly": true, - "type": "number" - }, - "expiredCount": { - "description": "The number of savings plans in Expired state", - "readOnly": true, - "type": "number" - }, - "pendingCount": { - "description": "The number of savings plans in Pending state", - "readOnly": true, - "type": "number" - }, - "cancelledCount": { - "description": "The number of savings plans in Cancelled state", - "readOnly": true, - "type": "number" - }, - "processingCount": { - "description": "The number of savings plans in Processing state", - "readOnly": true, - "type": "number" - }, - "noBenefitCount": { - "description": "The number of savings plans in No Benefit state", - "readOnly": true, - "type": "number" - }, - "warningCount": { - "description": "The number of savings plans in Warning state", - "readOnly": true, - "type": "number" - } - } - }, - "SavingsPlanOrderModelList": { - "type": "object", - "description": "List of savings plan orders", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SavingsPlanOrderModel" - } - }, - "nextLink": { - "type": "string", - "description": "Url to get the next page." - } - } - }, - "SavingsPlanOrderModel": { - "type": "object", - "description": "Savings plan order", - "required": [ - "sku" - ], - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "sku": { - "description": "Savings plan SKU", - "$ref": "#/definitions/Sku" - }, - "properties": { - "description": "Savings plan order properties", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SavingsPlanOrderModelProperties" - } - } - }, - "SavingsPlanOrderModelProperties": { - "type": "object", - "description": "Savings plan order properties", - "properties": { - "displayName": { - "$ref": "#/definitions/DisplayName" - }, - "provisioningState": { - "description": "The provisioning state of the savings plan, e.g. Succeeded", - "readOnly": true, - "type": "string" - }, - "billingScopeId": { - "$ref": "#/definitions/BillingScopeId" - }, - "billingProfileId": { - "$ref": "#/definitions/BillingProfileId" - }, - "customerId": { - "$ref": "#/definitions/CustomerId" - }, - "billingAccountId": { - "$ref": "#/definitions/BillingAccountId" - }, - "term": { - "$ref": "#/definitions/BenefitTerm" - }, - "billingPlan": { - "$ref": "#/definitions/BillingPlan" - }, - "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" - }, - "savingsPlans": { - "type": "array", - "items": { - "$ref": "#/definitions/SavingsPlanId" - } - }, - "extendedStatusInfo": { - "$ref": "#/definitions/ExtendedStatusInfo" - }, - "productCode": { - "$ref": "#/definitions/ProductCode" - } - } - }, - "SavingsPlanUpdateRequest": { - "type": "object", - "description": "Savings plan patch request", - "properties": { - "properties": { - "$ref": "#/definitions/SavingsPlanUpdateRequestProperties" - }, - "sku": { - "$ref": "#/definitions/Sku" - }, - "tags": { - "description": "Tags for this reservation", - "$ref": "#/definitions/Tags" - } - } - }, - "SavingsPlanUpdateRequestProperties": { - "type": "object", - "description": "Savings plan patch request", - "properties": { - "displayName": { - "$ref": "#/definitions/DisplayName" - }, - "appliedScopeType": { - "$ref": "#/definitions/AppliedScopeType" - }, - "appliedScopeProperties": { - "$ref": "#/definitions/AppliedScopeProperties" - }, - "renew": { - "$ref": "#/definitions/Renew" - }, - "renewProperties": { - "$ref": "#/definitions/RenewProperties" - } - } - }, - "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": { - "type": "object", - "description": "Properties specific to renew.", - "properties": { - "purchaseProperties": { - "$ref": "#/definitions/PurchaseRequest" - } - } - }, - "PurchaseRequest": { - "type": "object", - "description": "Purchase request.", - "properties": { - "sku": { - "$ref": "#/definitions/Sku" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PurchaseRequestProperties" - } - } - }, - "PurchaseRequestProperties": { - "type": "object", - "description": "Purchase request properties.", - "properties": { - "displayName": { - "type": "string", - "description": "Friendly name of the savings plan" - }, - "billingScopeId": { - "$ref": "#/definitions/BillingScopeId" - }, - "term": { - "$ref": "#/definitions/BenefitTerm" - }, - "billingPlan": { - "$ref": "#/definitions/BillingPlan" - }, - "appliedScopeType": { - "$ref": "#/definitions/AppliedScopeType" - }, - "commitment": { - "$ref": "#/definitions/Commitment" - }, - "renew": { - "$ref": "#/definitions/Renew" - }, - "appliedScopeProperties": { - "$ref": "#/definitions/AppliedScopeProperties" - } - } - }, - "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" - } - } - }, - "Tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource Tags" - }, - "ProductCode": { - "type": "string", - "description": "Represents UPN" - }, - "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": [] - } - } - }, - "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" - }, - "extendedStatusInfo": { - "$ref": "#/definitions/ExtendedStatusInfo" - } - } - }, - "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 - } - }, - "Utilization": { - "readOnly": true, - "type": "object", - "description": "Savings plan utilization", - "properties": { - "trend": { - "description": "The trend for a savings plan's utilization", - "readOnly": true, - "type": "string" - }, - "aggregates": { - "description": "The array of aggregates of a savings plan's utilization", - "type": "array", - "items": { - "$ref": "#/definitions/UtilizationAggregates" - }, - "x-ms-identifiers": [] - } - } - }, - "UtilizationAggregates": { - "description": "The aggregate values of savings plan utilization", - "type": "object", - "properties": { - "grain": { - "description": "The grain of the aggregate", - "readOnly": true, - "type": "number" - }, - "grainUnit": { - "description": "The grain unit of the aggregate", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The aggregate value", - "readOnly": true, - "type": "number" - }, - "valueUnit": { - "description": "The aggregate value unit", - "readOnly": true, - "type": "string" - } - } - }, - "ExtendedStatusInfo": { - "type": "object", - "readOnly": true, - "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": { - "type": "object", - "description": "Properties specific to credit line check failure", - "x-ms-client-flatten": true, - "properties": { - "subscriptionId": { - "type": "string", - "description": "The subscription that has failed credit line check." - } - } - } - } - }, - "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": [] - } - } - }, - "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." - } - } - }, - "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" - } - } - } - }, - "parameters": { - "ExpandParameter": { - "name": "expand", - "description": "May be used to expand the planInformation.", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "string" - }, - "SkipTokenParameter": { - "name": "skiptoken", - "description": "The number of savings plans to skip from the list before returning results", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "number" - }, - "TakeParameter": { - "name": "take", - "description": "The number of savings plans to return", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "number" - }, - "SelectedStateParameter": { - "name": "selectedState", - "description": "The selected provisioning state", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "string" - }, - "RefreshSummaryParameter": { - "name": "refreshSummary", - "description": "To indicate whether to refresh the roll up counts of the savings plans group by provisioning states", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "string" - }, - "SavingsPlanOrderIdParameter": { - "name": "savingsPlanOrderId", - "description": "Order ID of the savings plan", - "in": "path", - "x-ms-parameter-location": "method", - "required": true, - "type": "string" - }, - "SavingsPlanIdParameter": { - "name": "savingsPlanId", - "description": "ID of the savings plan", - "in": "path", - "x-ms-parameter-location": "method", - "required": true, - "type": "string" - }, - "SavingsPlanUpdateRequestParameter": { - "name": "body", - "description": "Request body for patching a savings plan order alias", - "in": "body", - "x-ms-parameter-location": "method", - "required": true, - "schema": { - "$ref": "#/definitions/SavingsPlanUpdateRequest" - } - }, - "SavingsPlanUpdateValidateRequestParameter": { - "name": "body", - "description": "Request body for patching a savings plan order alias", - "in": "body", - "x-ms-parameter-location": "method", - "required": true, - "schema": { - "$ref": "#/definitions/SavingsPlanUpdateValidateRequest" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingSubscription.json deleted file mode 100644 index 3b668e9eefd3..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/billingSubscription.json +++ /dev/null @@ -1,2082 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions/{billingSubscriptionName}": { - "get": { - "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/" - }, - "operationId": "BillingSubscriptions_GetByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", - "type": "string" - } - ], - "responses": { - "200": { - "description": "A billing subscription.", - "schema": { - "$ref": "#/definitions/BillingSubscription" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingSubscriptions": { - "get": { - "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/" - }, - "operationId": "BillingSubscriptions_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted billing subscriptions.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing subscriptions.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingSubscriptionsListByBillingProfileMCA": { - "$ref": "./examples/billingSubscriptionsListByBillingProfileMCA.json" - }, - "BillingSubscriptionsListByBillingProfileEA": { - "$ref": "./examples/billingSubscriptionsListByBillingProfileEA.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingSubscriptions": { - "get": { - "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/" - }, - "operationId": "BillingSubscriptions_ListByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/customerNameParameter" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted billing subscriptions.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing subscriptions.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/invoiceSections/{invoiceSectionName}/billingSubscriptions": { - "get": { - "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/" - }, - "operationId": "BillingSubscriptions_ListByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/invoiceSectionNameParameter" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted billing subscriptions.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing subscriptions.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingSubscriptionAliases/{aliasName}": { - "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/" - }, - "operationId": "BillingSubscriptionsAliases_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionAliasNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A billing subscription alias.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionAlias" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingSubscriptionAliasGet": { - "$ref": "./examples/billingSubscriptionAliasGet.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "BillingSubscriptionsAliases_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionAliasNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A billing subscription alias.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingSubscriptionAlias" - } - } - ], - "responses": { - "200": { - "description": "The billing subscription alias.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionAlias" - } - }, - "201": { - "description": "The billing subscription alias.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionAlias" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingSubscriptionAliasCreateOrUpdate": { - "$ref": "./examples/billingSubscriptionAliasCreateOrUpdate.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases": { - "get": { - "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/" - }, - "operationId": "BillingSubscriptionsAliases_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted billing subscriptions.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing subscription aliases.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionAliasListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/billingSubscriptions/{billingSubscriptionName}/cancel": { - "post": { - "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/" - }, - "operationId": "BillingSubscriptions_Cancel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "Request parameters for cancel customer subscription.", - "required": true, - "schema": { - "$ref": "#/definitions/CancelSubscriptionRequest" - } - } - ], - "responses": { - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingSubscriptionsCancel": { - "$ref": "./examples/billingSubscriptionsCancel.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/merge": { - "post": { - "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/" - }, - "operationId": "BillingSubscriptions_Merge", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "Request parameters that are provided to merge the two billing subscriptions.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingSubscriptionMergeRequest" - } - } - ], - "responses": { - "200": { - "description": "The billing properties of a subscription.", - "schema": { - "$ref": "#/definitions/BillingSubscription" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingSubscriptionsMerge": { - "$ref": "./examples/billingSubscriptionsMerge.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/move": { - "post": { - "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/" - }, - "operationId": "BillingSubscriptions_Move", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "Request parameters to transfer billing subscription.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveBillingSubscriptionRequest" - } - } - ], - "responses": { - "200": { - "description": "The billing properties of a subscription.", - "schema": { - "$ref": "#/definitions/BillingSubscription" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingSubscriptionMove": { - "$ref": "./examples/billingSubscriptionMove.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/split": { - "post": { - "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/" - }, - "operationId": "BillingSubscriptions_Split", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "Request parameters that are provided to split the billing subscription.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingSubscriptionSplitRequest" - } - } - ], - "responses": { - "200": { - "description": "The billing properties of a subscription.", - "schema": { - "$ref": "#/definitions/BillingSubscription" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingSubscriptionsSplit": { - "$ref": "./examples/billingSubscriptionsSplit.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/validateMoveEligibility": { - "post": { - "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/" - }, - "operationId": "BillingSubscriptions_ValidateMoveEligibility", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "Request parameters to transfer billing subscription.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveBillingSubscriptionRequest" - } - } - ], - "responses": { - "200": { - "description": "The billing properties of a subscription.", - "schema": { - "$ref": "#/definitions/MoveBillingSubscriptionEligibilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingSubscriptionValidateMoveSuccess": { - "$ref": "./examples/billingSubscriptionValidateMoveSuccess.json" - }, - "BillingSubscriptionValidateMoveFailure": { - "$ref": "./examples/billingSubscriptionValidateMoveFailure.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}": { - "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/" - }, - "operationId": "BillingSubscriptions_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingSubscriptionsDelete": { - "$ref": "./examples/billingSubscriptionsDelete.json" - } - } - }, - "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/" - }, - "operationId": "BillingSubscriptions_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", - "type": "string" - } - ], - "responses": { - "200": { - "description": "A billing subscription.", - "schema": { - "$ref": "#/definitions/BillingSubscription" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingSubscriptionsGet": { - "$ref": "./examples/billingSubscriptionsGet.json" - } - } - }, - "patch": { - "tags": [ - "BillingSubscription" - ], - "description": "Updates the properties of a billing subscription.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingSubscriptions_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingSubscriptionNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The billing properties of a subscription.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingSubscriptionPatch" - } - } - ], - "responses": { - "200": { - "description": "The billing properties of a subscription.", - "schema": { - "$ref": "#/definitions/BillingSubscription" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "BillingSubscriptionsUpdate": { - "$ref": "./examples/billingSubscriptionsUpdate.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions": { - "get": { - "tags": [ - "BillingSubscription" - ], - "description": "Lists the subscriptions for a billing account.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "BillingSubscriptions_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted billing subscriptions.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includeTenantSubscriptions", - "description": "Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includeFailed", - "description": "Can be used to get failed billing subscriptions.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing subscriptions.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/customers/{customerName}/billingSubscriptions": { - "get": { - "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/" - }, - "operationId": "BillingSubscriptions_ListByCustomerAtBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/customerNameParameter" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted billing subscriptions.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing subscriptions.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/enrollmentAccounts/{enrollmentAccountName}/billingSubscriptions": { - "get": { - "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/" - }, - "operationId": "BillingSubscriptions_ListByEnrollmentAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of billing subscriptions.", - "schema": { - "$ref": "#/definitions/BillingSubscriptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "BillingSubscriptionsListByEnrollmentAccount": { - "$ref": "./examples/billingSubscriptionsListByEnrollmentAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Beneficiary": { - "description": "Details of the beneficiary.", - "type": "object", - "properties": { - "tenantId": { - "description": "The ID that uniquely identifies a tenant.", - "type": "string" - }, - "objectId": { - "description": "The ID that uniquely identifies a user in a tenant.", - "type": "string" - } - } - }, - "BillingSubscription": { - "description": "The billing properties of a subscription.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "description": "The properties of a(n) BillingSubscription", - "$ref": "#/definitions/BillingSubscriptionProperties", - "x-ms-client-flatten": true - } - }, - "x-ms-azure-resource": true - }, - "BillingSubscriptionAlias": { - "description": "A billing subscription alias.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "description": "The properties of a(n) BillingSubscriptionAlias", - "$ref": "#/definitions/BillingSubscriptionAliasProperties", - "x-ms-client-flatten": true - } - }, - "x-ms-azure-resource": true - }, - "BillingSubscriptionAliasListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingSubscriptionAlias" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "BillingSubscriptionAliasProperties": { - "description": "A billing subscription alias.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BillingSubscriptionProperties" - } - ], - "properties": { - "billingSubscriptionId": { - "description": "The ID of the billing subscription with the subscription alias.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - } - } - }, - "BillingSubscriptionListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "totalCount": { - "description": "Total number of records.", - "type": "number", - "format": "int32", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingSubscription" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "BillingSubscriptionMergeRequest": { - "description": "Request parameters that are provided to merge the two billing subscriptions.", - "type": "object", - "properties": { - "targetBillingSubscriptionName": { - "description": "The ID of the target billing subscription that will be merged with the source subscription provided in the request.", - "type": "string" - }, - "quantity": { - "format": "int32", - "description": "The quantity of the source billing subscription that will be merged with the target billing subscription.", - "type": "integer" - } - } - }, - "BillingSubscriptionPatch": { - "description": "The billing properties of a subscription.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "description": "The properties of a(n) BillingSubscription", - "$ref": "#/definitions/BillingSubscriptionProperties", - "x-ms-client-flatten": true - } - }, - "x-ms-azure-resource": true - }, - "BillingSubscriptionProperties": { - "description": "The billing properties of a subscription.", - "type": "object", - "properties": { - "autoRenew": { - "description": "Indicates whether auto renewal is turned on or off for a product.", - "enum": [ - "Off", - "On" - ], - "type": "string", - "x-ms-enum": { - "name": "AutoRenew", - "modelAsString": true - } - }, - "beneficiaryTenantId": { - "description": "The provisioning tenant of the subscription.", - "type": "string" - }, - "beneficiary": { - "description": "The beneficiary of the billing subscription.", - "$ref": "#/definitions/Beneficiary" - }, - "billingFrequency": { - "description": "The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y", - "type": "string" - }, - "billingProfileId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string" - }, - "billingPolicies": { - "type": "object", - "description": "Dictionary of billing policies associated with the subscription.", - "additionalProperties": { - "type": "string" - }, - "maxItems": 50, - "readOnly": true - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileName": { - "description": "The ID that uniquely identifies a billing profile.", - "type": "string", - "readOnly": true - }, - "consumptionCostCenter": { - "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.", - "type": "string" - }, - "customerId": { - "description": "The fully qualified ID that uniquely identifies a customer.", - "type": "string" - }, - "customerDisplayName": { - "description": "The name of the customer.", - "type": "string", - "readOnly": true - }, - "customerName": { - "description": "The ID that uniquely identifies a customer.", - "type": "string", - "readOnly": true - }, - "displayName": { - "description": "The name of the billing subscription.", - "type": "string" - }, - "enrollmentAccountId": { - "description": "The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.", - "type": "string", - "readOnly": true - }, - "enrollmentAccountDisplayName": { - "description": "The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.", - "type": "string", - "readOnly": true - }, - "enrollmentAccountSubscriptionDetails": { - "x-ms-client-flatten": true, - "description": "Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.", - "$ref": "#/definitions/EnrollmentAccountSubscriptionDetails" - }, - "invoiceSectionId": { - "description": "The fully qualified ID that uniquely identifies an invoice section.", - "type": "string" - }, - "invoiceSectionDisplayName": { - "description": "The name of the invoice section.", - "type": "string", - "readOnly": true - }, - "invoiceSectionName": { - "description": "The ID that uniquely identifies an invoice section.", - "type": "string", - "readOnly": true - }, - "lastMonthCharges": { - "description": "The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.", - "$ref": "./types.json#/definitions/Amount", - "readOnly": true - }, - "monthToDateCharges": { - "description": "The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.", - "$ref": "./types.json#/definitions/Amount", - "readOnly": true - }, - "nextBillingCycleDetails": { - "description": "Next billing cycle details of the subscription.", - "$ref": "#/definitions/NextBillingCycleDetails" - }, - "offerId": { - "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.", - "type": "string", - "readOnly": true - }, - "productCategory": { - "description": "The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.", - "type": "string", - "readOnly": true - }, - "productType": { - "description": "Type of the product for which the subscription is purchased.", - "type": "string", - "readOnly": true - }, - "productTypeId": { - "description": "Id of the product for which the subscription is purchased.", - "type": "string" - }, - "purchaseDate": { - "format": "date-time", - "description": "Purchase date of the product in UTC time.", - "type": "string", - "readOnly": true - }, - "quantity": { - "format": "int64", - "description": "The quantity of licenses or fulfillment units for the subscription.", - "type": "integer" - }, - "reseller": { - "description": "Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.", - "$ref": "./types.json#/definitions/Reseller" - }, - "renewalTermDetails": { - "description": "Details for the next renewal term of a subscription.", - "$ref": "#/definitions/RenewalTermDetails" - }, - "skuId": { - "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.", - "type": "string" - }, - "skuDescription": { - "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.", - "type": "string", - "readOnly": true - }, - "systemOverrides": { - "description": "System imposed policies that regulate behavior of the subscription.", - "$ref": "#/definitions/SystemOverrides" - }, - "resourceUri": { - "description": "Unique identifier of the linked resource.", - "type": "string", - "readOnly": true - }, - "termDuration": { - "description": "The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y", - "type": "string" - }, - "termStartDate": { - "format": "date-time", - "description": "Start date of the term in UTC time.", - "type": "string", - "readOnly": true - }, - "termEndDate": { - "format": "date-time", - "description": "End date of the term in UTC time.", - "type": "string", - "readOnly": true - }, - "provisioningTenantId": { - "description": "The tenant in which the subscription is provisioned.", - "type": "string" - }, - "status": { - "description": "The status of the subscription. This field is not available for Enterprise Agreement billing accounts", - "enum": [ - "Other", - "Unknown", - "Active", - "Disabled", - "Deleted", - "Warned", - "Expiring", - "Expired", - "AutoRenew", - "Cancelled", - "Suspended", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingSubscriptionStatus", - "modelAsString": true - } - }, - "operationStatus": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BillingSubscriptionOperationStatus", - "modelAsString": true - } - }, - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "subscriptionId": { - "description": "The ID of the subscription.", - "type": "string", - "readOnly": true - }, - "suspensionReasons": { - "description": "The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "suspensionReasonDetails": { - "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", - "type": "array", - "items": { - "$ref": "#/definitions/BillingSubscriptionStatusDetails" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "BillingSubscriptionSplitRequest": { - "description": "Request parameters that are provided to split the billing subscription.", - "type": "object", - "properties": { - "targetProductTypeId": { - "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.", - "type": "string" - }, - "targetSkuId": { - "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.", - "type": "string" - }, - "quantity": { - "format": "int32", - "description": "The quantity of the target product to which the subscription needs to be split into.", - "type": "integer" - }, - "termDuration": { - "description": "The term duration of the target in ISO8601 format product to which the subscription needs to be split into. Example: P1M, P1Y", - "type": "string" - }, - "billingFrequency": { - "description": "The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y\"", - "type": "string" - } - } - }, - "BillingSubscriptionStatusDetails": { - "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", - "type": "object", - "properties": { - "effectiveDate": { - "format": "date-time", - "description": "The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts.", - "type": "string", - "readOnly": true - }, - "reason": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SubscriptionStatusReason", - "modelAsString": true - } - } - } - }, - "CancelSubscriptionRequest": { - "description": "Request parameters for cancel customer subscription.", - "required": [ - "cancellationReason" - ], - "type": "object", - "properties": { - "cancellationReason": { - "description": "Cancellation reason.", - "enum": [ - "Other", - "Compromise", - "Dispute" - ], - "type": "string", - "x-ms-enum": { - "name": "CancellationReason", - "modelAsString": true - } - }, - "customerId": { - "description": "The fully qualified ID that uniquely identifies a customer.", - "type": "string" - } - } - }, - "EnrollmentAccountSubscriptionDetails": { - "description": "The billing properties that can be modified. Available only for the Enterprise Agreement Type.", - "type": "object", - "properties": { - "enrollmentAccountStartDate": { - "format": "date-time", - "description": "The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type.", - "type": "string", - "readOnly": true - }, - "subscriptionEnrollmentAccountStatus": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SubscriptionEnrollmentAccountStatus", - "modelAsString": true - } - } - }, - "readOnly": true - }, - "MoveBillingSubscriptionEligibilityResult": { - "description": "Result of the transfer eligibility validation.", - "type": "object", - "properties": { - "isMoveEligible": { - "description": "Specifies whether the subscription is eligible to be transferred.", - "type": "boolean", - "readOnly": true - }, - "errorDetails": { - "description": "Error details of the transfer eligibility validation.", - "$ref": "#/definitions/MoveBillingSubscriptionErrorDetails" - } - } - }, - "MoveBillingSubscriptionErrorDetails": { - "description": "Error details of the transfer eligibility validation.", - "type": "object", - "properties": { - "code": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "subscriptionTransferValidationErrorCode", - "modelAsString": true - } - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "details": { - "description": "Detailed error message explaining the error.", - "type": "string" - } - } - }, - "MoveBillingSubscriptionRequest": { - "description": "Request parameters to transfer billing subscription.", - "type": "object", - "properties": { - "destinationInvoiceSectionId": { - "description": "The destination invoice section id.", - "type": "string" - }, - "destinationEnrollmentAccountId": { - "description": "The destination enrollment account id.", - "type": "string" - } - } - }, - "NextBillingCycleDetails": { - "description": "Billing cycle details of the product.", - "type": "object", - "properties": { - "billingFrequency": { - "description": "Billing frequency of the product under the subscription.", - "type": "string", - "readOnly": true - } - }, - "readOnly": true - }, - "RenewalTermDetails": { - "description": "Details for the next renewal term of a subscription.", - "type": "object", - "properties": { - "billingFrequency": { - "description": "The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y", - "type": "string", - "readOnly": true - }, - "productId": { - "description": "Id of the product for which the subscription is purchased.", - "type": "string", - "readOnly": true - }, - "productTypeId": { - "description": "Type Id of the product for which the subscription is purchased.", - "type": "string", - "readOnly": true - }, - "skuId": { - "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.", - "type": "string", - "readOnly": true - }, - "termDuration": { - "description": "The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y", - "type": "string", - "readOnly": true - }, - "quantity": { - "format": "int64", - "description": "The quantity of licenses or fulfillment units for the subscription.", - "type": "integer" - }, - "termEndDate": { - "format": "date-time", - "description": "End date of the term in UTC time.", - "type": "string", - "readOnly": true - } - }, - "readOnly": true - }, - "SystemOverrides": { - "description": "System imposed policies that regulate behavior of the subscription.", - "type": "object", - "properties": { - "cancellation": { - "description": "The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.", - "enum": [ - "NotAllowed", - "Allowed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "Cancellation", - "modelAsString": true - } - }, - "cancellationAllowedEndDate": { - "format": "date-time", - "description": "The end date in UTC time by when the self-serve cancellation ends.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "billingAccountNameParameter": { - "name": "billingAccountName", - "in": "path", - "description": "The ID that uniquely identifies a billing account.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "transferTrackingGuidParameter": { - "name": "transferTrackingGuid", - "in": "path", - "description": "The ID that uniquely identifies a billing subscription transfer request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingProfileNameParameter": { - "name": "billingProfileName", - "in": "path", - "description": "The ID that uniquely identifies a billing profile.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingSubscriptionAliasNameParameter": { - "name": "aliasName", - "in": "path", - "description": "The ID that uniquely identifies a subscription alias.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingSubscriptionNameParameter": { - "name": "billingSubscriptionName", - "in": "path", - "description": "The ID that uniquely identifies a subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "costCenterNameParameter": { - "name": "costCenterName", - "x-ms-parameter-location": "method", - "in": "query", - "required": true, - "description": "Request parameters that are provided to the update cost center operation.", - "type": "string" - }, - "customerNameParameter": { - "name": "customerName", - "in": "path", - "description": "The ID that uniquely identifies a customer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "enrollmentAccountNameParameter": { - "name": "enrollmentAccountName", - "in": "path", - "description": "The ID that uniquely identifies an enrollment account.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "departmentNameParameter": { - "name": "departmentName", - "in": "path", - "description": "The ID that uniquely identifies a department.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "invoiceSectionNameParameter": { - "name": "invoiceSectionName", - "in": "path", - "description": "The ID that uniquely identifies an invoice section.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/customer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/customer.json deleted file mode 100644 index 5bb402102809..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/customer.json +++ /dev/null @@ -1,379 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}": { - "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/" - }, - "operationId": "Customers_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A partner's customer.", - "schema": { - "$ref": "#/definitions/Customer" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "get": { - "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/" - }, - "operationId": "Customers_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "May be used to expand enabledAzurePlans and resellers", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "A list of customers.", - "schema": { - "$ref": "#/definitions/CustomerListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/customers/{customerName}": { - "get": { - "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/" - }, - "operationId": "Customers_GetByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A partner's customer.", - "schema": { - "$ref": "#/definitions/Customer" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "get": { - "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/" - }, - "operationId": "Customers_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "expand", - "description": "May be used to expand enabledAzurePlans and resellers", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "A list of customers.", - "schema": { - "$ref": "#/definitions/CustomerListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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" - } - } - } - }, - "definitions": { - "Customer": { - "description": "A partner's customer.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/CustomerProperties" - } - }, - "x-ms-azure-resource": true - }, - "CustomerListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Customer" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "CustomerProperties": { - "description": "A partner's customer.", - "type": "object", - "properties": { - "billingProfileDisplayName": { - "description": "The name of the billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string", - "readOnly": true - }, - "displayName": { - "description": "The name of the customer.", - "type": "string", - "readOnly": true - }, - "systemId": { - "description": "The system generated unique identifier for a customer.", - "type": "string", - "readOnly": true - }, - "status": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "CustomerStatus", - "modelAsString": true - } - }, - "enabledAzurePlans": { - "description": "Azure plans enabled for the customer.", - "type": "array", - "items": { - "$ref": "./types.json#/definitions/AzurePlan" - }, - "x-ms-identifiers": [] - }, - "resellers": { - "description": "The list of resellers for which an Azure plan is enabled for the customer.", - "type": "array", - "items": { - "$ref": "./types.json#/definitions/Reseller" - }, - "x-ms-identifiers": [] - }, - "tags": { - "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 < > % & \\ ? /", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/department.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/department.json deleted file mode 100644 index 932e77e43172..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/department.json +++ /dev/null @@ -1,204 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}": { - "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/" - }, - "operationId": "Departments_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Department" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "get": { - "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/" - }, - "operationId": "Departments_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/DepartmentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "DepartmentsListByBillingAccount": { - "$ref": "./examples/departmentsListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Department": { - "description": "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/DepartmentProperties" - } - }, - "x-ms-azure-resource": true - }, - "DepartmentListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Department" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "DepartmentProperties": { - "description": "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.", - "type": "object", - "properties": { - "costCenter": { - "description": "The cost center associated with the department.", - "type": "string" - }, - "displayName": { - "description": "The name of the department.", - "type": "string" - }, - "id": { - "description": "The ID that uniquely identifies the department.", - "type": "string", - "readOnly": true - }, - "status": { - "description": "The status of the department.", - "type": "string", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/enrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/enrollmentAccount.json deleted file mode 100644 index 5692cbccb889..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/enrollmentAccount.json +++ /dev/null @@ -1,352 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts/{enrollmentAccountName}": { - "get": { - "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/" - }, - "operationId": "EnrollmentAccounts_GetByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/EnrollmentAccount" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "EnrollmentAccountByDepartment": { - "$ref": "./examples/enrollmentAccountByDepartment.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts": { - "get": { - "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/" - }, - "operationId": "EnrollmentAccounts_ListByDepartment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/departmentName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/EnrollmentAccountListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/enrollmentAccounts/{enrollmentAccountName}": { - "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/" - }, - "operationId": "EnrollmentAccounts_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/enrollmentAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/EnrollmentAccount" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "get": { - "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/" - }, - "operationId": "EnrollmentAccounts_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/EnrollmentAccountListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "EnrollmentAccountsListByBillingAccount": { - "$ref": "./examples/enrollmentAccountsListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "EnrollmentAccount": { - "description": "It is an organizational hierarchy within a billing account to administer and manage azure costs.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/EnrollmentAccountProperties" - } - }, - "x-ms-azure-resource": true - }, - "EnrollmentAccountListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/EnrollmentAccount" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "EnrollmentAccountProperties": { - "description": "It is an organizational hierarchy within a billing account to administer and manage azure costs.", - "type": "object", - "properties": { - "costCenter": { - "description": "The cost center associated with the enrollment account.", - "type": "string" - }, - "displayName": { - "description": "The name of the enrollment account.", - "type": "string" - }, - "departmentDisplayName": { - "description": "The name of the department under which the enrollment account exists.", - "type": "string", - "readOnly": true - }, - "departmentId": { - "description": "The ID that uniquely identifies the department.", - "type": "string", - "readOnly": true - }, - "isDevTestEnabled": { - "description": "Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates.", - "type": "boolean" - }, - "accountOwner": { - "description": "The owner of the enrollment account.", - "type": "string", - "readOnly": true - }, - "authType": { - "description": "The authorization type of the enrollment account.", - "type": "string", - "readOnly": true - }, - "status": { - "description": "The status of the enrollment account.", - "type": "string", - "readOnly": true - }, - "startDate": { - "format": "date-time", - "description": "The date from which the enrollment account became valid and functional.", - "type": "string", - "readOnly": true - }, - "endDate": { - "format": "date-time", - "description": "The date of expiration of the enrollment account.", - "type": "string", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateInvalid.json index 00d4ffedb254..e7ef278e6e94 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateInvalid.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateInvalid.json @@ -32,5 +32,7 @@ "validationMessage": "Invalid address" } } - } + }, + "operationId": "Address_Validate", + "title": "AddressValidateInvalid" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateValid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateValid.json index e5151a2e24e1..da2e6693f5c7 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateValid.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/addressValidateValid.json @@ -15,5 +15,7 @@ "status": "Valid" } } - } + }, + "operationId": "Address_Validate", + "title": "AddressValidateValid" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementByName.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementByName.json index bdfd3e93dc2a..634d089914ef 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementByName.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementByName.json @@ -1,25 +1,27 @@ { "parameters": { + "agreementName": "ABC123", "api-version": "2024-04-01", - "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "agreementName": "ABC123" + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", "name": "ABC123", + "type": "Microsoft.Billing/billingAccounts/agreements", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", "properties": { "acceptanceMode": "ClickToAccept", "agreementLink": "https://contoso.com", "displayName": "Microsoft Customer Agreement", "effectiveDate": "2018-11-01T00:00:00Z", "expirationDate": "2019-11-01T00:00:00Z", - "status": "Active", - "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" - }, - "type": "Microsoft.Billing/billingAccounts/agreements" + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "status": "Active" + } } } - } + }, + "operationId": "Agreements_Get", + "title": "AgreementByName" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json index 283236bf49f7..d2a13522af78 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json @@ -9,14 +9,16 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", "name": "ABC123", + "type": "Microsoft.Billing/billingAccounts/agreements", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", "properties": { "acceptanceMode": "ClickToAccept", "agreementLink": "https://contoso.com", "displayName": "Microsoft Customer Agreement", "effectiveDate": "2018-11-01T00:00:00Z", "expirationDate": "2019-11-01T00:00:00Z", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "participants": [ { "email": "abc@contoso.com", @@ -29,20 +31,20 @@ "statusDate": "2018-11-02T00:00:00Z" } ], - "status": "Active", - "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" - }, - "type": "Microsoft.Billing/billingAccounts/agreements" + "status": "Active" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/DEF456", "name": "DEF456", + "type": "Microsoft.Billing/billingAccounts/agreements", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/DEF456", "properties": { "acceptanceMode": "ESignEmbedded", "agreementLink": "https://contoso.com", "displayName": "Microsoft Customer Agreement", "effectiveDate": "2018-12-05T00:00:00Z", "expirationDate": "2019-12-05T00:00:00Z", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "participants": [ { "email": "abc@contoso.com", @@ -50,13 +52,13 @@ "statusDate": "2018-12-05T00:00:00Z" } ], - "status": "PendingSignature", - "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" - }, - "type": "Microsoft.Billing/billingAccounts/agreements" + "status": "PendingSignature" + } } ] } } - } + }, + "operationId": "Agreements_ListByBillingAccount", + "title": "AgreementsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json index 7367b006742b..77355ee3d850 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json @@ -1,12 +1,12 @@ { "parameters": { "api-version": "2024-04-01", - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "associatedTenantName": "11111111-1111-1111-1111-111111111111", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "parameters": { "properties": { - "displayName": "Contoso Finance", "billingManagementState": "Active", + "displayName": "Contoso Finance", "provisioningManagementState": "Pending" } } @@ -14,31 +14,33 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "properties": { - "displayName": "Contoso Finance", - "tenantId": "11111111-1111-1111-1111-111111111111", "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", "provisioningManagementState": "Pending", - "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" - }, - "type": "Microsoft.Billing/billingAccounts/associatedTenants" + "tenantId": "11111111-1111-1111-1111-111111111111" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "properties": { - "displayName": "Contoso Finance", - "tenantId": "11111111-1111-1111-1111-111111111111", "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", "provisioningManagementState": "Pending", - "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" - }, - "type": "Microsoft.Billing/billingAccounts/associatedTenants" + "tenantId": "11111111-1111-1111-1111-111111111111" + } } } - } + }, + "operationId": "AssociatedTenants_CreateOrUpdate", + "title": "AssociatedTenantsCreateOrUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsDelete.json index 17946737cdb4..0caf8059815d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsDelete.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsDelete.json @@ -1,8 +1,8 @@ { "parameters": { "api-version": "2024-04-01", - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "associatedTenantName": "11111111-1111-1111-1111-111111111111" + "associatedTenantName": "11111111-1111-1111-1111-111111111111", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" }, "responses": { "202": { @@ -12,5 +12,7 @@ } }, "204": {} - } + }, + "operationId": "AssociatedTenants_Delete", + "title": "AssociatedTenantsDelete" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsGet.json index 704bd064d321..eec3701a77cc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsGet.json @@ -1,23 +1,25 @@ { "parameters": { "api-version": "2024-04-01", - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "associatedTenantName": "11111111-1111-1111-1111-111111111111" + "associatedTenantName": "11111111-1111-1111-1111-111111111111", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "properties": { - "displayName": "Contoso Finance", - "tenantId": "11111111-1111-1111-1111-111111111111", "billingManagementState": "Active", + "displayName": "Contoso Finance", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", "provisioningManagementState": "Pending", - "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" - }, - "type": "Microsoft.Billing/billingAccounts/associatedTenants" + "tenantId": "11111111-1111-1111-1111-111111111111" + } } } - } + }, + "operationId": "AssociatedTenants_Get", + "title": "AssociatedTenantsGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json index c2329496b2cc..d94046378673 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json @@ -8,30 +8,32 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", "properties": { - "displayName": "Contoso Finance", - "tenantId": "11111111-1111-1111-1111-111111111111", "billingManagementState": "Active", - "provisioningManagementState": "NotRequested" - }, - "type": "Microsoft.Billing/billingAccounts/associatedTenants" + "displayName": "Contoso Finance", + "provisioningManagementState": "NotRequested", + "tenantId": "11111111-1111-1111-1111-111111111111" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/associatedTenants", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/22222222-2222-2222-2222-222222222222", "properties": { - "displayName": "Contoso Engineering", - "tenantId": "22222222-2222-2222-2222-222222222222", "billingManagementState": "NotAllowed", + "displayName": "Contoso Engineering", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222", "provisioningManagementState": "Pending", - "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" - }, - "type": "Microsoft.Billing/billingAccounts/associatedTenants" + "tenantId": "22222222-2222-2222-2222-222222222222" + } } ] } } - } + }, + "operationId": "AssociatedTenants_ListByBillingAccount", + "title": "AssociatedTenantsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json index bc3b701d9fef..f16d10d918d5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json @@ -6,8 +6,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/availableBalance/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/availableBalance", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/availableBalance/default", "properties": { "amount": { "currency": "USD", @@ -19,11 +20,11 @@ "currency": "USD", "value": 50 }, - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Contoso Finance", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "date": "2024-04-01T00:00:00.0000000Z", "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "invoiceName": "G123456789", - "date": "2024-04-01T00:00:00.0000000Z", "paymentMethodType": "CheckWire" }, { @@ -31,11 +32,11 @@ "currency": "USD", "value": 150 }, - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", "billingProfileDisplayName": "Contoso Engineering", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", + "date": "2023-01-01T00:00:00.0000000Z", "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", "invoiceName": "G987654321", - "date": "2023-01-01T00:00:00.0000000Z", "paymentMethodType": "CheckWire" } ], @@ -43,9 +44,10 @@ "currency": "USD", "value": 200 } - }, - "type": "Microsoft.Billing/billingAccounts/availableBalance" + } } } - } + }, + "operationId": "AvailableBalances_GetByBillingAccount", + "title": "AvailableBalanceGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json index 0af31fd1abb7..04227bbcc084 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json @@ -7,8 +7,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/availableBalance/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/availableBalance/default", "properties": { "amount": { "currency": "USD", @@ -20,11 +21,11 @@ "currency": "USD", "value": 50 }, - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Contoso Finance", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "date": "2024-04-01T00:00:00.0000000Z", "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "invoiceName": "G123456789", - "date": "2024-04-01T00:00:00.0000000Z", "paymentMethodType": "CheckWire" } ], @@ -32,9 +33,10 @@ "currency": "USD", "value": 200 } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance" + } } } - } + }, + "operationId": "AvailableBalances_GetByBillingProfile", + "title": "AvailableBalanceGetByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json index f7e56656bc53..363eda9fa090 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json @@ -7,8 +7,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001", "name": "20000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001", "properties": { "accountStatus": "Active", "accountType": "Individual", @@ -16,11 +17,12 @@ "displayName": "Individual Account 2", "hasReadAccess": true, "notificationEmailAddress": "individual@domain.com" - }, - "type": "Microsoft.Billing/billingAccounts" + } } ] } } - } + }, + "operationId": "BillingAccounts_List", + "title": "BillingAccountForLegacyAccountDetails" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json index 7321a968cdde..abed245a968b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json @@ -13,27 +13,28 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/6575495", "name": "6575495", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6575495", "properties": { "accountStatus": "Active", - "accountType": "Enterprise", "accountSubType": "None", + "accountType": "Enterprise", "agreementType": "EnterpriseAgreement", "displayName": "Enterprise Account", "enrollmentDetails": { - "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z", - "currency": "USD", + "billingCycle": "Monthly", "channel": "EaDirect", - "language": "en", + "cloud": "Azure Commercial", "countryCode": "US", - "billingCycle": "Monthly", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", "extendedTermOption": "Opted-Out", - "supportLevel": "Standard", + "poNumber": "poNumber123", + "startDate": "2018-05-01T17:32:28Z", "supportCoverage": "1/26/2021 - 6/30/2021", - "cloud": "Azure Commercial", - "poNumber": "poNumber123" + "supportLevel": "Standard", + "language": "en" }, "hasReadAccess": true, "soldTo": { @@ -46,7 +47,6 @@ "region": "WA" } }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" @@ -59,5 +59,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingAccounts_Update", + "title": "BillingAccountUpdateWithPONumber" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json index a8a4eae01e60..6829bae6d8bc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json @@ -7,35 +7,37 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892", "name": "6564892", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892", "properties": { "accountStatus": "Active", "accountType": "Enterprise", "agreementType": "EnterpriseAgreement", "displayName": "Enterprise Account", "enrollmentDetails": { - "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z", - "currency": "USD", + "billingCycle": "Monthly", "channel": "EaDirect", - "language": "en", + "cloud": "Azure Commercial", "countryCode": "US", - "billingCycle": "Monthly", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", "extendedTermOption": "Opted-Out", - "supportLevel": "Standard", + "poNumber": "poNumber123", + "startDate": "2018-05-01T17:32:28Z", "supportCoverage": "1/26/2021 - 6/30/2021", - "cloud": "Azure Commercial", - "poNumber": "poNumber123" + "supportLevel": "Standard", + "language": "en" }, "hasReadAccess": true }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } } - } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountWithExpandForPONumber" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json index 86534b8a205f..679d8ceb4963 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json @@ -6,29 +6,31 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", "registrationNumber": { - "id": "RegistrationId", "type": [ "RegistrationNumber" - ] + ], + "id": "RegistrationId" } }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } } - } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountWithRegistrationNumberWithDefaultType" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json index 9b19667a2f93..c8c7440b53ac 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json @@ -6,30 +6,32 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", "registrationNumber": { - "id": "SomeRegistrationId", - "required": true, "type": [ "TIN" - ] + ], + "id": "SomeRegistrationId", + "required": true } }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } } - } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountWithRegistrationNumberWithType" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json index 90931c5366b0..589193cbed76 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json @@ -6,9 +6,11 @@ "responses": { "200": { "body": { - "transitionDate": "2021-05-17T00:00:00Z", - "anniversaryDay": 12 + "anniversaryDay": 12, + "transitionDate": "2021-05-17T00:00:00Z" } } - } + }, + "operationId": "BillingAccounts_ConfirmTransition", + "title": "BillingAccountsConfirmTransition" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGet.json index 0fc46a87e950..44ae0a07a639 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGet.json @@ -6,23 +6,25 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } } - } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountsGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetEA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetEA.json index 392b6b882046..0053a120b15d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetEA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetEA.json @@ -6,29 +6,30 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/6575495", "name": "6575495", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6575495", "properties": { "agreementType": "EnterpriseAgreement", "enrollmentDetails": { - "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z", - "currency": "USD", + "billingCycle": "Monthly", "channel": "EaDirect", - "language": "en", + "cloud": "Azure Commercial", "countryCode": "US", - "billingCycle": "Monthly", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", "extendedTermOption": "Opted-Out", - "supportLevel": "Standard", - "supportCoverage": "1/26/2021 - 6/30/2021", - "cloud": "Azure Commercial", - "markupStatus": "Published", "indirectRelationshipInfo": { "billingAccountName": "pcn.12345", "billingProfileName": "", "displayName": "Test partner" }, - "invoiceRecipient": "abc@contoso.com" + "invoiceRecipient": "abc@contoso.com", + "markupStatus": "Published", + "startDate": "2018-05-01T17:32:28Z", + "supportCoverage": "1/26/2021 - 6/30/2021", + "supportLevel": "Standard", + "language": "en" }, "soldTo": { "addressLine1": "Test Address", @@ -39,9 +40,10 @@ "postalCode": "00000", "region": "WA" } - }, - "type": "Microsoft.Billing/billingAccounts" + } } } - } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountsGetEA" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json index 7c101eff04f6..c3f02eb9ce12 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json @@ -7,12 +7,13 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, @@ -22,17 +23,18 @@ "city": "Redmond", "companyName": "Contoso", "country": "US", + "isValidAddress": true, "postalCode": "98052-8300", - "region": "WA", - "isValidAddress": true + "region": "WA" } }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } } - } + }, + "operationId": "BillingAccounts_Get", + "title": "BillingAccountsGetWithExpand" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsList.json index 02fe22b4756a..5c557c38a296 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsList.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsList.json @@ -7,72 +7,72 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Professional", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Standard Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Individual", "accountSubType": "Individual", + "accountType": "Individual", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Individual Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftPartnerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" @@ -81,5 +81,7 @@ ] } } - } + }, + "operationId": "BillingAccounts_List", + "title": "BillingAccountsList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json index 0174a6199e51..7b8418240286 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json @@ -8,27 +8,28 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892", "name": "6564892", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892", "properties": { "accountStatus": "Active", - "accountType": "Enterprise", "accountSubType": "None", + "accountType": "Enterprise", "agreementType": "EnterpriseAgreement", "displayName": "Enterprise Account", "enrollmentDetails": { - "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z", - "currency": "USD", + "billingCycle": "Monthly", "channel": "EaDirect", - "language": "en", + "cloud": "Azure Commercial", "countryCode": "US", - "billingCycle": "Monthly", + "currency": "USD", + "endDate": "2019-05-31T17:32:28Z", "extendedTermOption": "Opted-Out", - "supportLevel": "Standard", + "poNumber": "poNumber123", + "startDate": "2018-05-01T17:32:28Z", "supportCoverage": "1/26/2021 - 6/30/2021", - "cloud": "Azure Commercial", - "poNumber": "poNumber123" + "supportLevel": "Standard", + "language": "en" }, "hasReadAccess": true, "soldTo": { @@ -40,7 +41,6 @@ "region": "WA" } }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" @@ -49,5 +49,7 @@ ] } } - } + }, + "operationId": "BillingAccounts_List", + "title": "BillingAccountsListWithExpandForPONumber" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsUpdate.json index 5ca422dc07fc..3b11aaee462c 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingAccountsUpdate.json @@ -19,12 +19,13 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, @@ -34,12 +35,11 @@ "city": "Redmond", "companyName": "Contoso", "country": "US", + "isValidAddress": true, "postalCode": "98052-8300", - "region": "WA", - "isValidAddress": true + "region": "WA" } }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" @@ -52,5 +52,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingAccounts_Update", + "title": "BillingAccountsUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json index 3519809beda0..5c69c6e6bfaa 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json @@ -35,5 +35,7 @@ ] } } - } + }, + "operationId": "BillingPermissions_ListByBillingAccount", + "title": "BillingPermissionsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json index 30679725582c..d7c745a68c36 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json @@ -36,5 +36,7 @@ ] } } - } + }, + "operationId": "BillingPermissions_ListByBillingProfile", + "title": "BillingPermissionsListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json index fb764cafa323..368bd46ba4b1 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json @@ -24,5 +24,7 @@ ] } } - } + }, + "operationId": "BillingPermissions_ListByCustomer", + "title": "BillingPermissionsListByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json index e95cf4b397d2..e390590b522f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json @@ -23,5 +23,7 @@ ] } } - } + }, + "operationId": "BillingPermissions_ListByCustomerAtBillingAccount", + "title": "BillingPermissionsListByCustomerAtBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json index 2b7fd0d80bdb..7e42ef99ef37 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json @@ -22,5 +22,7 @@ ] } } - } + }, + "operationId": "BillingPermissions_ListByDepartment", + "title": "BillingPermissionsListByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json index c694c3a90d9a..dd0dfb70b39f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json @@ -20,5 +20,7 @@ ] } } - } + }, + "operationId": "BillingPermissions_ListByEnrollmentAccount", + "title": "BillingPermissionsListByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json index 6ef4355259fc..128ccccc415a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json @@ -24,5 +24,7 @@ ] } } - } + }, + "operationId": "BillingPermissions_ListByInvoiceSection", + "title": "BillingPermissionsListByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json index 9b1233afe9d0..14075970fb83 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json @@ -14,11 +14,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "displayName": "Billing Profile 1", "enabledAzurePlans": [ @@ -40,11 +40,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" } } } @@ -52,8 +52,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "properties": { "billTo": { "addressLine1": "Test Address1", @@ -64,11 +65,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "currency": "USD", "displayName": "Billing Profile 1", @@ -85,22 +86,22 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "status": "Active", "systemId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "properties": { "billTo": { "addressLine1": "Test Address1", @@ -111,11 +112,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "currency": "USD", "displayName": "Billing Profile 1", @@ -132,16 +133,15 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "status": "Active", "systemId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } } }, "202": { @@ -150,5 +150,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingProfiles_CreateOrUpdate", + "title": "BillingProfilesCreateOrUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesDelete.json index 5dc408f1b7ce..a2657ce2cd09 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesDelete.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesDelete.json @@ -4,6 +4,7 @@ "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "xxxx-xxxx-xxx-xxx", "parameters": { + "type": "Microsoft.Billing/billingAccounts/billingProfiles", "properties": { "billTo": { "addressLine1": "Test Address1", @@ -14,11 +15,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "displayName": "Billing Profile 1", "enabledAzurePlans": [ @@ -40,14 +41,13 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } } }, "responses": { @@ -58,5 +58,7 @@ } }, "204": {} - } + }, + "operationId": "BillingProfiles_Delete", + "title": "BillingProfilesDelete" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesGet.json index 9bd3c1489818..7f7191630eec 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesGet.json @@ -7,8 +7,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "properties": { "billTo": { "addressLine1": "Test Address1", @@ -19,11 +20,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "currency": "USD", "displayName": "Billing Profile 1", @@ -44,11 +45,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "soldTo": { "addressLine1": "Test Address1", @@ -59,29 +60,30 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "spendingLimit": "On", "spendingLimitDetails": [ { + "type": "FreeAccount", "amount": 200, "currency": "USD", - "startDate": "2018-01-01T00:00:00.0000000Z", "endDate": "2019-01-01T00:00:00.0000000Z", - "type": "FreeAccount", + "startDate": "2018-01-01T00:00:00.0000000Z", "status": "Active" } ], "status": "Warned", "statusReasonCode": "PastDue", "systemId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } } } - } + }, + "operationId": "BillingProfiles_Get", + "title": "BillingProfilesGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json index 670323da178e..9bcd40e1d098 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json @@ -8,8 +8,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "name": "xxxx-xxxx-xxx-xxx", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "properties": { "billTo": { "addressLine1": "Test Address1", @@ -20,11 +21,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "currency": "USD", "displayName": "Billing Profile 1", @@ -45,11 +46,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "soldTo": { "addressLine1": "Test Address1", @@ -60,32 +61,32 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "spendingLimit": "On", "spendingLimitDetails": [ { + "type": "FreeAccount", "amount": 200, "currency": "USD", - "startDate": "2018-01-01T00:00:00.0000000Z", "endDate": "2019-01-01T00:00:00.0000000Z", - "type": "FreeAccount", + "startDate": "2018-01-01T00:00:00.0000000Z", "status": "Active" } ], "status": "Warned", "statusReasonCode": "PastDue", "systemId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", "name": "yyyy-yyyy-yyy-yyy", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", "properties": { "billTo": { "addressLine1": "Test Address1", @@ -96,11 +97,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "currency": "USD", "displayName": "Billing Profile 2", @@ -121,11 +122,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "soldTo": { "addressLine1": "Test Address1", @@ -136,21 +137,21 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "status": "UnderReview", "statusReasonCode": "UnusualActivity", "systemId": "22222222-2222-2222-2222-222222222222" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/zzzz-zzzz-zzz-zzz", "name": "zzzz-zzzz-zzz-zzz", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/zzzz-zzzz-zzz-zzz", "properties": { "billTo": { "addressLine1": "Test Address1", @@ -161,11 +162,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "currency": "USD", "displayName": "Billing Profile 1", @@ -186,11 +187,11 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "soldTo": { "addressLine1": "Test Address1", @@ -201,19 +202,20 @@ "country": "US", "email": "abc@contoso.com", "firstName": "Test", + "isValidAddress": true, "lastName": "User", "phoneNumber": "000-000-0000", "postalCode": "00000", - "region": "WA", - "isValidAddress": true + "region": "WA" }, "status": "Active", "systemId": "33333333-3333-3333-3333-333333333333" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } } ] } } - } + }, + "operationId": "BillingProfiles_ListByBillingAccount", + "title": "BillingProfilesListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json index f4cb52ebad28..b9658bba3b6e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json @@ -7,7 +7,6 @@ "responses": { "200": { "body": { - "eligibilityStatus": "NotAllowed", "eligibilityDetails": [ { "code": "ActiveBillingSubscriptions", @@ -29,8 +28,11 @@ "code": "ReservedInstances", "message": "Billing Profile cannot be deleted as there are reserved assets with a billing plan." } - ] + ], + "eligibilityStatus": "NotAllowed" } } - } + }, + "operationId": "BillingProfiles_ValidateDeleteEligibility", + "title": "BillingProfilesValidateDeleteEligibilityFailure" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json index 540e412efe3a..fd2b2248fc72 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json @@ -8,5 +8,7 @@ "200": { "body": {} } - } + }, + "operationId": "BillingProfiles_ValidateDeleteEligibility", + "title": "BillingProfilesValidateDeleteEligibilitySuccess" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json index d5816237b19a..c54d888cd8ec 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json @@ -6,8 +6,9 @@ "responses": { "200": { "body": { - "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "properties": { "billingAccountAgreementType": "MicrosoftCustomerAgreement", "billingAccountDisplayName": "My Account", @@ -32,9 +33,10 @@ ], "subscriptionBillingType": "Free", "subscriptionWorkloadType": "Production" - }, - "type": "Microsoft.Billing/billingProperty" + } } } - } + }, + "operationId": "BillingProperty_Get", + "title": "BillingPropertyGetMCA" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json index f0b6b65b9964..ba4bfd540a54 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json @@ -6,8 +6,9 @@ "responses": { "200": { "body": { - "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "properties": { "billingAccountAgreementType": "MicrosoftOnlineServicesProgram", "billingAccountDisplayName": "My Account", @@ -27,9 +28,10 @@ "region": "State" }, "subscriptionWorkloadType": "Production" - }, - "type": "Microsoft.Billing/billingProperty" + } } } - } + }, + "operationId": "BillingProperty_Get", + "title": "BillingPropertyGetMOSP" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json index 62788e6d64ae..211fb2f6b054 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json @@ -6,8 +6,9 @@ "responses": { "200": { "body": { - "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "properties": { "billingAccountAgreementType": "MicrosoftCustomerAgreement", "billingAccountDisplayName": "My Account", @@ -32,9 +33,10 @@ ], "subscriptionBillingType": "Free", "subscriptionWorkloadType": "Production" - }, - "type": "Microsoft.Billing/billingProperty" + } } } - } + }, + "operationId": "BillingProperty_Get", + "title": "BillingPropertyGetMPA" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json index 6a4dbba742cf..9a2e6633691f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json @@ -1,18 +1,19 @@ { "parameters": { "api-version": "2024-04-01", - "subscriptionId": "11111111-1111-1111-1111-111111111111", "parameters": { "properties": { "costCenter": "1010" } - } + }, + "subscriptionId": "11111111-1111-1111-1111-111111111111" }, "responses": { "200": { "body": { - "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "properties": { "billingAccountAgreementType": "MicrosoftCustomerAgreement", "billingAccountDisplayName": "My Account", @@ -37,9 +38,10 @@ ], "subscriptionBillingType": "Free", "subscriptionWorkloadType": "Production" - }, - "type": "Microsoft.Billing/billingProperty" + } } } - } + }, + "operationId": "BillingProperty_Update", + "title": "BillingPropertyPatchCostCenter" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json index 4dfbd8a24af2..5453ef57bddc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json @@ -1,7 +1,6 @@ { "parameters": { "api-version": "2024-04-01", - "subscriptionId": "11111111-1111-1111-1111-111111111111", "parameters": { "properties": { "subscriptionServiceUsageAddress": { @@ -16,13 +15,15 @@ "region": "State" } } - } + }, + "subscriptionId": "11111111-1111-1111-1111-111111111111" }, "responses": { "200": { "body": { - "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "name": "default", + "type": "Microsoft.Billing/billingProperty", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", "properties": { "billingAccountAgreementType": "MicrosoftOnlineServicesProgram", "billingAccountDisplayName": "My Account", @@ -42,9 +43,10 @@ "region": "State" }, "subscriptionWorkloadType": "Production" - }, - "type": "Microsoft.Billing/billingProperty" + } } } - } + }, + "operationId": "BillingProperty_Update", + "title": "BillingPropertyPatchSubscriptionServiceUsageAddress" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json index 5d1d27f726e5..d59eb799f4ba 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json @@ -4,76 +4,78 @@ "billingRequestName": "00000000-0000-0000-0000-000000000000", "parameters": { "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" }, "decisionReason": "New team member", "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "status": "Pending", - "type": "RoleAssignment" + "status": "Pending" } } }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", "expirationDate": "2023-04-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "status": "Pending", - "type": "RoleAssignment", "lastUpdatedBy": { "upn": "admin@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", "expirationDate": "2023-04-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "status": "Pending", - "type": "RoleAssignment", "lastUpdatedBy": { "upn": "admin@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } } } - } + }, + "operationId": "BillingRequests_CreateOrUpdate", + "title": "BillingRequestsCreateOrUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsGet.json index 21f587dd6555..fc638c688267 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsGet.json @@ -6,33 +6,35 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", "expirationDate": "2023-04-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "status": "Pending", - "type": "RoleAssignment", "lastUpdatedBy": { "upn": "admin@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } } } - } + }, + "operationId": "BillingRequests_Get", + "title": "BillingRequestsGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json index 41fb8f24fb7e..785da9e08144 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json @@ -8,61 +8,63 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", "expirationDate": "2023-04-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "status": "Pending", - "type": "RoleAssignment", "lastUpdatedBy": { "upn": "foo@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } }, { - "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", "properties": { - "reviewedBy": { - "upn": "admin@contosofinance.com" - }, - "reviewalDate": "2023-03-02T17:32:28Z", + "type": "ProvisioningAccess", + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2023-03-01T17:32:28Z", "expirationDate": "2023-03-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", - "status": "Approved", - "type": "ProvisioningAccess", "lastUpdatedBy": { "upn": "admin@contosofinance.com" }, - "lastUpdatedDate": "2023-03-02T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2023-03-02T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "reviewalDate": "2023-03-02T17:32:28Z", + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "status": "Approved" + } } ] } } - } + }, + "operationId": "BillingRequests_ListByBillingAccount", + "title": "BillingRequestsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json index 0976b2f22ccb..7414713f063b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json @@ -9,35 +9,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", "expirationDate": "2023-04-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "status": "Pending", - "type": "RoleAssignment", "lastUpdatedBy": { "upn": "foo@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } } ] } } - } + }, + "operationId": "BillingRequests_ListByBillingProfile", + "title": "BillingRequestsListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json index 1f54cb48019b..e5f63dcd6f13 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json @@ -10,38 +10,40 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "30000000-aaaa-bbbb-cccc-200000000003" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", - "expirationDate": "2023-04-15T17:32:28Z", + "customerDisplayName": "Customer 1", "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "customerName": "11111111-1111-1111-1111-111111111111", - "customerDisplayName": "Customer 1", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", - "status": "Pending", - "type": "RoleAssignment", + "expirationDate": "2023-04-15T17:32:28Z", "lastUpdatedBy": { "upn": "foo@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "status": "Pending" + } } ] } } - } + }, + "operationId": "BillingRequests_ListByCustomer", + "title": "BillingRequestsListByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json index 1c60059b5fb2..7d224505bdd9 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json @@ -10,38 +10,40 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "30000000-aaaa-bbbb-cccc-200000000003" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", "expirationDate": "2023-04-15T17:32:28Z", + "invoiceSectionDisplayName": "Department 1", "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", - "invoiceSectionDisplayName": "Department 1", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", - "status": "Pending", - "type": "RoleAssignment", "lastUpdatedBy": { "upn": "foo@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "status": "Pending" + } } ] } } - } + }, + "operationId": "BillingRequests_ListByInvoiceSection", + "title": "BillingRequestsListByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUser.json index 3881eb5c7aeb..acbd021f540c 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUser.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUser.json @@ -7,61 +7,63 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", "properties": { + "type": "RoleAssignment", "additionalInformation": { "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" }, + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", + "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "billingProfileDisplayName": "Contoso Operations Billing", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2024-04-01T17:32:28Z", "expirationDate": "2023-04-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "status": "Pending", - "type": "RoleAssignment", "lastUpdatedBy": { "upn": "foo@contoso.com" }, - "lastUpdatedDate": "2024-04-01T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2024-04-01T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending" + } }, { - "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", "properties": { - "reviewedBy": { - "upn": "admin@contosofinance.com" - }, - "reviewalDate": "2023-03-02T17:32:28Z", + "type": "ProvisioningAccess", + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2023-03-01T17:32:28Z", "expirationDate": "2023-03-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", - "status": "Approved", - "type": "ProvisioningAccess", "lastUpdatedBy": { "upn": "admin@contosofinance.com" }, - "lastUpdatedDate": "2023-03-02T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2023-03-02T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "reviewalDate": "2023-03-02T17:32:28Z", + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "status": "Approved" + } } ] } } - } + }, + "operationId": "BillingRequests_ListByUser", + "title": "BillingRequestsListByUser" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json index 7bb6a51fd268..da2f67cf1c14 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json @@ -8,33 +8,35 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingRequests", + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", "properties": { - "reviewedBy": { - "upn": "admin@contosofinance.com" - }, - "reviewalDate": "2023-03-02T17:32:28Z", + "type": "ProvisioningAccess", + "billingAccountDisplayName": "Contoso", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingAccountDisplayName": "Contoso", "createdBy": { "upn": "foo@contoso.com" }, "creationDate": "2023-03-01T17:32:28Z", "expirationDate": "2023-03-15T17:32:28Z", - "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", - "status": "Approved", - "type": "ProvisioningAccess", "lastUpdatedBy": { "upn": "admin@contosofinance.com" }, - "lastUpdatedDate": "2023-03-02T17:32:28Z" - }, - "type": "Microsoft.Billing/billingRequests" + "lastUpdatedDate": "2023-03-02T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "reviewalDate": "2023-03-02T17:32:28Z", + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "status": "Approved" + } } ] } } - } + }, + "operationId": "BillingRequests_ListByUser", + "title": "BillingRequestsListByUserWithFilter" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json index 9a8c4ab25f2c..12e95b00e115 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json @@ -12,18 +12,18 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } } }, "202": { @@ -32,5 +32,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_CreateByBillingAccount", + "title": "BillingRoleAssignmentCreateByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json index cb154faddd73..e272e274e136 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json @@ -13,18 +13,18 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB" + } } }, "202": { @@ -33,5 +33,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_CreateByBillingProfile", + "title": "BillingRoleAssignmentCreateByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json index 29a38b1ba244..a4ae6ef9bfc7 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json @@ -14,18 +14,18 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "name": "30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } } }, "202": { @@ -34,5 +34,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_CreateByCustomer", + "title": "BillingRoleAssignmentCreateByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json index 0b2033585f15..245068fbdf6d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json @@ -14,18 +14,18 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } } }, "202": { @@ -34,5 +34,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_CreateByInvoiceSection", + "title": "BillingRoleAssignmentCreateByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json index 9071b35ccbd5..30f2e0c68858 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json @@ -15,35 +15,37 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } } } - } + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByBillingAccount", + "title": "BillingRoleAssignmentCreateOrUpdateByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json index 170eb67e3a3b..f24547311692 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json @@ -2,8 +2,8 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "7898901", - "departmentName": "12345", "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "departmentName": "12345", "parameters": { "properties": { "principalId": "00000000-0000-0000-0000-000000000000", @@ -16,35 +16,37 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + } } } - } + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByDepartment", + "title": "BillingRoleAssignmentCreateOrUpdateByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json index 16ff9d7c3875..e47226615718 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json @@ -2,8 +2,8 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "7898901", - "enrollmentAccountName": "123456", "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "enrollmentAccountName": "123456", "parameters": { "properties": { "principalId": "00000000-0000-0000-0000-000000000000", @@ -16,35 +16,37 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } } } - } + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount", + "title": "BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json index 1196d51833d1..de655b738660 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json @@ -7,5 +7,7 @@ "responses": { "200": {}, "204": {} - } + }, + "operationId": "BillingRoleAssignments_DeleteByBillingAccount", + "title": "BillingRoleAssignmentDeleteByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json index de71acb39b6a..9b141013c74b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json @@ -8,5 +8,7 @@ "responses": { "200": {}, "204": {} - } + }, + "operationId": "BillingRoleAssignments_DeleteByBillingProfile", + "title": "BillingRoleAssignmentDeleteByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json index bddb5aaefb63..626bc9d5db00 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json @@ -3,11 +3,13 @@ "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "billingProfileName": "BKM6-54VH-BG7-PGB", - "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", - "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000" + "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "BillingRoleAssignments_DeleteByCustomer", + "title": "BillingRoleAssignmentDeleteByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json index ea93fc05db97..b771d19580ca 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json @@ -2,11 +2,13 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "8608480", - "departmentName": "123456", - "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "departmentName": "123456" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "BillingRoleAssignments_DeleteByDepartment", + "title": "BillingRoleAssignmentDeleteByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json index 636fc3676094..e256ae84433e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json @@ -2,11 +2,13 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "8608480", - "enrollmentAccountName": "123456", - "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "enrollmentAccountName": "123456" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "BillingRoleAssignments_DeleteByEnrollmentAccount", + "title": "BillingRoleAssignmentDeleteByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json index 5e0e44a84c39..709412c42cb7 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json @@ -3,11 +3,13 @@ "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "billingProfileName": "BKM6-54VH-BG7-PGB", - "invoiceSectionName": "xxxx-xxxx-xxx-xxx", - "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", + "title": "BillingRoleAssignmentDeleteByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json index 7118380548ea..5560de0ec3fa 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json @@ -7,19 +7,21 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-01-04T22:39:34.2606750Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-01-04T22:39:34.2606750Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } } } - } + }, + "operationId": "BillingRoleAssignments_GetByBillingAccount", + "title": "BillingRoleAssignmentGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json index b7f629fcf219..8b14b12303fa 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json @@ -8,19 +8,21 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-01-04T22:39:34.2606750Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-01-04T22:39:34.2606750Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } } } - } + }, + "operationId": "BillingRoleAssignments_GetByBillingProfile", + "title": "BillingRoleAssignmentGetByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json index 2ef6468dab0f..dcd3ab45b48a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json @@ -3,25 +3,27 @@ "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", - "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-01-04T22:39:34.2606750Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-01-04T22:39:34.2606750Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } } } - } + }, + "operationId": "BillingRoleAssignments_GetByCustomer", + "title": "BillingRoleAssignmentGetByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json index 5b9c2cbe3505..30f05c09d9cd 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json @@ -2,24 +2,26 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "7898901", - "departmentName": "225314", - "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "departmentName": "225314" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "createdOn": "2023-10-19T20:10:50.1028398Z", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314", "userAuthenticationType": "Organization", "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + } } } - } + }, + "operationId": "BillingRoleAssignments_GetByDepartment", + "title": "BillingRoleAssignmentGetByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json index 77fa64ec2eac..15a43992978a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json @@ -2,24 +2,26 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "7898901", - "enrollmentAccountName": "225314", - "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "enrollmentAccountName": "225314" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "createdOn": "2023-10-19T20:10:50.1028398Z", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314", "userAuthenticationType": "Organization", "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } } } - } + }, + "operationId": "BillingRoleAssignments_GetByEnrollmentAccount", + "title": "BillingRoleAssignmentGetByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json index 8aca100e4965..d15ccb8bd3a3 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json @@ -3,25 +3,27 @@ "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "billingProfileName": "BKM6-54VH-BG7-PGB", - "invoiceSectionName": "xxxx-xxxx-xxx-xxx", - "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } } } - } + }, + "operationId": "BillingRoleAssignments_GetByInvoiceSection", + "title": "BillingRoleAssignmentGetByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json index 9d6a9a865dc4..765dc0a1dfd3 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json @@ -8,35 +8,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } } ] } } - } + }, + "operationId": "BillingRoleAssignments_ListByBillingAccount", + "title": "BillingRoleAssignmentListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json index 59e87272e0d2..746e1c108f10 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json @@ -9,35 +9,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } } ] } } - } + }, + "operationId": "BillingRoleAssignments_ListByBillingProfile", + "title": "BillingRoleAssignmentListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json index 3dd9bdfd2c60..a3be8a6d7b07 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json @@ -10,35 +10,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d" + } } ] } } - } + }, + "operationId": "BillingRoleAssignments_ListByCustomer", + "title": "BillingRoleAssignmentListByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json index 2b11ec60bfaf..2368d97efc54 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json @@ -9,35 +9,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "\"/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345" + } } ] } } - } + }, + "operationId": "BillingRoleAssignments_ListByDepartment", + "title": "BillingRoleAssignmentListByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json index da059bfb8625..d8e8dab6dd2d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json @@ -9,35 +9,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000001", - "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456" + } } ] } } - } + }, + "operationId": "BillingRoleAssignments_ListByEnrollmentAccount", + "title": "BillingRoleAssignmentListByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json index 8946b833b4fc..340645fd67f0 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json @@ -10,35 +10,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } } ] } } - } + }, + "operationId": "BillingRoleAssignments_ListByInvoiceSection", + "title": "BillingRoleAssignmentListByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json index 803b14359713..6578abeabf51 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json @@ -7,8 +7,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "properties": { "permissions": [ { @@ -60,9 +61,10 @@ } ], "roleName": "Billing account owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } } } - } + }, + "operationId": "BillingRoleDefinition_GetByBillingAccount", + "title": "BillingRoleDefinitionGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json index b8e1eb08b3ba..d3d1cbf773c7 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json @@ -8,8 +8,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", "name": "40000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", "properties": { "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", "permissions": [ @@ -31,9 +32,10 @@ } ], "roleName": "Billing profile owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } } } - } + }, + "operationId": "BillingRoleDefinition_GetByBillingProfile", + "title": "BillingRoleDefinitionGetByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json index 6ae32186004a..71baf0c57416 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json @@ -9,8 +9,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "properties": { "description": "The Owner role gives the user all permissions including access management rights to the customer.", "permissions": [ @@ -38,9 +39,10 @@ } ], "roleName": "Customer owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + } } } - } + }, + "operationId": "BillingRoleDefinition_GetByCustomer", + "title": "BillingRoleDefinitionGetByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json index 6ed579f03f56..6f2ac4d06fef 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json @@ -8,8 +8,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "properties": { "permissions": [ { @@ -26,9 +27,10 @@ } ], "roleName": "Department Admin" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + } } } - } + }, + "operationId": "BillingRoleDefinition_GetByDepartment", + "title": "BillingRoleDefinitionGetByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json index e02092937c61..05c5fbe0b334 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json @@ -8,8 +8,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "properties": { "permissions": [ { @@ -25,9 +26,10 @@ } ], "roleName": "Account Owner" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions" + } } } - } + }, + "operationId": "BillingRoleDefinition_GetByEnrollmentAccount", + "title": "BillingRoleDefinitionGetByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json index e0f495cee1f9..bcc4adc28448 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json @@ -9,8 +9,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "properties": { "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", "permissions": [ @@ -37,9 +38,10 @@ } ], "roleName": "Invoice section owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } } } - } + }, + "operationId": "BillingRoleDefinition_GetByInvoiceSection", + "title": "BillingRoleDefinitionGetByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json index e4a4e49d4ccb..c52232927b50 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json @@ -8,8 +8,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "properties": { "permissions": [ { @@ -61,12 +62,12 @@ } ], "roleName": "Billing account owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", "name": "50000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", "properties": { "description": "The Contributor role gives the user all permissions except access management on the organization.", "permissions": [ @@ -116,12 +117,12 @@ } ], "roleName": "Billing account contributor" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", "name": "50000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", "properties": { "description": "The Reader role gives the user read permissions to an organization.", "permissions": [ @@ -146,12 +147,12 @@ } ], "roleName": "Billing account reader" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", "name": "50000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", "properties": { "description": "The Reader role gives the user read permissions to an organization.", "permissions": [ @@ -176,12 +177,12 @@ } ], "roleName": "Billing account reader" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000003", "name": "50000000-aaaa-bbbb-cccc-100000000003", + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000003", "properties": { "description": "The Purchaser role gives the user permissions to make purchases by creating new Projects and Billing Groups in an organization.", "permissions": [ @@ -195,11 +196,12 @@ } ], "roleName": "Basic Purchaser" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } } ] } } - } + }, + "operationId": "BillingRoleDefinition_ListByBillingAccount", + "title": "BillingRoleDefinitionListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json index 9bc8534a7287..0e4403179310 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json @@ -9,8 +9,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", "name": "40000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", "properties": { "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", "permissions": [ @@ -32,12 +33,12 @@ } ], "roleName": "Billing profile owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000001", "name": "40000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000001", "properties": { "description": "The Contributor role gives the user all permissions except access management rights to the billing profile.", "permissions": [ @@ -58,12 +59,12 @@ } ], "roleName": "Billing profile contributor" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000002", "name": "40000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000002", "properties": { "description": "The Reader role gives the user read only access to the billing profile.", "permissions": [ @@ -77,12 +78,12 @@ } ], "roleName": "Billing profile reader" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000004", "name": "40000000-aaaa-bbbb-cccc-100000000004", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000004", "properties": { "description": "The Invoice Manager role gives the user the ability to view and manage invoices.", "permissions": [ @@ -98,11 +99,12 @@ } ], "roleName": "Invoice manager" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } } ] } } - } + }, + "operationId": "BillingRoleDefinition_ListByBillingProfile", + "title": "BillingRoleDefinitionListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json index 22eb385cd955..fa11c8b1bcbf 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json @@ -10,8 +10,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "properties": { "description": "The Owner role gives the user all permissions including access management rights to the customer.", "permissions": [ @@ -39,12 +40,12 @@ } ], "roleName": "Customer owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", "name": "30000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", "properties": { "description": "The Contributor role gives the user all permissions except access management rights to the customer.", "permissions": [ @@ -71,12 +72,12 @@ } ], "roleName": "Customer contributor" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", "name": "30000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", "properties": { "description": "The reader role gives the user read only access to the customer.", "permissions": [ @@ -92,11 +93,12 @@ } ], "roleName": "Customer reader" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + } } ] } } - } + }, + "operationId": "BillingRoleDefinition_ListByCustomer", + "title": "BillingRoleDefinitionListByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json index 94d302ecf033..a3f184742bc2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json @@ -9,8 +9,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "name": "50000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", "properties": { "permissions": [ { @@ -28,12 +29,12 @@ } ], "roleName": "Department Admin" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", "name": "50000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", "properties": { "permissions": [ { @@ -45,11 +46,12 @@ } ], "roleName": "Department Reader" - }, - "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + } } ] } } - } + }, + "operationId": "BillingRoleDefinition_ListByDepartment", + "title": "BillingRoleDefinitionListByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json index 6bc509e9defc..a7ee816a6ed5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json @@ -9,8 +9,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "properties": { "description": "The account owner role gives the user all permissions including access management rights to an accounts.", "permissions": [ @@ -28,11 +29,12 @@ } ], "roleName": "Account Owner" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions" + } } ] } } - } + }, + "operationId": "BillingRoleDefinition_ListByEnrollmentAccount", + "title": "BillingRoleDefinitionListByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json index 5ab131564f76..3da00b6dbadc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json @@ -10,8 +10,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "name": "30000000-aaaa-bbbb-cccc-100000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "properties": { "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", "permissions": [ @@ -38,12 +39,12 @@ } ], "roleName": "Invoice section owner" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", "name": "30000000-aaaa-bbbb-cccc-100000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", "properties": { "description": "The Contributor role gives the user all permissions except access management rights to the invoice section.", "permissions": [ @@ -69,12 +70,12 @@ } ], "roleName": "Invoice section contributor" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", "name": "30000000-aaaa-bbbb-cccc-100000000002", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", "properties": { "description": "The reader role gives the user read only access to the invoice section.", "permissions": [ @@ -89,12 +90,12 @@ } ], "roleName": "Invoice section reader" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000006", "name": "30000000-aaaa-bbbb-cccc-100000000006", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions", + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000006", "properties": { "description": "The Azure subscription creator role gives the user the ability to create an Azure subscription for the invoice section.", "permissions": [ @@ -106,11 +107,12 @@ } ], "roleName": "Azure subscription creator" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } } ] } } - } + }, + "operationId": "BillingRoleDefinition_ListByInvoiceSection", + "title": "BillingRoleDefinitionListByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json index 157ea2b16c06..35284f88847c 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json @@ -1,8 +1,8 @@ { "parameters": { + "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc", "parameters": { "properties": { "billingFrequency": "P1M", @@ -16,34 +16,34 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", "properties": { - "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "displayName": "Billing Subscription Display Name", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" @@ -52,34 +52,34 @@ }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", "properties": { - "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "displayName": "Billing Subscription Display Name", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" @@ -92,5 +92,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingSubscriptionsAliases_CreateOrUpdate", + "title": "BillingSubscriptionAliasCreateOrUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json index b5e4519c85be..3acbf0408d4b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json @@ -1,45 +1,47 @@ { "parameters": { + "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc", "api-version": "2024-04-01", - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc" + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", "properties": { - "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "displayName": "Billing Subscription Display Name", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" } } } - } + }, + "operationId": "BillingSubscriptionsAliases_Get", + "title": "BillingSubscriptionAliasGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json index 82cb718d5786..972130b55ef2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json @@ -8,114 +8,114 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000000", "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000000", "properties": { - "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", "displayName": "My subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-04T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/11111111-1111-1111-1111-111111111111", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, - "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/11111111-1111-1111-1111-111111111111", "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000001", "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000001", "properties": { - "billingSubscriptionId": "22222222-2222-2222-2222-222222222222", "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "22222222-2222-2222-2222-222222222222", "displayName": "Test subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "Software", "productType": "Software Product Type", "productTypeId": "EFG456", "purchaseDate": "2023-01-06T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/22222222-2222-2222-2222-222222222222", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, - "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/22222222-2222-2222-2222-222222222222", "termDuration": "P1M", - "termStartDate": "2023-01-07T22:39:34.2606750Z", "termEndDate": "2023-02-07T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-07T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", "systemData": { "createdAt": "2023-01-06T22:39:34.2606750Z", "lastModifiedAt": "2023-01-07T22:39:34.2606750Z" } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000002", "name": "90000000-0000-0000-0000-000000000002", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000002", "properties": { - "billingSubscriptionId": "33333333-3333-3333-3333-333333333333", "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingSubscriptionId": "33333333-3333-3333-3333-333333333333", "displayName": "Dev subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "ReservationOrder", "productType": "Reservation Product Type", "productTypeId": "JKL789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", - "skuDescription": "SKU Description", - "systemOverrides": { - "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" - }, "resourceUri": "/providers/Microsoft.Capacity/reservationOrders/33333333-3333-3333-3333-333333333333", - "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", - "termEndDate": "2023-02-05T22:39:34.2606750Z", + "skuDescription": "SKU Description", + "skuId": "0001", "status": "Suspended", - "suspensionReasons": [ - "Cancelled" - ], "suspensionReasonDetails": [ { "effectiveDate": "2023-01-15T22:39:34.2606750Z", "reason": "Cancelled" } - ] + ], + "suspensionReasons": [ + "Cancelled" + ], + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" @@ -124,5 +124,7 @@ ] } } - } + }, + "operationId": "BillingSubscriptionsAliases_ListByBillingAccount", + "title": "BillingSubscriptionAliasList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json index 3c66a75b44ed..17f09355962d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json @@ -8,27 +8,29 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903", "billingProfileName": "47268432", "displayName": "My Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/6564892/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/6564892/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "provisioningTenantId": "7d62dbd1-1348-4496-b2f8-df6948c103ee", "quantity": 50, - "skuId": "0001", "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", "systemOverrides": { "cancellation": "Allowed", "cancellationAllowedEndDate": "2023-01-05T22:39:34.2606750Z" - }, - "provisioningTenantId": "7d62dbd1-1348-4496-b2f8-df6948c103ee", - "status": "Active", - "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions" + } + } } } - } + }, + "operationId": "BillingSubscriptions_GetByBillingProfile", + "title": "BillingSubscriptionGetByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionMove.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionMove.json index 709de40b4567..41315343d41e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionMove.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionMove.json @@ -10,21 +10,21 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "consumptionCostCenter": "ABC1234", "displayName": "My Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } } }, "202": { @@ -33,5 +33,7 @@ "Retry-After": "30" } } - } + }, + "operationId": "BillingSubscriptions_Move", + "title": "BillingSubscriptionMove" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json index 2f6bbf83fe3f..d9e04a753566 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json @@ -3,8 +3,8 @@ "api-version": "2024-04-01", "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", "parameters": { "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" } @@ -18,5 +18,7 @@ } } } - } + }, + "operationId": "BillingSubscriptions_ValidateMoveEligibility", + "title": "BillingSubscriptionValidateMoveFailure" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json index 6be9d3debae2..9deec3d962ed 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json @@ -3,8 +3,8 @@ "api-version": "2024-04-01", "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", "parameters": { "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" } @@ -15,5 +15,7 @@ "isMoveEligible": true } } - } + }, + "operationId": "BillingSubscriptions_ValidateMoveEligibility", + "title": "BillingSubscriptionValidateMoveSuccess" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json index eb572f74a4f7..28aeef92114d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json @@ -15,5 +15,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingSubscriptions_Cancel", + "title": "BillingSubscriptionsCancel" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json index 2ef935ea444e..9e1cc40c863d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json @@ -5,12 +5,14 @@ "billingSubscriptionName": "11111111-1111-1111-1111-111111111111" }, "responses": { - "204": {}, "202": { "headers": { "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/cancelBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", "retry-after": "10" } - } - } + }, + "204": {} + }, + "operationId": "BillingSubscriptions_Delete", + "title": "BillingSubscriptionsDelete" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json index 69239001d314..43a4cd37d02b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json @@ -7,39 +7,41 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", "displayName": "My subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-04T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, - "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } } - } + }, + "operationId": "BillingSubscriptions_Get", + "title": "BillingSubscriptionsGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json index cf5fa5ea5f24..3db4281ae8c3 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json @@ -11,111 +11,111 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", "displayName": "My subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-04T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, - "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", "displayName": "Test subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "Software", "productType": "Software Product Type", "productTypeId": "EFG456", "purchaseDate": "2023-01-06T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, - "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", "termDuration": "P1M", - "termStartDate": "2023-01-07T22:39:34.2606750Z", "termEndDate": "2023-02-07T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-07T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", "systemData": { "createdAt": "2023-01-06T22:39:34.2606750Z", "lastModifiedAt": "2023-01-07T22:39:34.2606750Z" } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000002", "name": "90000000-0000-0000-0000-000000000002", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000002", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", "displayName": "Dev subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "ReservationOrder", "productType": "Reservation Product Type", "productTypeId": "JKL789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", - "skuDescription": "SKU Description", - "systemOverrides": { - "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" - }, "resourceUri": "/providers/Microsoft.Capacity/reservationOrders/90000000-0000-0000-0000-000000000002", - "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", - "termEndDate": "2023-02-05T22:39:34.2606750Z", + "skuDescription": "SKU Description", + "skuId": "0001", "status": "Suspended", - "suspensionReasons": [ - "Cancelled" - ], "suspensionReasonDetails": [ { "effectiveDate": "2023-01-15T22:39:34.2606750Z", "reason": "Cancelled" } - ] + ], + "suspensionReasons": [ + "Cancelled" + ], + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" @@ -124,5 +124,7 @@ ] } } - } + }, + "operationId": "BillingSubscriptions_ListByBillingAccount", + "title": "BillingSubscriptionsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json index 429e2bb6e50a..ebb52bad9c95 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json @@ -9,22 +9,24 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903", "billingProfileName": "47268432", "displayName": "My Subscription", - "enrollmentAccountId": "172988", "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountId": "172988", "offerId": "MS-AZR-0017P", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions" + } } ] } } - } + }, + "operationId": "BillingSubscriptions_ListByBillingProfile", + "title": "BillingSubscriptionsListByBillingProfileEA" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json index 9d937156f3fe..87b8659a17d1 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json @@ -9,75 +9,77 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "My Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Microsoft Azure Dev/Test", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Test Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Microsoft Azure Dev/Test", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active", "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Microsoft Azure Dev/Test", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active", "subscriptionId": "90D31600-D46D-4084-84C6-1235CDAFFB56" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Test Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Domain Name Registration ORG", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", "status": "Active", "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } } ] } } - } + }, + "operationId": "BillingSubscriptions_ListByBillingProfile", + "title": "BillingSubscriptionsListByBillingProfileMCA" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json index fb2066395f9b..0e62bcbea4fe 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json @@ -10,69 +10,71 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", "displayName": "My Subscription", "reseller": { - "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", - "description": "Reseller1" + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" }, - "skuId": "0002", - "skuDescription": "Microsoft Azure Standard", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "displayName": "Test Subscription", "reseller": { - "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", - "description": "Reseller3" + "description": "Reseller3", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" }, - "skuId": "0002", - "skuDescription": "Microsoft Azure Standard", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", "status": "Active", "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "displayName": "Dev Test Subscription", - "skuId": "0001", - "skuDescription": "Domain Name Registration ORG", "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", "status": "Active", "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } } ] } } - } + }, + "operationId": "BillingSubscriptions_ListByCustomer", + "title": "BillingSubscriptionsListByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json index d472c8ae74b2..f16663b14cc5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json @@ -9,69 +9,71 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", "displayName": "My Subscription", "reseller": { - "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", - "description": "Reseller1" + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" }, - "skuId": "0002", - "skuDescription": "Microsoft Azure Standard", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "displayName": "Test Subscription", "reseller": { - "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", - "description": "Reseller3" + "description": "Reseller3", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" }, - "skuId": "0002", - "skuDescription": "Microsoft Azure Standard", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", "status": "Active", "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "displayName": "Dev Test Subscription", - "skuId": "0001", - "skuDescription": "Domain Name Registration ORG", "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", "status": "Active", "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } } ] } } - } + }, + "operationId": "BillingSubscriptions_ListByCustomerAtBillingAccount", + "title": "BillingSubscriptionsListByCustomerAtBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json index 416d3f92d781..3fb62e8c573d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json @@ -9,40 +9,42 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000000", "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000000", "properties": { "consumptionCostCenter": "123", "displayName": "TestSubscription", - "enrollmentAccountId": "172988", "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountId": "172988", "enrollmentAccountSubscriptionDetails": { "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z" }, "offerId": "MS-AZR-0017P", "subscriptionId": "90000000-0000-0000-0000-000000000000" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000001", "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000001", "properties": { "consumptionCostCenter": "", "displayName": "Microsoft Azure Enterprise-1", - "enrollmentAccountId": "172988", "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountId": "172988", "enrollmentAccountSubscriptionDetails": { "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z", "subscriptionEnrollmentAccountStatus": "Deleted" }, "offerId": "MS-AZR-0136P", "subscriptionId": "90000000-0000-0000-0000-000000000001" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } } ] } } - } + }, + "operationId": "BillingSubscriptions_ListByEnrollmentAccount", + "title": "BillingSubscriptionsListByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json index 1b6d720e06c1..035a35768029 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json @@ -10,75 +10,77 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "My Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Microsoft Azure Dev/Test", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Test Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Microsoft Azure Dev/Test", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active", "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Microsoft Azure Dev/Test", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active", "subscriptionId": "90D31600-D46D-4084-84C6-1235CDAFFB56" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Test Subscription", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", - "skuDescription": "Domain Name Registration ORG", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", "status": "Active", "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } } ] } } - } + }, + "operationId": "BillingSubscriptions_ListByInvoiceSection", + "title": "BillingSubscriptionsListByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json index 8de5be257344..9b755bf7ed86 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json @@ -4,40 +4,40 @@ "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", "parameters": { - "targetBillingSubscriptionName": "22222222-2222-2222-2222-222222222222", - "quantity": 1 + "quantity": 1, + "targetBillingSubscriptionName": "22222222-2222-2222-2222-222222222222" } }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/22222222-2222-2222-2222-222222222222", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", "displayName": "Billing Subscription Display Name", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 2, - "skuId": "0001", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" @@ -50,5 +50,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingSubscriptions_Merge", + "title": "BillingSubscriptionsMerge" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json index e543605999b9..68db697e7aec 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json @@ -4,43 +4,43 @@ "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", "parameters": { + "billingFrequency": "P1M", + "quantity": 1, "targetProductTypeId": "XYZ56789", "targetSkuId": "0001", - "quantity": 1, - "termDuration": "P1M", - "billingFrequency": "P1M" + "termDuration": "P1M" } }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", "displayName": "Billing Subscription Display Name", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" @@ -53,5 +53,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingSubscriptions_Split", + "title": "BillingSubscriptionsSplit" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json index 415a2c20f6ba..5fff8da3d7ce 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json @@ -12,33 +12,33 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileName": "xxxx-xxxx-xxx-xxx", "displayName": "Billing Subscription Display Name", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", "productCategory": "SeatBased", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, - "skuId": "0001", "skuDescription": "SKU Description", + "skuId": "0001", + "status": "Active", "systemOverrides": { "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" }, "termDuration": "P1M", - "termStartDate": "2023-01-05T22:39:34.2606750Z", "termEndDate": "2023-02-05T22:39:34.2606750Z", - "status": "Active" + "termStartDate": "2023-01-05T22:39:34.2606750Z" }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", "systemData": { "createdAt": "2023-01-05T22:39:34.2606750Z", "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" @@ -51,5 +51,7 @@ "retry-after": "10" } } - } + }, + "operationId": "BillingSubscriptions_Update", + "title": "BillingSubscriptionsUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json index 5f13a4f6bd5e..93ac15cdffcd 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json @@ -22,5 +22,7 @@ } ] } - } + }, + "operationId": "BillingPermissions_CheckAccessByBillingAccount", + "title": "CheckAccessByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json index f4d5437d5c4a..7128d7524ebf 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json @@ -23,5 +23,7 @@ } ] } - } + }, + "operationId": "BillingPermissions_CheckAccessByBillingProfile", + "title": "CheckAccessByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByCustomer.json index d1a84fcc0698..309da80e893c 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByCustomer.json @@ -24,5 +24,7 @@ } ] } - } + }, + "operationId": "BillingPermissions_CheckAccessByCustomer", + "title": "CheckAccessByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByDepartment.json index 9392d497629c..51ac9c7c6720 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByDepartment.json @@ -23,5 +23,7 @@ } ] } - } + }, + "operationId": "BillingPermissions_CheckAccessByDepartment", + "title": "CheckAccessByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json index 13b589c0e9d3..d3a747bf15b5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json @@ -23,5 +23,7 @@ } ] } - } + }, + "operationId": "BillingPermissions_CheckAccessByEnrollmentAccount", + "title": "CheckAccessByEnrollmentAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json index 9183596dc5c6..87d886d4ac35 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json @@ -24,5 +24,7 @@ } ] } - } + }, + "operationId": "BillingPermissions_CheckAccessByInvoiceSection", + "title": "CheckAccessByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGet.json index 0420a61fbaf1..d6c88013f0bf 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGet.json @@ -8,37 +8,39 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "properties": { "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "customer1", - "systemId": "yyyy-yyyy-yyy-yyy", - "status": "Active", "enabledAzurePlans": [ { - "skuId": "0002", - "skuDescription": "Microsoft Azure Plan for DevTest" + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" } ], "resellers": [ { - "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", - "description": "Reseller1" + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" }, { - "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", - "description": "Reseller2" + "description": "Reseller2", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" } ], + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } } } - } + }, + "operationId": "Customers_Get", + "title": "CustomersGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json index 3166cddbe70e..adb63620add7 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json @@ -7,37 +7,39 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "properties": { "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "customer1", - "systemId": "yyyy-yyyy-yyy-yyy", - "status": "Active", "enabledAzurePlans": [ { - "skuId": "0002", - "skuDescription": "Microsoft Azure Plan for DevTest" + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" } ], "resellers": [ { - "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", - "description": "Reseller1" + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" }, { - "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", - "description": "Reseller2" + "description": "Reseller2", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" } ], + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } } } - } + }, + "operationId": "Customers_GetByBillingAccount", + "title": "CustomersGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccount.json index 572f5fb6eb48..1064a49c704a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccount.json @@ -8,35 +8,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "properties": { "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "customer1", - "systemId": "yyyy-yyyy-yyy-yyy", "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", "properties": { "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "customer2", - "systemId": "zzzz-zzzz-zzz-zzz", - "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + "status": "Active", + "systemId": "zzzz-zzzz-zzz-zzz" + } } ] } } - } + }, + "operationId": "Customers_ListByBillingAccount", + "title": "CustomersListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json index abdd7d4acfe7..95dd9762fbae 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json @@ -9,39 +9,41 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "properties": { "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "customer1", - "systemId": "yyyy-yyyy-yyy-yyy", - "status": "Active", "enabledAzurePlans": [ { - "skuId": "0002", - "skuDescription": "Microsoft Azure Plan for DevTest" + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" } ], "resellers": [ { - "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", - "description": "Reseller1" + "description": "Reseller1", + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd" }, { - "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", - "description": "Reseller2" + "description": "Reseller2", + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19" } ], + "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } } ] } } - } + }, + "operationId": "Customers_ListByBillingAccount", + "title": "CustomersListByBillingAccountWithExpand" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingProfile.json index 6655c8fba7a2..4781d9a4780b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/customersListByBillingProfile.json @@ -9,35 +9,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", "properties": { "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "customer1", - "systemId": "yyyy-yyyy-yyy-yyy", "status": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", "properties": { "billingProfileDisplayName": "Contoso Operations Billing", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "customer2", - "systemId": "zzzz-zzzz-zzz-zzz", - "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + "status": "Active", + "systemId": "zzzz-zzzz-zzz-zzz" + } } ] } } - } + }, + "operationId": "Customers_ListByBillingProfile", + "title": "CustomersListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentGet.json index a876fa5a6f7b..438c256efa13 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentGet.json @@ -7,15 +7,17 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", "name": "164821", + "type": "Microsoft.Billing/billingAccounts/departments", + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", "properties": { "costCenter": "C1", "displayName": "Test department", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/departments" + } } } - } + }, + "operationId": "Departments_Get", + "title": "DepartmentGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json index 1d530f257b1d..5e06cd8592b0 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json @@ -8,27 +8,29 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", "name": "164821", + "type": "Microsoft.Billing/billingAccounts/departments", + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", "properties": { "costCenter": "C1", "displayName": "departmentName1", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/departments" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164822", "name": "164822", + "type": "Microsoft.Billing/billingAccounts/departments", + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164822", "properties": { "costCenter": "C4", "displayName": "departmentName2", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/departments" + } } ] } } - } + }, + "operationId": "Departments_ListByBillingAccount", + "title": "DepartmentsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json index 69e8c2ad9aeb..3e80e4b4459f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json @@ -8,22 +8,24 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", "name": "257698", + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", "properties": { + "accountOwner": "account0@contoso.com", + "authType": "MicrosoftAccount", "costCenter": "C0", - "displayName": "AccountName0", "departmentDisplayName": "TestDept", "departmentId": "164821", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", "isDevTestEnabled": true, - "accountOwner": "account0@contoso.com", - "authType": "MicrosoftAccount", - "status": "Active", "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z" - }, - "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts" + "status": "Active" + } } } - } + }, + "operationId": "EnrollmentAccounts_GetByDepartment", + "title": "EnrollmentAccountByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountGet.json index 1727fe1059f8..e339850df786 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountGet.json @@ -7,22 +7,24 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", "name": "257698", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", "properties": { + "accountOwner": "account0@contoso.com", + "authType": "Organization", "costCenter": "C0", - "displayName": "AccountName0", "departmentDisplayName": "TestDept123", "departmentId": "234516", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", "isDevTestEnabled": true, - "accountOwner": "account0@contoso.com", - "authType": "Organization", - "status": "Active", "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + "status": "Active" + } } } - } + }, + "operationId": "EnrollmentAccounts_Get", + "title": "EnrollmentAccountGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json index 5516c5102f55..abf35fa57ccc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json @@ -8,58 +8,60 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", "name": "257698", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", "properties": { + "accountOwner": "account0@contoso.com", + "authType": "Organization", "costCenter": "C0", - "displayName": "AccountName0", "departmentDisplayName": "TestDept123", "departmentId": "234516", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", "isDevTestEnabled": true, - "accountOwner": "account0@contoso.com", - "authType": "Organization", - "status": "Active", "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + "status": "Active" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/264698", "name": "264698", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/264698", "properties": { + "accountOwner": "account1@contoso.com", + "authType": "MicrosoftAccount", "costCenter": "C1", - "displayName": "AccountName1", "departmentDisplayName": "TestDept1", "departmentId": "234531", + "displayName": "AccountName1", + "endDate": "2019-05-31T17:32:28Z", "isDevTestEnabled": true, - "accountOwner": "account1@contoso.com", - "authType": "MicrosoftAccount", - "status": "Active", "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + "status": "Active" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/276290", "name": "276290", + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/276290", "properties": { + "accountOwner": "account2@contoso.com", + "authType": "Organization", "costCenter": "C2", - "displayName": "AccountName2", "departmentDisplayName": "TestDept2", "departmentId": "234512", + "displayName": "AccountName2", + "endDate": "2019-05-31T17:32:28Z", "isDevTestEnabled": true, - "accountOwner": "account2@contoso.com", - "authType": "Organization", - "status": "Active", "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z" - }, - "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + "status": "Active" + } } ] } } - } + }, + "operationId": "EnrollmentAccounts_ListByBillingAccount", + "title": "EnrollmentAccountsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json index e08ee1045efe..d5868b3a9412 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json @@ -9,41 +9,43 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", "name": "257698", + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", "properties": { + "accountOwner": "account0@contoso.com", + "authType": "MicrosoftAccount", "costCenter": "C0", - "displayName": "AccountName0", "departmentDisplayName": "TestDept", "departmentId": "164821", + "displayName": "AccountName0", + "endDate": "2019-05-31T17:32:28Z", "isDevTestEnabled": true, - "accountOwner": "account0@contoso.com", - "authType": "MicrosoftAccount", - "status": "Active", "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z" - }, - "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts" + "status": "Active" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/264698", "name": "264698", + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/264698", "properties": { + "accountOwner": "account1@contoso.com", + "authType": "Organization", "costCenter": "C1", - "displayName": "AccountName1", "departmentDisplayName": "TestDept", "departmentId": "164821", + "displayName": "AccountName1", + "endDate": "2019-05-31T17:32:28Z", "isDevTestEnabled": false, - "accountOwner": "account1@contoso.com", - "authType": "Organization", - "status": "Active", "startDate": "2018-05-01T17:32:28Z", - "endDate": "2019-05-31T17:32:28Z" - }, - "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts" + "status": "Active" + } } ] } } - } + }, + "operationId": "EnrollmentAccounts_ListByDepartment", + "title": "EnrollmentAccountsListByDepartment" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json index f7f6a1a1731e..f389c2b590fc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json @@ -8,8 +8,8 @@ "properties": { "displayName": "Invoice Section 1", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } } } @@ -17,32 +17,32 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "properties": { "displayName": "Invoice Section 1", "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "properties": { "displayName": "Invoice Section 1", "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } } }, "202": { @@ -51,5 +51,7 @@ "retry-after": "10" } } - } + }, + "operationId": "InvoiceSections_CreateOrUpdate", + "title": "InvoiceSectionsCreateOrUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json index 0bcbd1035e0c..5a78c77c8640 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json @@ -13,5 +13,7 @@ } }, "204": {} - } + }, + "operationId": "InvoiceSections_Delete", + "title": "InvoiceSectionsDelete" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsGet.json index 7ea5ce403fe1..14bb9fb17c92 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsGet.json @@ -8,18 +8,20 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "properties": { "displayName": "Invoice Section 1", "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } } } - } + }, + "operationId": "InvoiceSections_Get", + "title": "InvoiceSectionsGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json index b143a636d1a1..80192327a992 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json @@ -10,50 +10,52 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "name": "invoice-section-1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", "properties": { "displayName": "Invoice Section 1", "state": "Active", "systemId": "yyyy-yyyy-yyy-yyy", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-2", "name": "invoice-section-2", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-2", "properties": { "displayName": "Invoice Section 2", - "state": "Warned", "reasonCode": "PastDue", + "state": "Warned", "systemId": "zzzz-zzzz-zzz-zzz", "tags": { - "pcCode": "Z345678", - "costCategory": "Marketing" + "costCategory": "Marketing", + "pcCode": "Z345678" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-3", "name": "invoice-section-3", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-3", "properties": { "displayName": "Invoice Section 3", "state": "Deleted", "systemId": "aaaa-aaaa-aaa-aaa", "tags": { - "pcCode": "A123456", - "costCategory": "Support" + "costCategory": "Support", + "pcCode": "A123456" } - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } } ] } } - } + }, + "operationId": "InvoiceSections_ListByBillingProfile", + "title": "InvoiceSectionsListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json index c274e79aded2..1668074a45c3 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json @@ -8,7 +8,6 @@ "responses": { "200": { "body": { - "eligibilityStatus": "NotAllowed", "eligibilityDetails": [ { "code": "ActiveBillingSubscriptions", @@ -26,8 +25,11 @@ "code": "ReservedInstances", "message": "The invoice section has the RI asset with a billing plan." } - ] + ], + "eligibilityStatus": "NotAllowed" } } - } + }, + "operationId": "InvoiceSections_ValidateDeleteEligibility", + "title": "InvoiceSectionsValidateDeleteEligibilityFailure" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json index 21f8bfc23c13..52213dde07c6 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json @@ -9,5 +9,7 @@ "200": { "body": {} } - } + }, + "operationId": "InvoiceSections_ValidateDeleteEligibility", + "title": "InvoiceSectionsValidateDeleteEligibilitySuccess" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json index 878a9223f35e..0f6b4ebe83be 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json @@ -10,18 +10,18 @@ { "billingProfileDisplayName": "Billing Profile Display Name", "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", - "billingProfileSystemId": "33000000-0000-0000-0000-000000000000", + "billingProfileSpendingLimit": "On", "billingProfileStatus": "Warned", "billingProfileStatusReasonCode": "PastDue", - "billingProfileSpendingLimit": "On", + "billingProfileSystemId": "33000000-0000-0000-0000-000000000000", "enabledAzurePlans": [ { - "skuId": "0001", - "skuDescription": "Microsoft Azure Plan" + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001" }, { - "skuId": "0002", - "skuDescription": "Microsoft Azure Plan for DevTest" + "skuDescription": "Microsoft Azure Plan for DevTest", + "skuId": "0002" } ], "invoiceSectionDisplayName": "Invoice Section Display Name", @@ -31,5 +31,7 @@ ] } } - } + }, + "operationId": "BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission", + "title": "InvoiceSectionsWithCreateSubscriptionPermissionList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesAmend.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesAmend.json index 9aeb97d29b16..7be7083e7c45 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesAmend.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesAmend.json @@ -11,5 +11,7 @@ "Retry-After": "10" } } - } + }, + "operationId": "Invoices_Amend", + "title": "InvoicesAmend" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json index 50877f606d79..ff63bd242d0b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json @@ -2,8 +2,8 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "invoiceName": "G123456789", - "documentName": "12345678" + "documentName": "12345678", + "invoiceName": "G123456789" }, "responses": { "200": { @@ -18,5 +18,7 @@ "Retry-After": "10" } } - } + }, + "operationId": "Invoices_DownloadByBillingAccount", + "title": "InvoicesDownloadByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json index cd1d29c4d592..92bce81e17c2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json @@ -1,9 +1,9 @@ { "parameters": { "api-version": "2024-04-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "documentName": "12345678", "invoiceName": "E123456789", - "documentName": "12345678" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -18,5 +18,7 @@ "Retry-After": "10" } } - } + }, + "operationId": "Invoices_DownloadByBillingSubscription", + "title": "InvoicesDownloadByBillingSubscription" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json index 3dd14b57b953..ee7e31e238de 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json @@ -26,5 +26,7 @@ "Retry-After": "10" } } - } + }, + "operationId": "Invoices_DownloadDocumentsByBillingAccount", + "title": "InvoicesDownloadDocumentsByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json index 872bde3b455b..c2267bd021aa 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json @@ -1,7 +1,6 @@ { "parameters": { "api-version": "2024-04-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": [ { "documentName": "12345678", @@ -11,7 +10,8 @@ "documentName": "12345678", "invoiceName": "E987654321" } - ] + ], + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -26,5 +26,7 @@ "Retry-After": "10" } } - } + }, + "operationId": "Invoices_DownloadDocumentsByBillingSubscription", + "title": "InvoicesDownloadDocumentsByBillingSubscription" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json index f2c3759ba5de..7e3f23a4fde2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json @@ -17,5 +17,7 @@ "Retry-After": "10" } } - } + }, + "operationId": "Invoices_DownloadSummaryByBillingAccount", + "title": "InvoicesDownloadSummaryByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGet.json index 3631d75fc2d7..48f386e6616d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGet.json @@ -6,8 +6,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "properties": { "amountDue": { "currency": "USD", @@ -27,17 +28,17 @@ "currency": "USD", "value": 0 }, + "documentType": "Invoice", "documents": [ { - "kind": "Invoice", - "name": "12345678" + "name": "12345678", + "kind": "Invoice" }, { - "kind": "TaxReceipt", - "name": "22345678" + "name": "22345678", + "kind": "TaxReceipt" } ], - "documentType": "Invoice", "dueDate": "2023-02-16T17:32:28Z", "freeAzureCreditApplied": { "currency": "USD", @@ -49,15 +50,15 @@ "isMonthlyInvoice": false, "purchaseOrderNumber": "123456", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", - "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" } }, - "status": "Due", "specialTaxationType": "SubtotalLevel", + "status": "Due", "subTotal": { "currency": "USD", "value": 33.99 @@ -70,9 +71,10 @@ "currency": "USD", "value": 7.53 } - }, - "type": "Microsoft.Billing/billingAccounts/invoices" + } } } - } + }, + "operationId": "Invoices_Get", + "title": "InvoicesGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json index 9f901c68983f..f60e257e55f0 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json @@ -7,8 +7,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "properties": { "amountDue": { "currency": "USD", @@ -28,17 +29,17 @@ "currency": "USD", "value": 0 }, + "documentType": "Invoice", "documents": [ { - "kind": "Invoice", - "name": "12345678" + "name": "12345678", + "kind": "Invoice" }, { - "kind": "TaxReceipt", - "name": "22345678" + "name": "22345678", + "kind": "TaxReceipt" } ], - "documentType": "Invoice", "dueDate": "2023-02-16T17:32:28Z", "freeAzureCreditApplied": { "currency": "USD", @@ -50,15 +51,15 @@ "isMonthlyInvoice": false, "purchaseOrderNumber": "123456", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", - "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" } }, - "status": "Due", "specialTaxationType": "SubtotalLevel", + "status": "Due", "subTotal": { "currency": "USD", "value": 33.99 @@ -71,9 +72,10 @@ "currency": "USD", "value": 7.53 } - }, - "type": "Microsoft.Billing/billingAccounts/invoices" + } } } - } + }, + "operationId": "Invoices_GetByBillingAccount", + "title": "InvoicesGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json index 61816249e447..216ac293d844 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json @@ -1,14 +1,15 @@ { "parameters": { "api-version": "2024-04-01", - "subscriptionId": "11111111-1111-1111-1111-111111111111", - "invoiceName": "E123456789" + "invoiceName": "E123456789", + "subscriptionId": "11111111-1111-1111-1111-111111111111" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", "name": "E123456789", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", "properties": { "amountDue": { "currency": "USD", @@ -27,9 +28,10 @@ "status": "Due", "subscriptionDisplayName": "Contoso Operations Billing", "subscriptionId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + } } } - } + }, + "operationId": "Invoices_GetByBillingSubscription", + "title": "InvoicesGetByBillingSubscription" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json index 9027fef1b823..5c97f586d6d9 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json @@ -2,16 +2,17 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "periodStartDate": "2023-01-01", - "periodEndDate": "2023-06-30" + "periodEndDate": "2023-06-30", + "periodStartDate": "2023-01-01" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "properties": { "amountDue": { "currency": "USD", @@ -31,17 +32,17 @@ "currency": "USD", "value": 0 }, + "documentType": "Invoice", "documents": [ { - "kind": "Invoice", - "name": "12345678" + "name": "12345678", + "kind": "Invoice" }, { - "kind": "TaxReceipt", - "name": "22345678" + "name": "22345678", + "kind": "TaxReceipt" } ], - "documentType": "Invoice", "dueDate": "2023-02-16T17:32:28Z", "freeAzureCreditApplied": { "currency": "USD", @@ -53,11 +54,11 @@ "isMonthlyInvoice": false, "purchaseOrderNumber": "123456", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", - "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" } }, "status": "Due", @@ -73,12 +74,12 @@ "currency": "USD", "value": 7.53 } - }, - "type": "Microsoft.Billing/billingAccounts/invoices" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", "name": "G987654321", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", "properties": { "amountDue": { "currency": "USD", @@ -98,17 +99,17 @@ "currency": "USD", "value": 0 }, + "documentType": "Invoice", "documents": [ { - "kind": "Invoice", - "name": "12345678" + "name": "12345678", + "kind": "Invoice" }, { - "kind": "TaxReceipt", - "name": "22345678" + "name": "22345678", + "kind": "TaxReceipt" } ], - "documentType": "Invoice", "dueDate": "2023-01-16T17:32:28Z", "freeAzureCreditApplied": { "currency": "USD", @@ -132,11 +133,11 @@ ], "purchaseOrderNumber": "123455", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", - "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" } }, "status": "Paid", @@ -152,11 +153,12 @@ "currency": "USD", "value": 7.53 } - }, - "type": "Microsoft.Billing/billingAccounts/invoices" + } } ] } } - } + }, + "operationId": "Invoices_ListByBillingAccount", + "title": "InvoicesListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json index ecf3db7b638b..c2a04d9eaca8 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json @@ -3,16 +3,17 @@ "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "periodStartDate": "2023-01-01", - "periodEndDate": "2023-06-30" + "periodEndDate": "2023-06-30", + "periodStartDate": "2023-01-01" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", "properties": { "amountDue": { "currency": "USD", @@ -32,17 +33,17 @@ "currency": "USD", "value": 0 }, + "documentType": "Invoice", "documents": [ { - "kind": "Invoice", - "name": "12345678" + "name": "12345678", + "kind": "Invoice" }, { - "kind": "TaxReceipt", - "name": "22345678" + "name": "22345678", + "kind": "TaxReceipt" } ], - "documentType": "Invoice", "dueDate": "2023-02-16T17:32:28Z", "freeAzureCreditApplied": { "currency": "USD", @@ -54,11 +55,11 @@ "isMonthlyInvoice": false, "purchaseOrderNumber": "123456", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", - "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" } }, "status": "Due", @@ -74,12 +75,12 @@ "currency": "USD", "value": 7.53 } - }, - "type": "Microsoft.Billing/billingAccounts/invoices" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", "name": "G987654321", + "type": "Microsoft.Billing/billingAccounts/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", "properties": { "amountDue": { "currency": "USD", @@ -99,17 +100,17 @@ "currency": "USD", "value": 0 }, + "documentType": "Invoice", "documents": [ { - "kind": "Invoice", - "name": "12345678" + "name": "12345678", + "kind": "Invoice" }, { - "kind": "TaxReceipt", - "name": "22345678" + "name": "22345678", + "kind": "TaxReceipt" } ], - "documentType": "Invoice", "dueDate": "2023-01-16T17:32:28Z", "freeAzureCreditApplied": { "currency": "USD", @@ -133,11 +134,11 @@ ], "purchaseOrderNumber": "123455", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", "rebillDetails": { - "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", - "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote", + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001" } }, "status": "Paid", @@ -153,11 +154,12 @@ "currency": "USD", "value": 7.53 } - }, - "type": "Microsoft.Billing/billingAccounts/invoices" + } } ] } } - } + }, + "operationId": "Invoices_ListByBillingProfile", + "title": "InvoicesListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json index 9ea623b7b3b5..de7b1d65ba72 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json @@ -1,17 +1,18 @@ { "parameters": { "api-version": "2024-04-01", - "subscriptionId": "11111111-1111-1111-1111-111111111111", + "periodEndDate": "2023-06-30", "periodStartDate": "2023-01-01", - "periodEndDate": "2023-06-30" + "subscriptionId": "11111111-1111-1111-1111-111111111111" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", "name": "E123456789", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", "properties": { "amountDue": { "currency": "USD", @@ -30,12 +31,12 @@ "status": "Due", "subscriptionDisplayName": "Contoso Operations Billing", "subscriptionId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/G123456789", "name": "G123456789", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/G123456789", "properties": { "amountDue": { "currency": "USD", @@ -54,12 +55,12 @@ "status": "Due", "subscriptionDisplayName": "Contoso Operations Billing", "subscriptionId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E987654321", "name": "E987654321", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E987654321", "properties": { "amountDue": { "currency": "USD", @@ -71,8 +72,8 @@ }, "documents": [ { - "kind": "Invoice", - "name": "12345678" + "name": "12345678", + "kind": "Invoice" } ], "dueDate": "2023-01-16T17:32:28Z", @@ -96,11 +97,12 @@ "status": "Due", "subscriptionDisplayName": "Contoso Operations Billing", "subscriptionId": "11111111-1111-1111-1111-111111111111" - }, - "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + } } ] } } - } + }, + "operationId": "Invoices_ListByBillingSubscription", + "title": "InvoicesListByBillingSubscription" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/operationsList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/operationsList.json index 43d9ddc7dba2..cefabe33c7f2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/operationsList.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/operationsList.json @@ -17,5 +17,7 @@ ] } } - } + }, + "operationId": "Operations_List", + "title": "OperationsList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersCancel.json index 05c6064bc437..0c27c912e8ee 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersCancel.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersCancel.json @@ -9,18 +9,20 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "properties": { + "canceledBy": "user@contoso.com", "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "Pending", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", "initiatorCustomerType": "Partner", - "canceledBy": "user@contoso.com" + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" } } } - } + }, + "operationId": "PartnerTransfers_Cancel", + "title": "PartnerTransferCancel" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersGet.json index 077a453b3dd3..be3e6c467ec5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersGet.json @@ -9,33 +9,35 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "properties": { - "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", - "initiatorCustomerType": "Partner", "detailedTransferStatus": [ { - "productType": "AzureSubscription", "productId": "subscriptionId", "productName": "Azure subscription 1", + "productType": "AzureSubscription", "skuDescription": "MS-AZR-0017G", "transferStatus": "InProgress" }, { - "productType": "AzureReservation", "productId": "reservedInstanceId", "productName": "Reservation name", + "productType": "AzureReservation", "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", "transferStatus": "InProgress" } - ] + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorCustomerType": "Partner", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" } } } - } + }, + "operationId": "PartnerTransfers_Get", + "title": "PartnerTransferGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json index 2f504241e882..5126d6992020 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json @@ -4,41 +4,43 @@ "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "xxxx-xxxx-xxx-xxx", "customerName": "11111111-1111-1111-1111-111111111111", - "transferName": "aabb123", "parameters": { "properties": { "recipientEmailId": "user@contoso.com" } - } + }, + "transferName": "aabb123" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "properties": { "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "Pending", - "recipientEmailId": "user@contoso.com", + "initiatorCustomerType": "Partner", "initiatorEmailId": "xyz@contoso.com", - "initiatorCustomerType": "Partner" + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "properties": { "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "Pending", - "recipientEmailId": "user@contoso.com", + "initiatorCustomerType": "Partner", "initiatorEmailId": "xyz@contoso.com", - "initiatorCustomerType": "Partner" + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" } } } - } + }, + "operationId": "PartnerTransfers_Initiate", + "title": "InitiatePartnerTransfer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersList.json index 9a99ec1f3832..2185d0e29055 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersList.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/partnerTransfersList.json @@ -11,35 +11,37 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", "properties": { - "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", - "initiatorCustomerType": "Partner", "detailedTransferStatus": [ { - "productType": "AzureSubscription", "productId": "subscriptionId", "productName": "Azure subscription 1", + "productType": "AzureSubscription", "skuDescription": "MS-AZR-0017G", "transferStatus": "InProgress" }, { - "productType": "AzureReservation", "productId": "reservedInstanceId", "productName": "Reservation name", + "productType": "AzureReservation", "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", "transferStatus": "InProgress" } - ] + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorCustomerType": "Partner", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" } } ] } } - } + }, + "operationId": "PartnerTransfers_List", + "title": "PartnerTransfersList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json index 1573481c5c15..a8c96baa845e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json @@ -6,5 +6,7 @@ "responses": { "200": {}, "204": {} - } + }, + "operationId": "PaymentMethods_DeleteByUser", + "title": "DeletePaymentMethodOwnedByUser" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json index d43dbe5178c0..0e98bd48011d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json @@ -7,15 +7,17 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", "name": "21dd9edc-af71-4d62-80ce-37151d475326", "type": "Microsoft.Billing/billingAccounts/paymentMethods", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", "properties": { + "displayName": "Check/wire transfer", "family": "CheckWire", - "paymentMethodType": "check", - "displayName": "Check/wire transfer" + "paymentMethodType": "check" } } } - } + }, + "operationId": "PaymentMethods_GetByBillingAccount", + "title": "PaymentMethodGetAtBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json index fb10f118429b..0bcd26dc0121 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json @@ -8,17 +8,15 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", "name": "ABCDABCDABC0", "type": "Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", "properties": { - "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", "accountHolderName": "abc", + "displayName": "Master Card", "expiration": "1/2035", - "lastFourDigits": "1270", "family": "CreditCard", - "paymentMethodType": "mc", - "displayName": "Master Card", + "lastFourDigits": "1270", "logos": [ { "mimeType": "image/png", @@ -29,9 +27,13 @@ "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" } ], + "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "paymentMethodType": "mc", "status": "active" } } } - } + }, + "operationId": "PaymentMethods_GetByBillingProfile", + "title": "PaymentMethodsGetByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json index 03ac39e0d9f3..a894566b8a7e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json @@ -6,16 +6,15 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", "name": "ABCDABCDABC0", "type": "Microsoft.Billing/paymentMethods", + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", "properties": { "accountHolderName": "abc", + "displayName": "Master Card", "expiration": "1/2035", - "lastFourDigits": "1270", "family": "CreditCard", - "paymentMethodType": "mc", - "displayName": "Master Card", + "lastFourDigits": "1270", "logos": [ { "mimeType": "image/png", @@ -26,9 +25,12 @@ "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" } ], + "paymentMethodType": "mc", "status": "active" } } } - } + }, + "operationId": "PaymentMethods_GetByUser", + "title": "GetPaymentMethodOwnedByUser" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json index d75938f2a479..f455c2b05b35 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json @@ -8,17 +8,19 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", "name": "21dd9edc-af71-4d62-80ce-37151d475326", + "type": "Microsoft.Billing/billingAccounts/paymentMethods", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", "properties": { "displayName": "Check/wire transfer", "family": "CheckWire", "paymentMethodType": "check" - }, - "type": "Microsoft.Billing/billingAccounts/paymentMethods" + } } ] } } - } + }, + "operationId": "PaymentMethods_ListByBillingAccount", + "title": "PaymentMethodsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json index 876f72195042..2bbd5f9065e4 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json @@ -9,17 +9,15 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", "name": "ABCDABCDABC0", "type": "Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", "properties": { - "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", "accountHolderName": "abc", + "displayName": "Master Card", "expiration": "1/2035", - "lastFourDigits": "1270", "family": "CreditCard", - "paymentMethodType": "mc", - "displayName": "Master Card", + "lastFourDigits": "1270", "logos": [ { "mimeType": "image/png", @@ -30,11 +28,15 @@ "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" } ], + "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "paymentMethodType": "mc", "status": "active" } } ] } } - } + }, + "operationId": "PaymentMethods_ListByBillingProfile", + "title": "PaymentMethodsListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json index 93f6f8355cce..171ce892979f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json @@ -7,16 +7,15 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", "name": "ABCDABCDABC0", "type": "Microsoft.Billing/paymentMethods", + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", "properties": { "accountHolderName": "abc", + "displayName": "Master Card", "expiration": "1/2035", - "lastFourDigits": "1270", "family": "CreditCard", - "paymentMethodType": "mc", - "displayName": "Master Card", + "lastFourDigits": "1270", "logos": [ { "mimeType": "image/png", @@ -27,20 +26,20 @@ "url": "https://contoso.com/staticresourceservice/images/v4/logo_mc.svg" } ], + "paymentMethodType": "mc", "status": "active" } }, { - "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC1", "name": "ABCDABCDABC1", "type": "Microsoft.Billing/paymentMethods", + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC1", "properties": { "accountHolderName": "abc", + "displayName": "Visa", "expiration": "1/2025", - "lastFourDigits": "7373", "family": "CreditCard", - "paymentMethodType": "visa", - "displayName": "Visa", + "lastFourDigits": "7373", "logos": [ { "mimeType": "image/png", @@ -51,11 +50,14 @@ "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" } ], + "paymentMethodType": "visa", "status": "active" } } ] } } - } + }, + "operationId": "PaymentMethods_ListByUser", + "title": "ListPaymentMethodOwnedByUser" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermInvalid.json index 30d437b35a74..a0e8996e8e22 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermInvalid.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermInvalid.json @@ -1,26 +1,28 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "parameters": [ { - "term": "net10", + "endDate": "2023-01-25T22:39:34.2606750Z", "startDate": "2023-02-05T22:39:34.2606750Z", - "endDate": "2023-01-25T22:39:34.2606750Z" + "term": "net10" } ] }, "responses": { "200": { "body": { - "eligibilityStatus": "Invalid", "eligibilityDetails": [ { "code": "InvalidDateRange", "message": "The date range is invalid. The start date must be before the end date." } - ] + ], + "eligibilityStatus": "Invalid" } } - } + }, + "operationId": "BillingAccounts_ValidatePaymentTerms", + "title": "PaymentTermInvalid" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermValid.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermValid.json index 0cd84effd69c..b9d6a2d0b8e2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermValid.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermValid.json @@ -1,12 +1,12 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "parameters": [ { - "term": "net10", + "endDate": "2023-01-25T22:39:34.2606750Z", "startDate": "2023-01-05T22:39:34.2606750Z", - "endDate": "2023-01-25T22:39:34.2606750Z" + "term": "net10" } ] }, @@ -16,5 +16,7 @@ "eligibilityStatus": "Valid" } } - } + }, + "operationId": "BillingAccounts_ValidatePaymentTerms", + "title": "PaymentTermValid" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsAdd.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsAdd.json index 7ecf399a26cb..9233b4b2953e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsAdd.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsAdd.json @@ -1,42 +1,44 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "parameters": [ { - "term": "net10", + "endDate": "2023-01-25T22:39:34.2606750Z", "startDate": "2023-01-05T22:39:34.2606750Z", - "endDate": "2023-01-25T22:39:34.2606750Z" + "term": "net10" } ] }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/addPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", - "retry-after": "10", - "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b" - } - }, "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/addPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", + "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b", + "retry-after": "10" + } } - } + }, + "operationId": "BillingAccounts_AddPaymentTerms", + "title": "PaymentTermsAdd" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsCancel.json index e0a806eeaf07..5acaac028d71 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsCancel.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/paymentTermsCancel.json @@ -1,36 +1,38 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "parameters": "2023-01-05T22:39:34.2606750Z" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/cancelPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", - "retry-after": "10", - "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b" - } - }, "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "name": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "type": "Microsoft.Billing/billingAccounts", + "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "properties": { "accountStatus": "Active", - "accountType": "Business", "accountSubType": "Enterprise", + "accountType": "Business", "agreementType": "MicrosoftCustomerAgreement", "displayName": "Premier Business Account", "hasReadAccess": true, "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" }, - "type": "Microsoft.Billing/billingAccounts", "systemData": { "createdAt": "2023-01-04T22:39:34.2606750Z", "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/cancelPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", + "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b", + "retry-after": "10" + } } - } + }, + "operationId": "BillingAccounts_CancelPaymentTerms", + "title": "PaymentTermsCancel" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json index 557a8d860659..a0d77bb27fff 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json @@ -6,8 +6,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", "properties": { "enterpriseAgreementPolicies": { "authenticationType": "OrganizationalAccountOnly" @@ -15,9 +16,10 @@ "marketplacePurchases": "AllAllowed", "reservationPurchases": "Allowed", "savingsPlanPurchases": "NotAllowed" - }, - "type": "Microsoft.Billing/billingAccounts/policies" + } } } - } + }, + "operationId": "Policies_GetByBillingAccount", + "title": "PoliciesGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json index f8fa70b88ffd..2ace88338036 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json @@ -7,16 +7,18 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", "properties": { "invoiceSectionLabelManagement": "Allowed", "marketplacePurchases": "AllAllowed", "reservationPurchases": "Allowed", "savingsPlanPurchases": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies" + } } } - } + }, + "operationId": "Policies_GetByBillingProfile", + "title": "PoliciesGetByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomer.json index c63a027a93d6..27517beee747 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomer.json @@ -9,13 +9,15 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "properties": { "viewCharges": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } } } - } + }, + "operationId": "Policies_GetByCustomer", + "title": "PoliciesGetByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json index 31151821dd51..dbb455ddddb5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json @@ -7,13 +7,15 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "properties": { "viewCharges": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } } } - } + }, + "operationId": "Policies_GetByCustomerAtBillingAccount", + "title": "PoliciesGetByCustomerAtBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetBySubscription.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetBySubscription.json index 0f5ed801ddf6..256eb0324fcd 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetBySubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesGetBySubscription.json @@ -6,20 +6,22 @@ "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/policies/default", "name": "default", + "type": "Microsoft.Billing/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/policies/default", "properties": { "policies": [ { "name": "ViewCharges", - "value": "Allowed", "policyType": "SystemControlled", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000" + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000", + "value": "Allowed" } ] - }, - "type": "Microsoft.Billing/policies" + } } } - } + }, + "operationId": "Policies_GetBySubscription", + "title": "PoliciesGetBySubscription" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json index 94ef59622ac5..8b5c94d8f90b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json @@ -16,8 +16,9 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", "properties": { "enterpriseAgreementPolicies": { "authenticationType": "OrganizationalAccountOnly" @@ -25,14 +26,14 @@ "marketplacePurchases": "AllAllowed", "reservationPurchases": "Allowed", "savingsPlanPurchases": "NotAllowed" - }, - "type": "Microsoft.Billing/billingAccounts/policies" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", "properties": { "enterpriseAgreementPolicies": { "authenticationType": "OrganizationalAccountOnly" @@ -40,9 +41,10 @@ "marketplacePurchases": "AllAllowed", "reservationPurchases": "Allowed", "savingsPlanPurchases": "NotAllowed" - }, - "type": "Microsoft.Billing/billingAccounts/policies" + } } } - } + }, + "operationId": "Policies_CreateOrUpdateByBillingAccount", + "title": "PoliciesPutByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json index 9fd97563d7f8..48ddb2a101ff 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json @@ -15,29 +15,31 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", "properties": { "invoiceSectionLabelManagement": "Allowed", "marketplacePurchases": "AllAllowed", "reservationPurchases": "Allowed", "savingsPlanPurchases": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", "properties": { "invoiceSectionLabelManagement": "Allowed", "marketplacePurchases": "AllAllowed", "reservationPurchases": "Allowed", "savingsPlanPurchases": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies" + } } } - } + }, + "operationId": "Policies_CreateOrUpdateByBillingProfile", + "title": "PoliciesPutByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomer.json index d3daf3ca1d7b..4ef1d775daf7 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomer.json @@ -13,23 +13,25 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "properties": { "viewCharges": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "properties": { "viewCharges": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } } } - } + }, + "operationId": "Policies_CreateOrUpdateByCustomer", + "title": "PoliciesPutByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json index 81b1da8e4f12..61c1a40d4e2a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json @@ -12,23 +12,25 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "properties": { "viewCharges": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", "properties": { "viewCharges": "Allowed" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } } } - } + }, + "operationId": "Policies_CreateOrUpdateByCustomerAtBillingAccount", + "title": "PoliciesPutByCustomerAtBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productMove.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productMove.json index 1f657748848b..ff04c5d96200 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productMove.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productMove.json @@ -2,27 +2,27 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", - "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", "parameters": { "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" - } + }, + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/products/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/products/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "My Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } } }, "202": { @@ -31,5 +31,7 @@ "Retry-After": "30" } } - } + }, + "operationId": "Products_Move", + "title": "ProductMove" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveFailure.json index 1e5d227ab325..9190262c6153 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveFailure.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveFailure.json @@ -4,10 +4,10 @@ "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", - "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", "parameters": { "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" - } + }, + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" }, "responses": { "200": { @@ -18,5 +18,7 @@ } } } - } + }, + "operationId": "Products_ValidateMoveEligibility", + "title": "ProductValidateMoveFailure" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json index 788479ea2fb0..86fc99665ebe 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json @@ -4,10 +4,10 @@ "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", - "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", "parameters": { "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" - } + }, + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" }, "responses": { "200": { @@ -15,5 +15,7 @@ "isMoveEligible": true } } - } + }, + "operationId": "Products_ValidateMoveEligibility", + "title": "ProductValidateMoveSuccess" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsGet.json index ff0ab2c7311d..d060cf6c4035 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsGet.json @@ -7,25 +7,27 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "My product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", - "skuId": "0001", - "skuDescription": "SKU Description", "purchaseDate": "2023-01-04T22:39:34.2606750Z", "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } } } - } + }, + "operationId": "Products_Get", + "title": "ProductsGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingAccount.json index cb0dbabb8f67..d151d2c1f68c 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingAccount.json @@ -8,67 +8,69 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "My product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", - "skuId": "0001", - "skuDescription": "SKU Description", "purchaseDate": "2023-01-04T22:39:34.2606750Z", "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000001", "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000001", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "Test product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "productType": "Software Product Type", "productTypeId": "EFG456", - "skuId": "0001", - "skuDescription": "SKU Description", "purchaseDate": "2023-01-06T22:39:34.2606750Z", "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000002", "name": "90000000-0000-0000-0000-000000000002", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000002", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "Dev product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "productType": "Reservation Product Type", "productTypeId": "JKL789", - "skuId": "0001", - "skuDescription": "SKU Description", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", "status": "Suspended" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } } ] } } - } + }, + "operationId": "Products_ListByBillingAccount", + "title": "ProductsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingProfile.json index b6a016b5a993..a992f596fca9 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByBillingProfile.json @@ -9,67 +9,69 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "My Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Test Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Test Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } } ] } } - } + }, + "operationId": "Products_ListByBillingProfile", + "title": "ProductsListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByCustomer.json index a9a46f5e494c..964234c1abde 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByCustomer.json @@ -9,52 +9,54 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", "displayName": "My Product", - "skuId": "0002", "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "displayName": "Test Product", - "skuId": "0002", "skuDescription": "Microsoft Azure Standard", + "skuId": "0002", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "BillingProfile1", - "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "customerDisplayName": "Customer1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", "displayName": "Dev Test Product", - "skuId": "0001", "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } } ] } } - } + }, + "operationId": "Products_ListByCustomer", + "title": "ProductsListByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json index 63d5a421af24..93996c50973e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json @@ -10,67 +10,69 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "My Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Test Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "skuDescription": "Microsoft Azure Dev/Test", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", "properties": { - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", "displayName": "Dev Test Product", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "invoiceSectionDisplayName": "Contoso operations invoiceSection", - "skuId": "0001", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", "skuDescription": "Domain Name Registration ORG", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } } ] } } - } + }, + "operationId": "Products_ListByInvoiceSection", + "title": "ProductsListByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsUpdate.json index 89f0a2e7f8cd..c2c1927e6fda 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsUpdate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/productsUpdate.json @@ -2,35 +2,37 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "productName": "11111111-1111-1111-1111-111111111111", "parameters": { "properties": { "autoRenew": "On" } - } + }, + "productName": "11111111-1111-1111-1111-111111111111" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Billing/billingAccounts/products", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/11111111-1111-1111-1111-111111111111", "properties": { "autoRenew": "On", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", "displayName": "Product Display Name", - "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", "productType": "Seat-Based Product Type", "productTypeId": "XYZ56789", - "skuId": "0001", - "skuDescription": "SKU Description", "purchaseDate": "2023-01-05T22:39:34.2606750Z", "quantity": 1, + "skuDescription": "SKU Description", + "skuId": "0001", "status": "Active" - }, - "type": "Microsoft.Billing/billingAccounts/products" + } } } - } + }, + "operationId": "Products_Update", + "title": "ProductsUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersAccept.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersAccept.json index 35a05c53d66a..efa2a1b87041 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersAccept.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersAccept.json @@ -1,51 +1,53 @@ { "parameters": { "api-version": "2024-04-01", - "transferName": "aabb123", "parameters": { "properties": { "productDetails": [ { - "productType": "AzureSubscription", - "productId": "subscriptionId" + "productId": "subscriptionId", + "productType": "AzureSubscription" }, { - "productType": "AzureReservation", - "productId": "reservedInstanceId" + "productId": "reservedInstanceId", + "productType": "AzureReservation" } ] } - } + }, + "transferName": "aabb123" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", "properties": { - "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", "detailedTransferStatus": [ { - "productType": "AzureSubscription", "productId": "subscriptionId", "productName": "Azure subscription 1", + "productType": "AzureSubscription", "skuDescription": "MS-AZR-0017G", "transferStatus": "InProgress" }, { - "productType": "AzureReservation", "productId": "reservedInstanceId", "productName": "Reservation name", + "productType": "AzureReservation", "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", "transferStatus": "InProgress" } - ] + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" } } } - } + }, + "operationId": "RecipientTransfers_Accept", + "title": "AcceptTransfer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersDecline.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersDecline.json index 87f959476250..d7e431d7ad84 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersDecline.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersDecline.json @@ -6,16 +6,18 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", "properties": { "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "Declined", + "initiatorEmailId": "xyz@contoso.com", "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com" + "transferStatus": "Declined" } } } - } + }, + "operationId": "RecipientTransfers_Decline", + "title": "DeclineTransfer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersGet.json index 3ff79fd49a41..2f8c8514ce8e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersGet.json @@ -6,32 +6,34 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", "properties": { - "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", "detailedTransferStatus": [ { - "productType": "AzureSubscription", "productId": "subscriptionId", "productName": "Azure subscription 1", + "productType": "AzureSubscription", "skuDescription": "MS-AZR-0017G", "transferStatus": "InProgress" }, { - "productType": "AzureReservation", "productId": "reservedInstanceId", "productName": "Reservation name", + "productType": "AzureReservation", "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", "transferStatus": "InProgress" } - ] + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" } } } - } + }, + "operationId": "RecipientTransfers_Get", + "title": "RecipientTransferGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersList.json index 7af1664d4fab..d520774686b5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersList.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersList.json @@ -8,34 +8,36 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/transfers/aabb123", "properties": { - "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", "detailedTransferStatus": [ { - "productType": "AzureSubscription", "productId": "subscriptionId", "productName": "Azure subscription 1", + "productType": "AzureSubscription", "skuDescription": "MS-AZR-0017G", "transferStatus": "InProgress" }, { - "productType": "ReservedInstance", "productId": "reservedInstanceId", "productName": "Reservation name", + "productType": "ReservedInstance", "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", "transferStatus": "InProgress" } - ] + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" } } ] } } - } + }, + "operationId": "RecipientTransfers_List", + "title": "RecipientTransfersList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersValidate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersValidate.json index d5d265bcccaa..274b593d0206 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersValidate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/recipientTransfersValidate.json @@ -1,21 +1,21 @@ { "parameters": { "api-version": "2024-04-01", - "transferName": "aabb123", "parameters": { "properties": { "productDetails": [ { - "productType": "AzureSubscription", - "productId": "subscriptionId" + "productId": "subscriptionId", + "productType": "AzureSubscription" }, { - "productType": "AzureReservation", - "productId": "reservedInstanceId" + "productId": "reservedInstanceId", + "productType": "AzureReservation" } ] } - } + }, + "transferName": "aabb123" }, "responses": { "200": { @@ -24,18 +24,20 @@ { "properties": { "productId": "subscriptionId", - "status": "Failed", "results": [ { - "level": "Error", "code": "NotIntendedRecipient", + "level": "Error", "message": "Intended recipient is different." } - ] + ], + "status": "Failed" } } ] } } - } + }, + "operationId": "RecipientTransfers_Validate", + "title": "ValidateTransfer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json index b91f10f7472a..cbe3e75c223e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json @@ -1,49 +1,74 @@ { "parameters": { + "$expand": "renewProperties", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "reservationOrderId": "20000000-0000-0000-0000-000000000000", "reservationId": "30000000-0000-0000-0000-000000000000", - "$expand": "renewProperties" + "reservationOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", - "location": "westus", "etag": 15, - "sku": { - "name": "Standard_DS1_v2" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", "properties": { - "reservedResourceType": "VirtualMachines", - "userFriendlyRenewState": "On", - "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", - "renew": true, - "archived": false, - "quantity": 1, "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", "displayName": "VM_RI_11-24-2021_22-30", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Shared", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "expiryDate": "2024-11-25", "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", - "expiryDate": "2024-11-25", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2021-11-25", - "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", - "instanceFlexibility": "On", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Shared", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "On", "utilization": { - "trend": "SAME", "aggregates": [ { "grain": 1, @@ -58,48 +83,25 @@ "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "productCode": "20000000-0000-0000-0000-000000000005", - "renewProperties": { - "purchaseProperties": { - "sku": { - "name": "Standard_DS1_v2" - }, - "location": "westus", - "properties": { - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "term": "P3Y", - "billingPlan": "Monthly", - "quantity": 1, - "displayName": "VM_RI_11-24-2021_22-30_renewed", - "appliedScopeType": "Shared", - "reservedResourceProperties": { - "instanceFlexibility": "On" - }, - "reservedResourceType": "VirtualMachines", - "instanceFlexibility": "On", - "renew": false - } - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - }, - "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - } + ], + "trend": "SAME" } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json index 8669024ec23d..3efd9881a573 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json @@ -1,118 +1,120 @@ { "parameters": { + "$expand": "renewProperties", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "reservationOrderId": "20000000-0000-0000-0000-000000000000", "reservationId": "30000000-0000-0000-0000-000000000000", - "$expand": "renewProperties" + "reservationOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", - "location": "westus", "etag": 21, - "sku": { - "name": "Standard_DS1_v2" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", "properties": { "appliedScopeProperties": { - "tenantId": "50000000-0000-0000-0000-000000000009", + "displayName": "TestRg", "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", - "displayName": "TestRg" + "tenantId": "50000000-0000-0000-0000-000000000009" }, - "extendedStatusInfo": { - "statusCode": "NoBenefit", - "message": "The subscriptions utilizing the reservation were removed or transferred from this account and no longer receive the reservation benefit. You can cancel the reservation or transfer to the right account or create resources and subscriptions to map it to this reservation." - }, - "reservedResourceType": "VirtualMachines", - "userFriendlyRenewState": "On", - "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", - "renew": true, - "archived": false, - "quantity": 1, "appliedScopeType": "ManagementGroup", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", "displayName": "VM_RI_11-24-2021_22-30", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "NoBenefit", - "userFriendlyAppliedScopeType": "ManagementGroup", + "effectiveDateTime": "2023-01-26T01:19:31.9916066Z", + "expiryDate": "2024-11-25", "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "extendedStatusInfo": { + "message": "The subscriptions utilizing the reservation were removed or transferred from this account and no longer receive the reservation benefit. You can cancel the reservation or transfer to the right account or create resources and subscriptions to map it to this reservation.", + "statusCode": "NoBenefit" + }, + "instanceFlexibility": "On", "lastUpdatedDateTime": "2023-01-26T01:19:32.0697120Z", - "expiryDate": "2024-11-25", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2021-11-25", - "effectiveDateTime": "2023-01-26T01:19:31.9916066Z", - "instanceFlexibility": "On", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeProperties": { + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "50000000-0000-0000-0000-000000000009" + }, + "appliedScopeType": "ManagementGroup", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", + "userFriendlyRenewState": "On", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "productCode": "20000000-0000-0000-0000-000000000005", - "renewProperties": { - "purchaseProperties": { - "sku": { - "name": "Standard_DS1_v2" - }, - "location": "westus", - "properties": { - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "term": "P3Y", - "billingPlan": "Monthly", - "quantity": 1, - "displayName": "VM_RI_11-24-2021_22-30_renewed", - "appliedScopeType": "ManagementGroup", - "reservedResourceProperties": { - "instanceFlexibility": "On" - }, - "reservedResourceType": "VirtualMachines", - "instanceFlexibility": "On", - "renew": false, - "appliedScopeProperties": { - "tenantId": "50000000-0000-0000-0000-000000000009", - "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg" - } - } - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - }, - "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - } + ], + "trend": "SAME" } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccountManagementGroup" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json index b1e70ee940b6..66fed654e178 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json @@ -1,112 +1,114 @@ { "parameters": { + "$expand": "renewProperties", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "reservationOrderId": "20000000-0000-0000-0000-000000000000", "reservationId": "30000000-0000-0000-0000-000000000000", - "$expand": "renewProperties" + "reservationOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", - "location": "westus", "etag": 23, - "sku": { - "name": "Standard_DS1_v2" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", "properties": { "appliedScopeProperties": { - "resourceGroupId": "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915", - "displayName": "fastpathtesting_20210915" + "displayName": "fastpathtesting_20210915", + "resourceGroupId": "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915" }, - "reservedResourceType": "VirtualMachines", - "userFriendlyRenewState": "On", - "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", - "renew": true, - "archived": false, - "quantity": 1, "appliedScopeType": "Single", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", "displayName": "VM_RI_11-24-2021_22-30", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "ResourceGroup", + "effectiveDateTime": "2023-01-26T01:21:47.2936116Z", + "expiryDate": "2024-11-25", "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", "lastUpdatedDateTime": "2023-01-26T01:21:47.3561106Z", - "expiryDate": "2024-11-25", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2021-11-25", - "effectiveDateTime": "2023-01-26T01:21:47.2936116Z", - "instanceFlexibility": "On", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Single", + "appliedScopes": [ + "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915" + ], + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "ResourceGroup", + "userFriendlyRenewState": "On", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "productCode": "20000000-0000-0000-0000-000000000005", - "renewProperties": { - "purchaseProperties": { - "sku": { - "name": "Standard_DS1_v2" - }, - "location": "westus", - "properties": { - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "term": "P3Y", - "billingPlan": "Monthly", - "quantity": 1, - "displayName": "VM_RI_11-24-2021_22-30_renewed", - "appliedScopes": [ - "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915" - ], - "appliedScopeType": "Single", - "reservedResourceProperties": { - "instanceFlexibility": "On" - }, - "reservedResourceType": "VirtualMachines", - "instanceFlexibility": "On", - "renew": false - } - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - }, - "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - } + ], + "trend": "SAME" } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccountSingleResourceGroup" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json index 1b7271d06105..f6fa1a4eb692 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json @@ -1,112 +1,114 @@ { "parameters": { + "$expand": "renewProperties", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "reservationOrderId": "20000000-0000-0000-0000-000000000000", "reservationId": "30000000-0000-0000-0000-000000000000", - "$expand": "renewProperties" + "reservationOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", - "location": "westus", "etag": 19, - "sku": { - "name": "Standard_DS1_v2" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", "properties": { "appliedScopeProperties": { - "subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "displayName": "Azure subscription 1" + "displayName": "Azure subscription 1", + "subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000009" }, - "reservedResourceType": "VirtualMachines", - "userFriendlyRenewState": "On", - "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", - "renew": true, - "archived": false, - "quantity": 1, "appliedScopeType": "Single", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", "displayName": "VM_RI_11-24-2021_22-30", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Single", + "effectiveDateTime": "2023-01-26T01:14:18.558909Z", + "expiryDate": "2024-11-25", "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "instanceFlexibility": "Off", "lastUpdatedDateTime": "2023-01-26T01:14:18.6057756Z", - "expiryDate": "2024-11-25", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2021-11-25", - "effectiveDateTime": "2023-01-26T01:14:18.558909Z", - "instanceFlexibility": "Off", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Single", + "appliedScopes": [ + "/subscriptions/30000000-0000-0000-0000-000000000009" + ], + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "Off", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "Off" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Single", + "userFriendlyRenewState": "On", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "productCode": "20000000-0000-0000-0000-000000000005", - "renewProperties": { - "purchaseProperties": { - "sku": { - "name": "Standard_DS1_v2" - }, - "location": "westus", - "properties": { - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "term": "P3Y", - "billingPlan": "Monthly", - "quantity": 1, - "displayName": "VM_RI_11-24-2021_22-30_renewed", - "appliedScopes": [ - "/subscriptions/30000000-0000-0000-0000-000000000009" - ], - "appliedScopeType": "Single", - "reservedResourceProperties": { - "instanceFlexibility": "Off" - }, - "reservedResourceType": "VirtualMachines", - "instanceFlexibility": "Off", - "renew": false - } - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - }, - "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - } + ], + "trend": "SAME" } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "Reservations_GetByReservationOrder", + "title": "reservationGetByBillingAccountSingleScope" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json index eecfeafaaeed..133dbbc0ecc2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json @@ -7,34 +7,36 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", "name": "20000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders", "etag": 27, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", "properties": { + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "Monthly", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "createdDateTime": "2021-11-25T06:34:13.9736776Z", + "displayName": "VM_RI_11-24-2021_22-30", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", "originalQuantity": 1, + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "requestDateTime": "2021-11-25T06:31:18.3925493Z", - "billingPlan": "Monthly", "reservations": [ { "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" } ], - "term": "P3Y", - "displayName": "VM_RI_11-24-2021_22-30", - "createdDateTime": "2021-11-25T06:34:13.9736776Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", - "provisioningState": "Succeeded", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "productCode": "20000000-0000-0000-0000-000000000005" + "term": "P3Y" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "ReservationOrders_GetByBillingAccount", + "title": "reservationOrderGetByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json index 2ed1a953b092..000022735202 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json @@ -1,409 +1,411 @@ { "parameters": { + "$expand": "schedule", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "reservationOrderId": "20000000-0000-0000-0000-000000000000", - "$expand": "schedule" + "reservationOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", "name": "20000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders", "etag": 26, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", "properties": { - "originalQuantity": 1, - "requestDateTime": "2021-11-25T06:31:18.3925493Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingPlan": "Monthly", - "reservations": [ - { - "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" - } - ], - "term": "P3Y", - "displayName": "VM_RI_11-24-2021_22-30", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", "createdDateTime": "2021-11-25T06:34:13.9736776Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", - "provisioningState": "Succeeded", + "displayName": "VM_RI_11-24-2021_22-30", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "originalQuantity": 1, "planInformation": { + "nextPaymentDueDate": "2023-01-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 + "amount": 715.68, + "currencyCode": "USD" }, "startDate": "2021-11-25", - "nextPaymentDueDate": "2023-01-25", "transactions": [ { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2021-11-25", "paymentDate": "2021-11-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2021-12-25", "paymentDate": "2021-12-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-01-25", "paymentDate": "2022-01-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-02-25", "paymentDate": "2022-02-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-03-25", "paymentDate": "2022-03-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-04-25", "paymentDate": "2022-04-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-05-25", "paymentDate": "2022-05-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-06-25", "paymentDate": "2022-06-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-07-25", "paymentDate": "2022-07-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-08-25", "paymentDate": "2022-08-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-09-25", "paymentDate": "2022-09-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-10-25", "paymentDate": "2022-10-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-11-25", "paymentDate": "2022-11-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { + "billingCurrencyTotal": { + "amount": 19.88, + "currencyCode": "USD" + }, "dueDate": "2022-12-25", "paymentDate": "2022-12-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Completed" }, { "dueDate": "2023-01-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-02-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-03-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-04-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-05-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-06-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-07-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-08-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-09-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-10-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-11-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-12-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-01-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-02-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-03-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-04-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-05-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-06-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-07-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-08-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-09-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-10-25", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 19.88 + "amount": 19.88, + "currencyCode": "USD" }, "status": "Scheduled" } ] }, - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "productCode": "20000000-0000-0000-0000-000000000005" + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "requestDateTime": "2021-11-25T06:31:18.3925493Z", + "reservations": [ + { + "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" + } + ], + "term": "P3Y" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "ReservationOrders_GetByBillingAccount", + "title": "reservationOrderGetByBillingAccountWithExpandPlanInformation" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json index 0e605d2e3c11..c4fd7b0bcb83 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json @@ -8,36 +8,38 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", "name": "20000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders", "etag": 10, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", "properties": { + "benefitStartTime": "2021-08-03T21:26:48.5128969Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "Upfront", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "createdDateTime": "2021-08-03T21:26:50.7784836Z", + "displayName": "SUSE_Plan_08-03-2021_14-22", + "expiryDateTime": "2024-08-03T21:26:48.5128969Z", "originalQuantity": 1, + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "requestDateTime": "2021-08-03T21:23:47.9090964Z", - "billingPlan": "Upfront", "reservations": [ { "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" } ], - "term": "P3Y", - "displayName": "SUSE_Plan_08-03-2021_14-22", - "createdDateTime": "2021-08-03T21:26:50.7784836Z", - "benefitStartTime": "2021-08-03T21:26:48.5128969Z", - "provisioningState": "Succeeded", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "expiryDateTime": "2024-08-03T21:26:48.5128969Z", - "productCode": "20000000-0000-0000-0000-000000000005" + "term": "P3Y" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } ] } } - } + }, + "operationId": "ReservationOrders_ListByBillingAccount", + "title": "reservationOrderListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json index 6f9f5adf1c91..6422ff18d86f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json @@ -2,52 +2,77 @@ "parameters": { "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "reservationOrderId": "20000000-0000-0000-0000-000000000000", - "reservationId": "30000000-0000-0000-0000-000000000000", "body": { "properties": { "displayName": "NewName" } - } + }, + "reservationId": "30000000-0000-0000-0000-000000000000", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", - "location": "westus", "etag": 15, - "sku": { - "name": "Standard_DS1_v2" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "location": "westus", "properties": { - "reservedResourceType": "VirtualMachines", - "userFriendlyRenewState": "On", - "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", - "renew": true, - "archived": false, - "quantity": 1, "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", "displayName": "NewName", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Shared", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "expiryDate": "2024-11-25", "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", - "expiryDate": "2024-11-25", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2021-11-25", - "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", - "instanceFlexibility": "On", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "renewProperties": { + "billingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "pricingCurrencyTotal": { + "amount": 715.68, + "currencyCode": "USD" + }, + "purchaseProperties": { + "location": "westus", + "properties": { + "appliedScopeType": "Shared", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "instanceFlexibility": "On", + "quantity": 1, + "renew": false, + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "term": "P3Y" + }, + "sku": { + "name": "Standard_DS1_v2" + } + } + }, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "On", "utilization": { - "trend": "SAME", "aggregates": [ { "grain": 1, @@ -62,46 +87,21 @@ "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "productCode": "20000000-0000-0000-0000-000000000005", - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "renewProperties": { - "purchaseProperties": { - "sku": { - "name": "Standard_DS1_v2" - }, - "location": "westus", - "properties": { - "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", - "term": "P3Y", - "billingPlan": "Monthly", - "quantity": 1, - "displayName": "VM_RI_11-24-2021_22-30_renewed", - "appliedScopeType": "Shared", - "reservedResourceProperties": { - "instanceFlexibility": "On" - }, - "reservedResourceType": "VirtualMachines", - "instanceFlexibility": "On", - "renew": false - } - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - }, - "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 715.68 - } + ], + "trend": "SAME" } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } }, @@ -112,5 +112,7 @@ "Retry-After": 120 } } - } + }, + "operationId": "Reservations_UpdateByBillingAccount", + "title": "ReservationUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json index b3f4cdd4ef15..df794e93133b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json @@ -9,41 +9,36 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/4973e1de-a829-5c64-4fef-0a692e2b3108:1970c5da-0aa4-46fd-a917-4772f9a17978_2019-05-31/reservationOrders/99f340d1-6db4-41b4-b469-cfc499716973/reservations/a7d70646-b848-4498-8093-5938128b225c", "name": "a7d70646-b848-4498-8093-5938128b225c", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", - "location": "westus", "etag": 15, - "sku": { - "name": "Standard_DS1_v2" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/4973e1de-a829-5c64-4fef-0a692e2b3108:1970c5da-0aa4-46fd-a917-4772f9a17978_2019-05-31/reservationOrders/99f340d1-6db4-41b4-b469-cfc499716973/reservations/a7d70646-b848-4498-8093-5938128b225c", + "location": "westus", "properties": { - "reservedResourceType": "VirtualMachines", - "userFriendlyRenewState": "On", - "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", - "renew": true, - "archived": false, - "quantity": 1, "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", "displayName": "VM_RI_11-24-2021_22-30", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Shared", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "expiryDate": "2024-11-25", "expiryDateTime": "2024-11-25T06:34:12.9266987Z", - "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", - "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "instanceFlexibility": "On", "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", - "expiryDate": "2024-11-25", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2021-11-25", - "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", - "instanceFlexibility": "On", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "quantity": 1, + "renew": true, + "reservedResourceType": "VirtualMachines", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "On", "utilization": { - "trend": "SAME", "aggregates": [ { "grain": 1, @@ -58,20 +53,27 @@ "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", - "productCode": "20000000-0000-0000-0000-000000000005" + ], + "trend": "SAME" + } + }, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } ] } } - } + }, + "operationId": "Reservations_ListByReservationOrder", + "title": "reservationsGetFromOrderByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json index 106f7d43b81e..cd1aa66e6d3f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json @@ -1,51 +1,58 @@ { "parameters": { - "api-version": "2024-04-01", - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "$filter": "properties/reservedResourceType eq 'VirtualMachineSoftware' and properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA'", "$orderby": "properties/userFriendlyAppliedScopeType asc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "refreshsummary": "true", "selectedState": "Succeeded" }, "responses": { "200": { "body": { + "nextLink": null, + "summary": { + "cancelledCount": 0, + "expiredCount": 0, + "expiringCount": 0, + "failedCount": 0, + "noBenefitCount": 0, + "pendingCount": 0, + "processingCount": 0, + "succeededCount": 1, + "warningCount": 0 + }, "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", "location": "global", - "sku": { - "name": "mock_sku" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, "properties": { - "reservedResourceType": "VirtualMachineSoftware", - "userFriendlyRenewState": "Off", - "skuDescription": "Sku description", - "renew": false, - "archived": false, - "quantity": 1, "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", "displayName": "VirtualMachineSoftware_01-18-2022_13-51", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Shared", + "effectiveDateTime": "0001-01-01T00:00:00Z", + "expiryDate": "2025-01-18", "expiryDateTime": "2025-01-18T21:54:31.0741034Z", - "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", - "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "instanceFlexibility": "On", "lastUpdatedDateTime": "0001-01-01T00:00:00.0000000", - "expiryDate": "2025-01-18", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2022-01-18", - "effectiveDateTime": "0001-01-01T00:00:00Z", - "instanceFlexibility": "On", + "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", + "quantity": 1, + "renew": false, + "reservedResourceType": "VirtualMachineSoftware", + "skuDescription": "Sku description", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "Off", "utilization": { - "trend": "SAME", "aggregates": [ { "grain": 1, @@ -60,32 +67,27 @@ "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", - "productCode": "20000000-0000-0000-0000-000000000005" + ], + "trend": "SAME" + } + }, + "sku": { + "name": "mock_sku" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } - ], - "summary": { - "noBenefitCount": 0, - "warningCount": 0, - "succeededCount": 1, - "failedCount": 0, - "expiringCount": 0, - "expiredCount": 0, - "pendingCount": 0, - "cancelledCount": 0, - "processingCount": 0 - }, - "nextLink": null + ] } } - } + }, + "operationId": "Reservations_ListByBillingAccount", + "title": "reservationsListByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json index cd8277578734..4996fa1842a8 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json @@ -1,52 +1,59 @@ { "parameters": { + "$filter": "properties/reservedResourceType eq 'VirtualMachineSoftware'", + "$orderby": "properties/userFriendlyAppliedScopeType asc", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "AAAA-AAAA-AAA-AAA", - "$filter": "properties/reservedResourceType eq 'VirtualMachineSoftware'", - "$orderby": "properties/userFriendlyAppliedScopeType asc", "refreshsummary": "true", "selectedState": "Succeeded" }, "responses": { "200": { "body": { + "nextLink": null, + "summary": { + "cancelledCount": 0, + "expiredCount": 0, + "expiringCount": 0, + "failedCount": 0, + "noBenefitCount": 0, + "pendingCount": 0, + "processingCount": 0, + "succeededCount": 1, + "warningCount": 0 + }, "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", "location": "global", - "sku": { - "name": "mock_sku" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, "properties": { - "reservedResourceType": "VirtualMachineSoftware", - "userFriendlyRenewState": "Off", - "skuDescription": "Sku description", - "renew": false, - "archived": false, - "quantity": 1, "appliedScopeType": "Shared", + "archived": false, + "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", "displayName": "VirtualMachineSoftware_01-18-2022_13-51", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Shared", + "effectiveDateTime": "0001-01-01T00:00:00Z", + "expiryDate": "2025-01-18", "expiryDateTime": "2025-01-18T21:54:31.0741034Z", - "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", - "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "instanceFlexibility": "On", "lastUpdatedDateTime": "0001-01-01T00:00:00.0000000", - "expiryDate": "2025-01-18", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDate": "2022-01-18", - "effectiveDateTime": "0001-01-01T00:00:00Z", - "instanceFlexibility": "On", + "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", + "quantity": 1, + "renew": false, + "reservedResourceType": "VirtualMachineSoftware", + "skuDescription": "Sku description", + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", + "userFriendlyRenewState": "Off", "utilization": { - "trend": "SAME", "aggregates": [ { "grain": 1, @@ -61,32 +68,27 @@ "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", "value": 0, "valueUnit": "percentage" } - ] - }, - "billingPlan": "Monthly", - "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", - "productCode": "20000000-0000-0000-0000-000000000005" + ], + "trend": "SAME" + } + }, + "sku": { + "name": "mock_sku" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } - ], - "summary": { - "noBenefitCount": 0, - "warningCount": 0, - "succeededCount": 1, - "failedCount": 0, - "expiringCount": 0, - "expiredCount": 0, - "pendingCount": 0, - "cancelledCount": 0, - "processingCount": 0 - }, - "nextLink": null + ] } } - } + }, + "operationId": "Reservations_ListByBillingProfile", + "title": "ReservationsListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json index 531994f2ced4..db7ea4bc75d5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json @@ -8,32 +8,32 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + } } ] } @@ -44,5 +44,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_ResolveByBillingAccount", + "title": "ResolveBillingRoleAssignmentByBillingAccount" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json index 00d296990c67..428ab7756d75 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json @@ -9,32 +9,32 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx" + } } ] } @@ -45,5 +45,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_ResolveByBillingProfile", + "title": "ResolveBillingRoleAssignmentByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json index ce4029b87bcf..38425a32ec60 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json @@ -10,38 +10,38 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "c360d6f1-2709-476d-81bb-d075b213d9fc", + "principalTenantName": "Foo Bar", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", - "userEmailAddress": "foo@bar.com", - "principalTenantName": "Foo Bar", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + "userEmailAddress": "foo@bar.com" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", "principalTenantId": "c360d6f1-2709-476d-81bb-d075b213d9fc", + "principalTenantName": "Foo Bar", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", - "userEmailAddress": "foo@bar.com", - "principalTenantName": "Foo Bar", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + "userEmailAddress": "foo@bar.com" + } } ] } @@ -52,5 +52,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_ResolveByCustomer", + "title": "ResolveBillingRoleAssignmentByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json index 7561321c3cad..0ea5110510cd 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json @@ -10,32 +10,32 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", "properties": { - "createdOn": "2023-10-19T20:10:50.1028398Z", - "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdOn": "2023-10-19T20:10:50.1028398Z", "principalId": "00000000-0000-0000-0000-000000000000", + "principalType": "User", "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", - "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", - "principalType": "User" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx" + } } ] } @@ -46,5 +46,7 @@ "retry-after": "5" } } - } + }, + "operationId": "BillingRoleAssignments_ResolveByInvoiceSection", + "title": "ResolveBillingRoleAssignmentByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json index f795f7965c06..5de5877a9ef2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json @@ -1,75 +1,77 @@ { "parameters": { + "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", "savingsPlanId": "30000000-0000-0000-0000-000000000000", - "api-version": "2024-04-01" + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", - "sku": { - "name": "Compute_Savings_Plan" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "properties": { - "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", "appliedScopeProperties": { - "tenantId": "70000000-0000-0000-0000-000000000000", + "displayName": "TestRg", "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", - "displayName": "TestRg" + "tenantId": "70000000-0000-0000-0000-000000000000" }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2022-11-16T02:25:11.7183866Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 0.001, "currencyCode": "USD", - "amount": 0.001 + "grain": "Hourly" }, - "renew": false, - "appliedScopeType": "ManagementGroup", "displayName": "SP1", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "NoBenefit", - "userFriendlyAppliedScopeType": "ManagementGroup", + "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", "expiryDateTime": "2025-11-16T02:25:11.7183866Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDateTime": "2022-11-16T02:23:21.3864783Z", - "benefitStartTime": "2022-11-16T02:25:11.7183866Z", - "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", + "renew": false, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" } - ] + ], + "trend": "SAME" } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "SavingsPlans_GetByBillingAccount", + "title": "SavingsPlanGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json index ff7f0a7116dd..b9801fd6aa7e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json @@ -1,99 +1,101 @@ { "parameters": { + "$expand": "renewProperties", + "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", "savingsPlanId": "30000000-0000-0000-0000-000000000000", - "api-version": "2024-04-01", - "$expand": "renewProperties" + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", - "sku": { - "name": "Compute_Savings_Plan" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "properties": { - "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", "appliedScopeProperties": { - "tenantId": "70000000-0000-0000-0000-000000000000", + "displayName": "TestRg", "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", - "displayName": "TestRg" + "tenantId": "70000000-0000-0000-0000-000000000000" }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2022-11-16T02:25:11.7183866Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 0.001, "currencyCode": "USD", - "amount": 0.001 + "grain": "Hourly" }, - "renew": false, - "appliedScopeType": "ManagementGroup", "displayName": "SP1", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "NoBenefit", - "userFriendlyAppliedScopeType": "ManagementGroup", + "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", "expiryDateTime": "2025-11-16T02:25:11.7183866Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDateTime": "2022-11-16T02:23:21.3864783Z", - "benefitStartTime": "2022-11-16T02:25:11.7183866Z", - "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", + "renew": false, + "renewProperties": { + "purchaseProperties": { + "properties": { + "appliedScopeProperties": { + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "tenantId": "70000000-0000-0000-0000-000000000000" + }, + "appliedScopeType": "ManagementGroup", + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "commitment": { + "amount": 0.001, + "currencyCode": "USD", + "grain": "Hourly" + }, + "displayName": "SP1_renewed", + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" + } + } + }, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" } - ] - }, - "renewProperties": { - "purchaseProperties": { - "sku": { - "name": "Compute_Savings_Plan" - }, - "properties": { - "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", - "term": "P3Y", - "billingPlan": "Monthly", - "displayName": "SP1_renewed", - "appliedScopeType": "ManagementGroup", - "appliedScopeProperties": { - "tenantId": "70000000-0000-0000-0000-000000000000", - "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg" - }, - "commitment": { - "grain": "Hourly", - "currencyCode": "USD", - "amount": 0.001 - } - } - } + ], + "trend": "SAME" } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } } - } + }, + "operationId": "SavingsPlans_GetByBillingAccount", + "title": "SavingsPlanGetExpandRenewProperties" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json index 19bb5664a9d2..3052121a97fc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json @@ -1,333 +1,333 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "$expand": "schedule", "api-version": "2024-04-01", - "$expand": "schedule" + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", "name": "20000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", "properties": { - "billingScopeId": "10000000-0000-0000-0000-000000000000", - "savingsPlans": [ - "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" - ], - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", - "term": "P3Y", - "displayName": "SP1", "benefitStartTime": "2023-01-20T02:36:22.3394755Z", - "provisioningState": "Succeeded", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP1", "expiryDateTime": "2026-01-20T02:36:22.3394755Z", "planInformation": { + "nextPaymentDueDate": "2023-02-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 26.28 + "amount": 26.28, + "currencyCode": "USD" }, "startDate": "2023-01-20", - "nextPaymentDueDate": "2023-02-20", "transactions": [ { + "billingCurrencyTotal": { + "amount": 0.73, + "currencyCode": "USD" + }, "dueDate": "2023-01-20", "paymentDate": "2023-01-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 - }, - "billingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Completed" }, { "dueDate": "2023-02-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-03-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-04-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-05-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-06-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-07-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-08-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-09-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-10-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-11-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2023-12-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-01-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-02-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-03-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-04-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-05-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-06-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-07-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-08-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-09-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-10-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-11-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2024-12-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-01-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-02-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-03-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-04-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-05-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-06-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-07-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-08-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-09-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-10-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-11-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" }, { "dueDate": "2025-12-20", "pricingCurrencyTotal": { - "currencyCode": "USD", - "amount": 0.73 + "amount": 0.73, + "currencyCode": "USD" }, "status": "Scheduled" } ] - } + }, + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" + ], + "term": "P3Y" }, "sku": { "name": "Compute_Savings_Plan" @@ -338,5 +338,7 @@ } } } - } + }, + "operationId": "SavingsPlanOrders_GetByBillingAccount", + "title": "SavingsPlanOrderWithExpandedPaymentsGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json index 53ace62c439a..c14582949bf4 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json @@ -1,29 +1,29 @@ { "parameters": { + "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", - "api-version": "2024-04-01" + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", "name": "20000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", "properties": { + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP1", + "expiryDateTime": "2026-01-20T02:36:22.3394755Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "savingsPlans": [ "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" ], - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", - "term": "P3Y", - "displayName": "SP1", - "benefitStartTime": "2023-01-20T02:36:22.3394755Z", - "provisioningState": "Succeeded", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "expiryDateTime": "2026-01-20T02:36:22.3394755Z" + "term": "P3Y" }, "sku": { "name": "Compute_Savings_Plan" @@ -34,5 +34,7 @@ } } } - } + }, + "operationId": "SavingsPlanOrders_GetByBillingAccount", + "title": "SavingsPlanOrderGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json index 01cf057c2560..6c08b5c6ab70 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json @@ -1,32 +1,32 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "api-version": "2024-04-01", "$filter": "properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD'", - "$orderby": "properties/displayName asc" + "$orderby": "properties/displayName asc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", "name": "20000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", "properties": { + "benefitStartTime": "2023-02-04T03:18:31.3072635Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP1", + "expiryDateTime": "2026-02-04T03:18:31.3072635Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "savingsPlans": [ "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" ], - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", - "term": "P3Y", - "displayName": "SP1", - "benefitStartTime": "2023-02-04T03:18:31.3072635Z", - "provisioningState": "Succeeded", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "expiryDateTime": "2026-02-04T03:18:31.3072635Z" + "term": "P3Y" }, "sku": { "name": "Compute_Savings_Plan" @@ -37,23 +37,23 @@ } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001", "name": "20000000-0000-0000-0000-000000000001", "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001", "properties": { + "benefitStartTime": "2023-02-04T03:22:19.7304330Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", "billingScopeId": "10000000-0000-0000-0000-000000000000", + "displayName": "SP2", + "expiryDateTime": "2026-02-04T03:22:19.7304330Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "savingsPlans": [ "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001" ], - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", - "term": "P3Y", - "displayName": "SP2", - "benefitStartTime": "2023-02-04T03:22:19.7304330Z", - "provisioningState": "Succeeded", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "expiryDateTime": "2026-02-04T03:22:19.7304330Z" + "term": "P3Y" }, "sku": { "name": "Compute_Savings_Plan" @@ -66,5 +66,7 @@ ] } } - } + }, + "operationId": "SavingsPlanOrders_ListByBillingAccount", + "title": "SavingsPlanOrderList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json index 9cb852ef892b..95c82013e2dc 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json @@ -1,87 +1,87 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", - "savingsPlanId": "30000000-0000-0000-0000-000000000000", "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "body": { "properties": { - "displayName": "sp_newName", - "appliedScopeType": "ManagementGroup", "appliedScopeProperties": { - "tenantId": "80000000-0000-0000-0000-000000000000", - "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1" + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1", + "tenantId": "80000000-0000-0000-0000-000000000000" }, + "appliedScopeType": "ManagementGroup", + "displayName": "sp_newName", "renew": true, "renewProperties": { "purchaseProperties": { - "sku": { - "name": "Compute_Savings_Plan" - }, "properties": { - "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", - "term": "P3Y", - "appliedScopeType": "ManagementGroup", "appliedScopeProperties": { - "tenantId": "80000000-0000-0000-0000-000000000000", - "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1" + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1", + "tenantId": "80000000-0000-0000-0000-000000000000" }, - "displayName": "sp_newName_renewed", + "appliedScopeType": "ManagementGroup", "billingPlan": "P1M", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 0.001, "currencyCode": "USD", - "amount": 0.001 - } + "grain": "Hourly" + }, + "displayName": "sp_newName_renewed", + "term": "P3Y" + }, + "sku": { + "name": "Compute_Savings_Plan" } } } } - } + }, + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", - "sku": { - "name": "Compute_Savings_Plan" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "properties": { - "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", "appliedScopeProperties": { - "tenantId": "80000000-0000-0000-0000-000000000000", + "displayName": "mg1", "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1", - "displayName": "mg1" + "tenantId": "80000000-0000-0000-0000-000000000000" }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2023-02-04T03:18:31.3072635Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 0.001, "currencyCode": "USD", - "amount": 0.001 + "grain": "Hourly" }, - "renew": true, - "appliedScopeType": "ManagementGroup", "displayName": "sp_newName", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "ManagementGroup", + "effectiveDateTime": "2023-02-04T04:30:49.1982989Z", "expiryDateTime": "2026-02-04T03:18:31.3072635Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDateTime": "2023-02-04T03:16:38.9065505Z", - "benefitStartTime": "2023-02-04T03:18:31.3072635Z", - "effectiveDateTime": "2023-02-04T04:30:49.1982989Z", + "renew": true, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ManagementGroup", "utilization": { "aggregates": [] } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } }, @@ -92,5 +92,7 @@ "Retry-After": 120 } } - } + }, + "operationId": "SavingsPlans_UpdateByBillingAccount", + "title": "SavingsPlanUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json index 6722c9f82a1a..8c3893ecb261 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json @@ -1,19 +1,19 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", - "savingsPlanId": "30000000-0000-0000-0000-000000000000", "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "body": { "benefits": [ { - "appliedScopeType": "Single", "appliedScopeProperties": { "subscriptionId": "/subscriptions/50000000-0000-0000-0000-000000000000" - } + }, + "appliedScopeType": "Single" } ] - } + }, + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -25,5 +25,7 @@ ] } } - } + }, + "operationId": "SavingsPlans_ValidateUpdateByBillingAccount", + "title": "SavingsPlanValidateUpdate" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json index 9c2e583b6b4b..41bd8ffb8e75 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json @@ -1,9 +1,9 @@ { "parameters": { - "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "api-version": "2024-04-01", "$filter": "properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD'", "$orderby": "properties/displayName asc", + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "refreshSummary": "true", "selectedState": "Succeeded", "take": "3" @@ -11,265 +11,267 @@ "responses": { "200": { "body": { + "summary": { + "cancelledCount": 0, + "expiredCount": 0, + "expiringCount": 0, + "failedCount": 0, + "noBenefitCount": 0, + "pendingCount": 0, + "processingCount": 0, + "succeededCount": 3, + "warningCount": 0 + }, "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", - "sku": { - "name": "Compute_Savings_Plan" - }, - "tags": { - "key1": "value1", - "key2": "value2" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "properties": { - "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "appliedScopeType": "Shared", + "benefitStartTime": "2022-12-16T02:17:03.7396152Z", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 10, "currencyCode": "USD", - "amount": 10.0 + "grain": "Hourly" }, - "renew": false, - "appliedScopeType": "Shared", "displayName": "SP1", - "provisioningState": "Succeeded", - "term": "P1Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Shared", + "effectiveDateTime": "2022-12-16T02:17:04.9896661Z", "expiryDateTime": "2023-12-16T02:17:03.7396152Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDateTime": "2022-12-16T02:14:58.2304134Z", - "benefitStartTime": "2022-12-16T02:17:03.7396152Z", - "effectiveDateTime": "2022-12-16T02:17:04.9896661Z", + "renew": false, + "term": "P1Y", + "userFriendlyAppliedScopeType": "Shared", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" } - ] + ], + "trend": "SAME" } - } - }, - { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001", - "name": "30000000-0000-0000-0000-000000000001", - "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + }, "sku": { "name": "Compute_Savings_Plan" }, "tags": { "key1": "value1", "key2": "value2" - }, + } + }, + { + "name": "30000000-0000-0000-0000-000000000001", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001", "properties": { - "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", "appliedScopeProperties": { - "tenantId": "50000000-0000-0000-0000-000000000000", + "displayName": "TestRg", "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", - "displayName": "TestRg" + "tenantId": "50000000-0000-0000-0000-000000000000" }, + "appliedScopeType": "ManagementGroup", + "benefitStartTime": "2022-12-16T02:22:22.7254795Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 10, "currencyCode": "USD", - "amount": 10.0 + "grain": "Hourly" }, - "renew": false, - "appliedScopeType": "ManagementGroup", "displayName": "SP2", - "provisioningState": "Succeeded", - "term": "P1Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "ManagementGroup", + "effectiveDateTime": "2022-12-16T02:22:24.5536191Z", "expiryDateTime": "2023-12-16T02:22:22.7254795Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDateTime": "2022-12-16T02:20:23.4733076Z", - "benefitStartTime": "2022-12-16T02:22:22.7254795Z", - "effectiveDateTime": "2022-12-16T02:22:24.5536191Z", + "renew": false, + "term": "P1Y", + "userFriendlyAppliedScopeType": "ManagementGroup", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 0.0, + "value": 0, "valueUnit": "percentage" } - ] + ], + "trend": "SAME" } - } - }, - { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002", - "name": "30000000-0000-0000-0000-000000000002", - "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + }, "sku": { "name": "Compute_Savings_Plan" }, "tags": { "key1": "value1", "key2": "value2" - }, + } + }, + { + "name": "30000000-0000-0000-0000-000000000002", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002", "properties": { - "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", "appliedScopeProperties": { - "subscriptionId": "/subscriptions/10000000-0000-0000-0000-000000000000", - "displayName": "Azure subscription 1" + "displayName": "Azure subscription 1", + "subscriptionId": "/subscriptions/10000000-0000-0000-0000-000000000000" }, + "appliedScopeType": "Single", + "benefitStartTime": "2022-10-14T21:18:55.2960613Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 0.025, "currencyCode": "USD", - "amount": 0.025 + "grain": "Hourly" }, - "renew": true, - "appliedScopeType": "Single", "displayName": "SP3", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Single", + "effectiveDateTime": "2022-11-07T23:54:43.8233243Z", "expiryDateTime": "2025-10-14T21:18:55.2960613Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDateTime": "2022-10-14T21:16:57.2347688Z", - "benefitStartTime": "2022-10-14T21:18:55.2960613Z", - "effectiveDateTime": "2022-11-07T23:54:43.8233243Z", + "renew": true, + "term": "P3Y", + "userFriendlyAppliedScopeType": "Single", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 66.0, + "value": 66, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 66.0, + "value": 66, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", "value": 65.52, "valueUnit": "percentage" } - ] + ], + "trend": "SAME" } - } - }, - { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003", - "name": "30000000-0000-0000-0000-000000000003", - "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + }, "sku": { "name": "Compute_Savings_Plan" }, "tags": { "key1": "value1", "key2": "value2" - }, + } + }, + { + "name": "30000000-0000-0000-0000-000000000003", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003", "properties": { - "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", - "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", - "billingPlan": "P1M", - "productCode": "20000000-0000-0000-0000-000000000005", "appliedScopeProperties": { - "resourceGroupId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG", - "displayName": "testRG" + "displayName": "testRG", + "resourceGroupId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG" }, + "appliedScopeType": "Single", + "benefitStartTime": "2022-11-08T00:00:06.3636747Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 0.001, "currencyCode": "USD", - "amount": 0.001 + "grain": "Hourly" }, - "renew": false, - "appliedScopeType": "Single", "displayName": "SP4", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "ResourceGroup", + "effectiveDateTime": "2022-11-30T21:18:12.1967323Z", "expiryDateTime": "2025-11-08T00:00:06.3636747Z", + "productCode": "20000000-0000-0000-0000-000000000005", + "provisioningState": "Succeeded", "purchaseDateTime": "2022-11-07T23:57:58.2428677Z", - "benefitStartTime": "2022-11-08T00:00:06.3636747Z", - "effectiveDateTime": "2022-11-30T21:18:12.1967323Z", + "renew": false, + "term": "P3Y", + "userFriendlyAppliedScopeType": "ResourceGroup", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", - "value": 100.0, + "value": 100, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", - "value": 100.0, + "value": 100, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", - "value": 100.0, + "value": 100, "valueUnit": "percentage" } - ] + ], + "trend": "SAME" } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" } } - ], - "summary": { - "noBenefitCount": 0, - "warningCount": 0, - "succeededCount": 3, - "failedCount": 0, - "expiringCount": 0, - "expiredCount": 0, - "pendingCount": 0, - "cancelledCount": 0, - "processingCount": 0 - } + ] } } - } + }, + "operationId": "SavingsPlans_ListByBillingAccount", + "title": "SavingsPlansList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json index 1652634e61b3..6a94ca08ab21 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json @@ -1,68 +1,70 @@ { "parameters": { + "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", - "api-version": "2024-04-01" + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "name": "30000000-0000-0000-0000-000000000000", "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", - "sku": { - "name": "Compute_Savings_Plan" - }, + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", "properties": { - "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "appliedScopeType": "Shared", + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", - "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", "billingPlan": "P1M", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", "commitment": { - "grain": "Hourly", + "amount": 0.001, "currencyCode": "USD", - "amount": 0.001 + "grain": "Hourly" }, - "renew": false, - "appliedScopeType": "Shared", "displayName": "SP1", - "provisioningState": "Succeeded", - "term": "P3Y", "displayProvisioningState": "Succeeded", - "userFriendlyAppliedScopeType": "Shared", + "effectiveDateTime": "2023-01-20T02:36:25.0894669Z", "expiryDateTime": "2026-01-20T02:36:22.3394755Z", + "provisioningState": "Succeeded", "purchaseDateTime": "2023-01-20T02:34:38.1261695Z", - "benefitStartTime": "2023-01-20T02:36:22.3394755Z", - "effectiveDateTime": "2023-01-20T02:36:25.0894669Z", + "renew": false, + "term": "P3Y", + "userFriendlyAppliedScopeType": "Shared", "utilization": { - "trend": "SAME", "aggregates": [ { - "grain": 1.0, + "grain": 1, "grainUnit": "days", "value": 0, "valueUnit": "percentage" }, { - "grain": 7.0, + "grain": 7, "grainUnit": "days", "value": 0, "valueUnit": "percentage" }, { - "grain": 30.0, + "grain": 30, "grainUnit": "days", "value": 0, "valueUnit": "percentage" } - ] + ], + "trend": "SAME" } + }, + "sku": { + "name": "Compute_Savings_Plan" } } ] } } - } + }, + "operationId": "SavingsPlans_ListBySavingsPlanOrder", + "title": "SavingsPlansInOrderList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json index 127cd89f036c..e8a13d48735e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json @@ -15,5 +15,7 @@ "total": 5400 } } - } + }, + "operationId": "Transactions_GetTransactionSummaryByInvoice", + "title": "TransactionSummaryGetByInvoice" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json index f10fbe0fe886..432ca7dc39f5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json @@ -17,5 +17,7 @@ "Retry-After": "10" } } - } + }, + "operationId": "Transactions_TransactionsDownloadByInvoice", + "title": "TransactionsDownloadByInvoice" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json index e206a7ddca28..78e8d1dee2cf 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json @@ -1,22 +1,23 @@ { "parameters": { + "type": "Billed", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "xxxx-xxxx-xxx-xxx", - "periodStartDate": "2024-04-01", - "periodEndDate": "2023-05-30", - "type": "Billed", - "search": "storage", "filter": "properties/date gt '2020-10-01'", - "orderby": "properties/date" + "orderby": "properties/date", + "periodEndDate": "2023-05-30", + "periodStartDate": "2024-04-01", + "search": "storage" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -48,11 +49,11 @@ "pricingCurrency": "USD", "productDescription": "Standard D1, US West 3", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 4500 @@ -66,15 +67,15 @@ "value": 5000 }, "transactionType": "Purchase", - "units": 11.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 11.25 + } }, { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -105,11 +106,11 @@ "pricingCurrency": "USD", "productDescription": "Standard Support", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 45 @@ -123,14 +124,15 @@ "value": 50 }, "transactionType": "Cancel", - "units": 1.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 1.25 + } } ] } } - } + }, + "operationId": "Transactions_ListByBillingProfile", + "title": "TransactionsListByBillingProfile" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByCustomer.json index 57d8b1951da8..9f971fd6c7c0 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByCustomer.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByCustomer.json @@ -1,23 +1,24 @@ { "parameters": { + "type": "Billed", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "xxxx-xxxx-xxx-xxx", "customerName": "22000000-0000-0000-0000-000000000000", - "periodStartDate": "2024-04-01", - "periodEndDate": "2023-05-30", - "type": "Billed", - "search": "storage", "filter": "properties/date gt '2020-10-01'", - "orderby": "properties/date" + "orderby": "properties/date", + "periodEndDate": "2023-05-30", + "periodStartDate": "2024-04-01", + "search": "storage" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -49,11 +50,11 @@ "pricingCurrency": "USD", "productDescription": "Standard D1, US West 3", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 4500 @@ -67,15 +68,15 @@ "value": 5000 }, "transactionType": "Purchase", - "units": 11.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 11.25 + } }, { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -106,11 +107,11 @@ "pricingCurrency": "USD", "productDescription": "Standard Support", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 45 @@ -124,14 +125,15 @@ "value": 50 }, "transactionType": "Cancel", - "units": 1.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 1.25 + } } ] } } - } + }, + "operationId": "Transactions_ListByCustomer", + "title": "TransactionsListByCustomer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoice.json index 824555238153..f326874a02bd 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoice.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoice.json @@ -9,8 +9,9 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -42,11 +43,11 @@ "pricingCurrency": "USD", "productDescription": "Standard D1, US West 3", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 4500 @@ -60,15 +61,15 @@ "value": 5000 }, "transactionType": "Purchase", - "units": 11.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 11.25 + } }, { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -99,11 +100,11 @@ "pricingCurrency": "USD", "productDescription": "Standard Support", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 45 @@ -117,14 +118,15 @@ "value": 50 }, "transactionType": "Cancel", - "units": 1.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 1.25 + } } ] } } - } + }, + "operationId": "Transactions_ListByInvoice", + "title": "TransactionsListByInvoice" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json index 875c344770c5..098d1266cdae 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json @@ -1,23 +1,24 @@ { "parameters": { + "type": "Billed", "api-version": "2024-04-01", "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "xxxx-xxxx-xxx-xxx", + "filter": "properties/date gt '2020-10-01'", "invoiceSectionName": "22000000-0000-0000-0000-000000000000", - "periodStartDate": "2024-04-01", + "orderby": "properties/date", "periodEndDate": "2023-05-30", - "type": "Billed", - "search": "storage", - "filter": "properties/date gt '2020-10-01'", - "orderby": "properties/date" + "periodStartDate": "2024-04-01", + "search": "storage" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -49,11 +50,11 @@ "pricingCurrency": "USD", "productDescription": "Standard D1, US West 3", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 4500 @@ -67,15 +68,15 @@ "value": 5000 }, "transactionType": "Purchase", - "units": 11.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 11.25 + } }, { - "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions", + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", "properties": { "azureCreditApplied": { "currency": "USD", @@ -106,11 +107,11 @@ "pricingCurrency": "USD", "productDescription": "Standard Support", "productFamily": "Storage", - "productTypeId": "A12345", "productType": "VM Instance", + "productTypeId": "A12345", "quantity": 1, - "servicePeriodStartDate": "2023-05-01T00:00:00Z", "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "servicePeriodStartDate": "2023-05-01T00:00:00Z", "subTotal": { "currency": "USD", "value": 45 @@ -124,14 +125,15 @@ "value": 50 }, "transactionType": "Cancel", - "units": 1.25, "unitOfMeasure": "1 Minute", - "unitType": "1 Runtime Minute" - }, - "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + "unitType": "1 Runtime Minute", + "units": 1.25 + } } ] } } - } + }, + "operationId": "Transactions_ListByInvoiceSection", + "title": "TransactionsListByInvoiceSection" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersCancel.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersCancel.json index a78c7887a783..99f39d511ec3 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersCancel.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersCancel.json @@ -9,17 +9,19 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "properties": { + "canceledBy": "user@contoso.com", "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "Pending", - "recipientEmailId": "user@contoso.com", "initiatorEmailId": "xyz@contoso.com", - "canceledBy": "user@contoso.com" + "recipientEmailId": "user@contoso.com", + "transferStatus": "Pending" } } } - } + }, + "operationId": "Transfers_Cancel", + "title": "TransferCancel" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersGet.json index 20cccff9e83f..545e6330836a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersGet.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersGet.json @@ -9,32 +9,34 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "properties": { - "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", "detailedTransferStatus": [ { - "productType": "AzureSubscription", "productId": "subscriptionId", "productName": "Azure subscription 1", + "productType": "AzureSubscription", "skuDescription": "MS-AZR-0017G", "transferStatus": "InProgress" }, { - "productType": "AzureReservation", "productId": "reservedInstanceId", "productName": "Reservation name", + "productType": "AzureReservation", "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", "transferStatus": "InProgress" } - ] + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" } } } - } + }, + "operationId": "Transfers_Get", + "title": "TransferGet" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersInitiate.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersInitiate.json index 1930692f02f3..3ff6ccdda827 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersInitiate.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersInitiate.json @@ -4,39 +4,41 @@ "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "billingProfileName": "xxxx-xxxx-xxx-xxx", "invoiceSectionName": "yyyy-yyyy-yyy-yyy", - "transferName": "aabb123", "parameters": { "properties": { "recipientEmailId": "user@contoso.com" } - } + }, + "transferName": "aabb123" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "properties": { "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "Pending", + "initiatorEmailId": "xyz@contoso.com", "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com" + "transferStatus": "Pending" } } }, "201": { "body": { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "properties": { "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "Pending", + "initiatorEmailId": "xyz@contoso.com", "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com" + "transferStatus": "Pending" } } } - } + }, + "operationId": "Transfers_Initiate", + "title": "InitiateTransfer" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersList.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersList.json index e51e11fb24bf..b2ad4f7cd05f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersList.json +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/examples/transfersList.json @@ -10,34 +10,36 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "name": "aabb123", "type": "Microsoft.Billing/transfers", + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", "properties": { - "expirationTime": "2018-11-05T17:32:28Z", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "xyz@contoso.com", "detailedTransferStatus": [ { - "productType": "AzureSubscription", "productId": "subscriptionId", "productName": "Azure subscription 1", + "productType": "AzureSubscription", "skuDescription": "MS-AZR-0017G", "transferStatus": "InProgress" }, { - "productType": "AzureReservation", "productId": "reservedInstanceId", "productName": "Reservation name", + "productType": "AzureReservation", "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", "transferStatus": "InProgress" } - ] + ], + "expirationTime": "2018-11-05T17:32:28Z", + "initiatorEmailId": "xyz@contoso.com", + "recipientEmailId": "user@contoso.com", + "transferStatus": "InProgress" } } ] } } - } + }, + "operationId": "Transfers_List", + "title": "TransfersList" } diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/invoice.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/invoice.json deleted file mode 100644 index 0323b065a282..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/invoice.json +++ /dev/null @@ -1,1364 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices": { - "get": { - "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/" - }, - "operationId": "Invoices_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "in": "query", - "name": "periodStartDate", - "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "periodEndDate", - "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", - "type": "string", - "format": "date" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of invoices.", - "schema": { - "$ref": "#/definitions/InvoiceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/downloadDocuments": { - "post": { - "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/" - }, - "operationId": "Invoices_DownloadDocumentsByBillingAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A list of download details for individual documents.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/DocumentDownloadRequest" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "schema": { - "$ref": "#/definitions/DocumentDownloadResult" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoicesDownloadDocumentsByBillingAccount": { - "$ref": "./examples/invoicesDownloadDocumentsByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/amend": { - "post": { - "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/" - }, - "operationId": "Invoices_Amend", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoicesAmend": { - "$ref": "./examples/invoicesAmend.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download": { - "post": { - "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/" - }, - "operationId": "Invoices_DownloadByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "in": "query", - "name": "documentName", - "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.", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "schema": { - "$ref": "#/definitions/DocumentDownloadResult" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoicesDownloadByBillingAccount": { - "$ref": "./examples/invoicesDownloadByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/downloadSummary": { - "post": { - "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/" - }, - "operationId": "Invoices_DownloadSummaryByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "schema": { - "$ref": "#/definitions/DocumentDownloadResult" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoicesDownloadSummaryByBillingAccount": { - "$ref": "./examples/invoicesDownloadSummaryByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": { - "get": { - "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/" - }, - "operationId": "Invoices_GetByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of invoices.", - "schema": { - "$ref": "#/definitions/Invoice" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "get": { - "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/" - }, - "operationId": "Invoices_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "in": "query", - "name": "periodStartDate", - "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "periodEndDate", - "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", - "type": "string", - "format": "date" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of invoices.", - "schema": { - "$ref": "#/definitions/InvoiceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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/default/billingSubscriptions/{subscriptionId}/downloadDocuments": { - "post": { - "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/" - }, - "operationId": "Invoices_DownloadDocumentsByBillingSubscription", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/subscriptionId" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A list of download details for individual documents.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/DocumentDownloadRequest" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "schema": { - "$ref": "#/definitions/DocumentDownloadResult" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoicesDownloadDocumentsByBillingSubscription": { - "$ref": "./examples/invoicesDownloadDocumentsByBillingSubscription.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download": { - "post": { - "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/" - }, - "operationId": "Invoices_DownloadByBillingSubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/subscriptionId" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "in": "query", - "name": "documentName", - "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.", - "type": "string" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "schema": { - "$ref": "#/definitions/DocumentDownloadResult" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoicesDownloadByBillingSubscription": { - "$ref": "./examples/invoicesDownloadByBillingSubscription.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}": { - "get": { - "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/" - }, - "operationId": "Invoices_GetByBillingSubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/subscriptionId" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An invoice.", - "schema": { - "$ref": "#/definitions/Invoice" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "get": { - "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/" - }, - "operationId": "Invoices_ListByBillingSubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/subscriptionId" - }, - { - "in": "query", - "name": "periodStartDate", - "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "periodEndDate", - "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", - "type": "string", - "format": "date" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of invoices.", - "schema": { - "$ref": "#/definitions/InvoiceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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/invoices/{invoiceName}": { - "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/" - }, - "operationId": "Invoices_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An invoice.", - "schema": { - "$ref": "#/definitions/Invoice" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "InvoicesGet": { - "$ref": "./examples/invoicesGet.json" - } - } - } - } - }, - "definitions": { - "DocumentDownloadRequest": { - "description": "A list of download details for individual documents.", - "type": "object", - "properties": { - "documentName": { - "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.", - "type": "string" - }, - "invoiceName": { - "description": "The ID that uniquely identifies an invoice.", - "type": "string" - } - } - }, - "DocumentDownloadResult": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "type": "object", - "properties": { - "expiryTime": { - "description": "The time in UTC when the download URL will expire.", - "type": "string", - "readOnly": true - }, - "url": { - "description": "The URL to the PDF or .zip file.", - "type": "string", - "readOnly": true - } - } - }, - "FailedPayment": { - "description": "A failed payment.", - "type": "object", - "properties": { - "date": { - "format": "date-time", - "description": "The date when the payment was attempted.", - "type": "string", - "readOnly": true - }, - "failedPaymentReason": { - "description": "The reason that the payment failed.", - "enum": [ - "Other", - "BankDeclined", - "CardExpired", - "IncorrectCardDetails" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "FailedPaymentReason", - "modelAsString": true - } - } - } - }, - "Invoice": { - "description": "An invoice.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/InvoiceProperties" - } - }, - "x-ms-azure-resource": true - }, - "InvoiceDocument": { - "description": "The properties of a document.", - "type": "object", - "properties": { - "documentNumbers": { - "description": "The document numbers for the invoice document.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "externalUrl": { - "description": "The URL to download the invoice document if the source is external to Microsoft.Billing.", - "type": "string", - "readOnly": true - }, - "kind": { - "description": "The type of the document.", - "enum": [ - "Other", - "Invoice", - "VoidNote", - "TaxReceipt", - "CreditNote", - "Summary", - "Transactions" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "InvoiceDocumentType", - "modelAsString": true - } - }, - "name": { - "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.", - "type": "string", - "readOnly": true - }, - "url": { - "description": "The URL to download the invoice document if the source is internal to Microsoft.Billing.", - "type": "string", - "readOnly": true - }, - "source": { - "description": "The source of the document. ENF for Brazil and DRS for rest of the world.", - "enum": [ - "Other", - "DRS", - "ENF" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "DocumentSource", - "modelAsString": true - } - } - } - }, - "InvoiceListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Invoice" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "InvoiceProperties": { - "description": "An invoice.", - "type": "object", - "properties": { - "amountDue": { - "description": "The amount due as of now.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "azurePrepaymentApplied": { - "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": "./types.json#/definitions/Amount" - } - ] - }, - "billedAmount": { - "description": "The total charges for the invoice billing period.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "billedDocumentId": { - "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.", - "type": "string", - "readOnly": true - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile for which the invoice is generated.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "The ID of the billing profile for which the invoice is generated.", - "type": "string", - "readOnly": true - }, - "creditAmount": { - "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": "./types.json#/definitions/Amount" - } - ] - }, - "creditForDocumentId": { - "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.", - "type": "string", - "readOnly": true - }, - "documents": { - "description": "List of documents available to download and view such as invoice, credit note, or tax receipt.", - "type": "array", - "items": { - "$ref": "#/definitions/InvoiceDocument" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "documentType": { - "description": "The type of the document.", - "enum": [ - "Other", - "Invoice", - "VoidNote", - "TaxReceipt", - "CreditNote", - "Summary", - "Transactions" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "InvoiceDocumentType", - "modelAsString": true - } - }, - "dueDate": { - "format": "date-time", - "description": "The due date for the invoice.", - "type": "string", - "readOnly": true - }, - "failedPayments": { - "description": "List of failed payments.", - "type": "array", - "items": { - "$ref": "#/definitions/FailedPayment" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "freeAzureCreditApplied": { - "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": "./types.json#/definitions/Amount" - } - ] - }, - "invoiceDate": { - "format": "date-time", - "description": "The date when the invoice was generated.", - "type": "string", - "readOnly": true - }, - "invoicePeriodEndDate": { - "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.", - "type": "string", - "readOnly": true - }, - "invoicePeriodStartDate": { - "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.", - "type": "string", - "readOnly": true - }, - "invoiceType": { - "description": "Invoice type.", - "enum": [ - "Other", - "AzureServices", - "AzureMarketplace", - "AzureSupport" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "InvoiceType", - "modelAsString": true - } - }, - "isMonthlyInvoice": { - "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.", - "type": "boolean", - "readOnly": true - }, - "payments": { - "description": "List of payments.", - "type": "array", - "items": { - "$ref": "#/definitions/Payment" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "purchaseOrderNumber": { - "description": "An optional purchase order number for the invoice.", - "type": "string", - "readOnly": true - }, - "rebillDetails": { - "description": "Rebill details for an invoice.", - "allOf": [ - { - "$ref": "#/definitions/RebillDetails" - } - ] - }, - "status": { - "description": "The current status of the invoice.", - "enum": [ - "Other", - "Due", - "OverDue", - "Paid", - "Void", - "Locked" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "InvoiceStatus", - "modelAsString": true - } - }, - "subscriptionDisplayName": { - "description": "The name of the billing subscription for which the invoice is generated.", - "type": "string", - "readOnly": true - }, - "subscriptionId": { - "description": "The ID of the subscription for which the invoice is generated.", - "type": "string", - "readOnly": true - }, - "specialTaxationType": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SpecialTaxationType", - "modelAsString": true - } - }, - "subTotal": { - "description": "The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "taxAmount": { - "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": "./types.json#/definitions/Amount" - } - ] - }, - "totalAmount": { - "description": "The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "refundDetails": { - "description": "The details of a refund request.", - "allOf": [ - { - "$ref": "#/definitions/RefundDetailsSummary" - } - ] - } - } - }, - "Payment": { - "description": "An invoice payment.", - "type": "object", - "properties": { - "amount": { - "description": "The paid amount.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "date": { - "format": "date-time", - "description": "The date when the payment was made.", - "type": "string", - "readOnly": true - }, - "paymentMethodId": { - "description": "The ID that uniquely identifies the payment method used for the invoice.", - "type": "string", - "readOnly": true - }, - "paymentMethodFamily": { - "description": "The family of payment method.", - "enum": [ - "Other", - "None", - "CreditCard", - "Credits", - "CheckWire", - "EWallet", - "TaskOrder", - "DirectDebit" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PaymentMethodFamily", - "modelAsString": true - } - }, - "paymentMethodType": { - "description": "The type of payment method.", - "type": "string", - "readOnly": true - }, - "paymentType": { - "description": "The type of payment.", - "type": "string", - "readOnly": true - } - }, - "readOnly": true - }, - "RebillDetails": { - "description": "The rebill details of an invoice.", - "type": "object", - "properties": { - "invoiceDocumentId": { - "description": "The ID of invoice.", - "type": "string", - "readOnly": true - }, - "creditNoteDocumentId": { - "description": "The ID of credit note.", - "type": "string", - "readOnly": true - }, - "rebillDetails": { - "$ref": "#/definitions/RebillDetails" - } - }, - "readOnly": true - }, - "RefundDetailsSummary": { - "description": "The details of refund request.", - "type": "object", - "properties": { - "requestedOn": { - "format": "date-time", - "description": "Date when the refund was requested.", - "type": "string", - "readOnly": true - }, - "approvedOn": { - "format": "date-time", - "description": "Date when the refund was approved.", - "type": "string", - "readOnly": true - }, - "completedOn": { - "format": "date-time", - "description": "Date when the refund was completed.", - "type": "string", - "readOnly": true - }, - "amountRequested": { - "description": "The amount of refund requested.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "amountRefunded": { - "description": "The amount refunded.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "rebillInvoiceId": { - "description": "The invoice ID of the rebill invoice for a refund.", - "type": "string", - "readOnly": true - }, - "transactionCount": { - "format": "int32", - "description": "The number of transactions refunded.", - "type": "integer", - "readOnly": true - }, - "refundStatus": { - "description": "The status of refund request.", - "enum": [ - "Other", - "Pending", - "Approved", - "Declined", - "Cancelled", - "Completed", - "Expired" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "RefundStatus", - "modelAsString": true - } - }, - "refundOperationId": { - "description": "The ID of refund operation.", - "type": "string", - "readOnly": true - }, - "refundReason": { - "description": "The reason for refund.", - "enum": [ - "Other", - "AccidentalConversion", - "UnclearPricing", - "AccidentalPurchase", - "ForgotToCancel", - "UnclearDocumentation" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "RefundReasonCode", - "modelAsString": true - } - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/invoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/invoiceSection.json deleted file mode 100644 index 645e47ee0c9e..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/invoiceSection.json +++ /dev/null @@ -1,512 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/validateDeleteEligibility": { - "post": { - "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/" - }, - "operationId": "InvoiceSections_ValidateDeleteEligibility", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Eligibility to delete an invoice section result.", - "schema": { - "$ref": "#/definitions/DeleteInvoiceSectionEligibilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "InvoiceSectionsValidateDeleteEligibilitySuccess": { - "$ref": "./examples/invoiceSectionsValidateDeleteEligibilitySuccess.json" - }, - "InvoiceSectionsValidateDeleteEligibilityFailure": { - "$ref": "./examples/invoiceSectionsValidateDeleteEligibilityFailure.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}": { - "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/" - }, - "operationId": "InvoiceSections_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoiceSectionsDelete": { - "$ref": "./examples/invoiceSectionsDelete.json" - } - } - }, - "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/" - }, - "operationId": "InvoiceSections_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An invoice section.", - "schema": { - "$ref": "#/definitions/InvoiceSection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "InvoiceSectionsGet": { - "$ref": "./examples/invoiceSectionsGet.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "InvoiceSections_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "An invoice section.", - "required": true, - "schema": { - "$ref": "#/definitions/InvoiceSection" - } - } - ], - "responses": { - "200": { - "description": "An invoice section.", - "schema": { - "$ref": "#/definitions/InvoiceSection" - } - }, - "201": { - "description": "An invoice section.", - "schema": { - "$ref": "#/definitions/InvoiceSection" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "InvoiceSectionsCreateOrUpdate": { - "$ref": "./examples/invoiceSectionsCreateOrUpdate.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections": { - "get": { - "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/" - }, - "operationId": "InvoiceSections_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "in": "query", - "name": "includeDeleted", - "description": "Can be used to get deleted invoice sections.", - "type": "boolean", - "default": false - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "A list of invoice sections.", - "schema": { - "$ref": "#/definitions/InvoiceSectionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "InvoiceSectionsListByBillingProfile": { - "$ref": "./examples/invoiceSectionsListByBillingProfile.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "DeleteInvoiceSectionEligibilityDetail": { - "description": "The details of delete invoice section eligibility result.", - "type": "object", - "properties": { - "code": { - "description": "Code for the delete invoice section validation.", - "enum": [ - "Other", - "LastInvoiceSection", - "ActiveAzurePlans", - "ReservedInstances", - "ActiveBillingSubscriptions" - ], - "type": "string", - "x-ms-enum": { - "name": "DeleteInvoiceSectionEligibilityCode", - "modelAsString": true - } - }, - "message": { - "description": "Validation message.", - "type": "string" - } - } - }, - "DeleteInvoiceSectionEligibilityResult": { - "description": "Eligibility to delete an invoice section result.", - "type": "object", - "properties": { - "eligibilityStatus": { - "description": "Status describing if invoice section is eligible to be deleted.", - "enum": [ - "Allowed", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "DeleteInvoiceSectionEligibilityStatus", - "modelAsString": true - } - }, - "eligibilityDetails": { - "description": "A list of delete invoice section eligibility result details.", - "type": "array", - "items": { - "$ref": "#/definitions/DeleteInvoiceSectionEligibilityDetail" - }, - "x-ms-identifiers": [] - } - } - }, - "InvoiceSection": { - "description": "An invoice section.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/InvoiceSectionProperties" - } - }, - "x-ms-azure-resource": true - }, - "InvoiceSectionListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/InvoiceSection" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "InvoiceSectionProperties": { - "description": "An invoice section.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "displayName": { - "description": "The name of the invoice section.", - "type": "string" - }, - "state": { - "description": "Identifies the status of an invoice section.", - "enum": [ - "Other", - "Active", - "Deleted", - "Disabled", - "UnderReview", - "Warned", - "Restricted" - ], - "type": "string", - "x-ms-enum": { - "name": "InvoiceSectionState", - "modelAsString": true - } - }, - "reasonCode": { - "description": "Reason for the specified invoice section status.", - "enum": [ - "Other", - "PastDue", - "UnusualActivity", - "SpendingLimitReached", - "SpendingLimitExpired" - ], - "type": "string", - "x-ms-enum": { - "name": "InvoiceSectionStateReasonCode", - "modelAsString": true - } - }, - "systemId": { - "description": "The system generated unique identifier for an invoice section.", - "type": "string", - "readOnly": true - }, - "targetCloud": { - "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.", - "type": "string" - }, - "tags": { - "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 < > % & \\ ? /", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/openapi.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/openapi.json new file mode 100644 index 000000000000..593a0b68e662 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/openapi.json @@ -0,0 +1,24468 @@ +{ + "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/" + }, + "consumes": [ + "text/plain" + ], + "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 + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "etag": { + "type": "integer", + "format": "int32" + }, + "sku": { + "$ref": "#/definitions/ReservationSkuProperty", + "description": "The sku information associated to this reservation" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "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": {} +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/operation.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/operation.json deleted file mode 100644 index 75a677cd1d49..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/operation.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/operations": { - "get": { - "tags": [ - "ArmOperations" - ], - "description": "List of operations supported by provider.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "Operations_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "OperationsList": { - "$ref": "./examples/operationsList.json" - } - } - } - } - }, - "definitions": { - "Operation": { - "description": "Details of a REST API operation, returned from the Resource Provider Operations API.", - "type": "object", - "properties": { - "name": { - "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\".", - "type": "string", - "readOnly": true - }, - "isDataAction": { - "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", - "type": "boolean", - "readOnly": true - }, - "display": { - "description": "Localized display information for this particular operation.", - "$ref": "#/definitions/OperationDisplay" - } - } - }, - "OperationDisplay": { - "description": "Localized display information for this particular operation.", - "type": "object", - "properties": { - "description": { - "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", - "type": "string", - "readOnly": true - }, - "provider": { - "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", - "type": "string", - "readOnly": true - } - } - }, - "OperationListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "readOnly": true, - "x-ms-identifiers": [ - "name" - ] - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/payment.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/payment.json deleted file mode 100644 index 4f872fe63fbd..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/payment.json +++ /dev/null @@ -1,601 +0,0 @@ -{ - "consumes": [ - "application/json" - ], - "definitions": { - "PaymentMethod": { - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "description": "A payment method.", - "properties": { - "properties": { - "$ref": "#/definitions/PaymentMethodProperties", - "description": "Payment method properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "PaymentMethodLink": { - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "description": "A payment method link.", - "properties": { - "properties": { - "$ref": "#/definitions/PaymentMethodLinkProperties", - "description": "Payment method link properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "PaymentMethodLinkProperties": { - "description": "The properties of a payment method link.", - "properties": { - "accountHolderName": { - "description": "The account holder name for the payment method. This is only supported for payment methods with family CreditCard.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The display name of the payment method.", - "readOnly": true, - "type": "string" - }, - "expiration": { - "description": "The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard.", - "readOnly": true, - "type": "string" - }, - "family": { - "description": "The family of payment method.", - "enum": [ - "Other", - "None", - "CreditCard", - "Credits", - "CheckWire", - "EWallet", - "TaskOrder", - "DirectDebit" - ], - "readOnly": true, - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "paymentMethodFamily" - } - }, - "lastFourDigits": { - "description": "Last four digits of payment method.", - "readOnly": true, - "type": "string" - }, - "logos": { - "description": "The list of logos for the payment method.", - "items": { - "$ref": "#/definitions/PaymentMethodLogo" - }, - "readOnly": true, - "type": "array", - "x-ms-identifiers": [] - }, - "paymentMethod": { - "description": "Projection of a payment method. Will not be returned in this or future versions.", - "$ref": "#/definitions/PaymentMethodProperties" - }, - "paymentMethodId": { - "description": "Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", - "type": "string" - }, - "paymentMethodType": { - "description": "The type of payment method.", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "Status of the payment method.", - "enum": [ - "active", - "inactive" - ], - "readOnly": true, - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "paymentMethodStatus" - } - } - }, - "type": "object" - }, - "PaymentMethodLinksListResult": { - "description": "The list of payment method links.", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The list of payment method links.", - "items": { - "$ref": "#/definitions/PaymentMethodLink" - }, - "readOnly": true, - "type": "array", - "x-ms-identifiers": [ - "id" - ] - } - }, - "type": "object" - }, - "PaymentMethodLogo": { - "description": "Logo of payment method.", - "properties": { - "mimeType": { - "description": "MIME type of the logo.", - "readOnly": true, - "type": "string" - }, - "url": { - "description": "Public URL of image of the logo.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "PaymentMethodProperties": { - "description": "The properties of a payment method.", - "properties": { - "id": { - "description": "Id of payment method.", - "type": "string", - "readOnly": true - }, - "accountHolderName": { - "description": "The account holder name for the payment method. This is only supported for payment methods with family CreditCard.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The display name of the payment method.", - "readOnly": true, - "type": "string" - }, - "expiration": { - "description": "The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard.", - "readOnly": true, - "type": "string" - }, - "family": { - "description": "The family of payment method.", - "enum": [ - "Other", - "None", - "CreditCard", - "Credits", - "CheckWire", - "EWallet", - "TaskOrder", - "DirectDebit" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "paymentMethodFamily" - } - }, - "lastFourDigits": { - "description": "Last four digits of payment method.", - "readOnly": true, - "type": "string" - }, - "logos": { - "description": "The list of logos for the payment method.", - "items": { - "$ref": "#/definitions/PaymentMethodLogo" - }, - "type": "array", - "x-ms-identifiers": [] - }, - "paymentMethodType": { - "description": "The type of payment method.", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "Status of the payment method.", - "enum": [ - "active", - "inactive" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "paymentMethodStatus" - } - } - }, - "type": "object" - }, - "PaymentMethodsListResult": { - "description": "The list of payment methods.", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The list of payment methods.", - "items": { - "$ref": "#/definitions/PaymentMethod" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object", - "x-ms-identifiers": [ - "id" - ] - } - }, - "host": "management.azure.com", - "info": { - "description": "The billing client allows you to view and manage your billing details programmatically.", - "title": "BillingManagementClient", - "version": "2024-04-01" - }, - "parameters": { - "billingAccountNameParameter": { - "name": "billingAccountName", - "in": "path", - "description": "The ID that uniquely identifies a billing account.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingProfileNameParameter": { - "name": "billingProfileName", - "in": "path", - "description": "The ID that uniquely identifies a billing profile.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "paymentMethodNameParameter": { - "description": "The ID that uniquely identifies a payment method.", - "in": "path", - "name": "paymentMethodName", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks": { - "get": { - "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/" - }, - "operationId": "PaymentMethods_ListByBillingProfile", - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/PaymentMethodLinksListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "PaymentMethods" - ], - "x-ms-examples": { - "PaymentMethodsListByBillingProfile": { - "$ref": "./examples/paymentMethodsListByBillingProfile.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks/{paymentMethodName}": { - "get": { - "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/" - }, - "operationId": "PaymentMethods_GetByBillingProfile", - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/paymentMethodNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/PaymentMethodLink" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "PaymentMethods" - ], - "x-ms-examples": { - "PaymentMethodsGetByBillingProfile": { - "$ref": "./examples/paymentMethodsGetByBillingProfile.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods": { - "get": { - "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/" - }, - "operationId": "PaymentMethods_ListByBillingAccount", - "parameters": [ - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/PaymentMethodsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "PaymentMethods" - ], - "x-ms-examples": { - "PaymentMethodsListByBillingAccount": { - "$ref": "./examples/paymentMethodsListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods/{paymentMethodName}": { - "get": { - "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/" - }, - "operationId": "PaymentMethods_GetByBillingAccount", - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/paymentMethodNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/PaymentMethod" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "PaymentMethods" - ], - "x-ms-examples": { - "PaymentMethodGetAtBillingProfile": { - "$ref": "./examples/paymentMethodsGetByBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/paymentMethods": { - "get": { - "description": "Lists the payment methods owned by the caller.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "PaymentMethods_ListByUser", - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/PaymentMethodsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "PaymentMethods" - ], - "x-ms-examples": { - "ListPaymentMethodOwnedByUser": { - "$ref": "./examples/paymentMethodsListByUser.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/paymentMethods/{paymentMethodName}": { - "delete": { - "description": "Deletes a payment method owned by the caller.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "PaymentMethods_DeleteByUser", - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/paymentMethodNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "PaymentMethods" - ], - "x-ms-examples": { - "DeletePaymentMethodOwnedByUser": { - "$ref": "./examples/paymentMethodsDeleteByUser.json" - } - } - }, - "get": { - "description": "Gets a payment method owned by the caller.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/billing/" - }, - "operationId": "PaymentMethods_GetByUser", - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/paymentMethodNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/PaymentMethod" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "PaymentMethods" - ], - "x-ms-examples": { - "GetPaymentMethodOwnedByUser": { - "$ref": "./examples/paymentMethodsGetByUser.json" - } - } - } - } - }, - "produces": [ - "application/json" - ], - "schemes": [ - "https" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow.", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "swagger": "2.0" -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/policy.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/policy.json deleted file mode 100644 index b1a17dbe6366..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/policy.json +++ /dev/null @@ -1,977 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/{policyName}": { - "get": { - "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/" - }, - "operationId": "Policies_GetByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "in": "path", - "name": "policyName", - "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 - } - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A policy at customer scope.", - "schema": { - "$ref": "#/definitions/CustomerPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "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/" - }, - "operationId": "Policies_CreateOrUpdateByCustomer", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A policy at customer scope.", - "required": true, - "schema": { - "$ref": "#/definitions/CustomerPolicy" - } - } - ], - "responses": { - "200": { - "description": "A policy at customer scope.", - "schema": { - "$ref": "#/definitions/CustomerPolicy" - } - }, - "201": { - "description": "A policy at customer scope.", - "schema": { - "$ref": "#/definitions/CustomerPolicy" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "PoliciesPutByCustomer": { - "$ref": "./examples/policiesPutByCustomer.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default": { - "get": { - "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/" - }, - "operationId": "Policies_GetByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A policy at billing profile scope.", - "schema": { - "$ref": "#/definitions/BillingProfilePolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PoliciesGetByBillingProfile": { - "$ref": "./examples/policiesGetByBillingProfile.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "Policies_CreateOrUpdateByBillingProfile", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A policy at billing profile scope.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingProfilePolicy" - } - } - ], - "responses": { - "200": { - "description": "A policy at billing profile scope.", - "schema": { - "$ref": "#/definitions/BillingProfilePolicy" - } - }, - "201": { - "description": "A policy at billing profile scope.", - "schema": { - "$ref": "#/definitions/BillingProfilePolicy" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "PoliciesPutByBillingProfile": { - "$ref": "./examples/policiesPutByBillingProfile.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default": { - "get": { - "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/" - }, - "operationId": "Policies_GetByCustomerAtBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A policy at customer scope.", - "schema": { - "$ref": "#/definitions/CustomerPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PoliciesGetByCustomerAtBillingAccount": { - "$ref": "./examples/policiesGetByCustomerAtBillingAccount.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "Policies_CreateOrUpdateByCustomerAtBillingAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A policy at customer scope.", - "required": true, - "schema": { - "$ref": "#/definitions/CustomerPolicy" - } - } - ], - "responses": { - "200": { - "description": "A policy at customer scope.", - "schema": { - "$ref": "#/definitions/CustomerPolicy" - } - }, - "201": { - "description": "A policy at customer scope.", - "schema": { - "$ref": "#/definitions/CustomerPolicy" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "PoliciesPutByCustomerAtBillingAccount": { - "$ref": "./examples/policiesPutByCustomerAtBillingAccount.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/policies/default": { - "get": { - "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/" - }, - "operationId": "Policies_GetByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A policy at billing account scope.", - "schema": { - "$ref": "#/definitions/BillingAccountPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PoliciesGetByBillingAccount": { - "$ref": "./examples/policiesGetByBillingAccount.json" - } - } - }, - "put": { - "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/" - }, - "operationId": "Policies_CreateOrUpdateByBillingAccount", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A policy at billing account scope.", - "required": true, - "schema": { - "$ref": "#/definitions/BillingAccountPolicy" - } - } - ], - "responses": { - "200": { - "description": "A policy at billing account scope.", - "schema": { - "$ref": "#/definitions/BillingAccountPolicy" - } - }, - "201": { - "description": "A policy at billing account scope.", - "schema": { - "$ref": "#/definitions/BillingAccountPolicy" - }, - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "PoliciesPutByBillingAccount": { - "$ref": "./examples/policiesPutByBillingAccount.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/policies/default": { - "get": { - "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/" - }, - "operationId": "Policies_GetBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/subscriptionId" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A policy at subscription scope.", - "schema": { - "$ref": "#/definitions/SubscriptionPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PoliciesGetBySubscription": { - "$ref": "./examples/policiesGetBySubscription.json" - } - } - } - } - }, - "definitions": { - "BillingAccountPolicy": { - "description": "A policy at billing account scope.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingAccountPolicyProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingAccountPolicyProperties": { - "description": "A policy at billing account scope.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "enterpriseAgreementPolicies": { - "description": "The policies for Enterprise Agreement enrollments.", - "allOf": [ - { - "$ref": "#/definitions/EnterpriseAgreementPolicies" - } - ] - }, - "marketplacePurchases": { - "description": "The policy that controls whether Azure marketplace purchases are allowed.", - "enum": [ - "Other", - "AllAllowed", - "Disabled", - "NotAllowed", - "OnlyFreeAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "MarketplacePurchasesPolicy", - "modelAsString": true - } - }, - "reservationPurchases": { - "description": "The policy that controls whether Azure reservation purchases are allowed.", - "enum": [ - "Other", - "Allowed", - "Disabled", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "ReservationPurchasesPolicy", - "modelAsString": true - } - }, - "savingsPlanPurchases": { - "description": "The policy that controls whether users with Azure savings plan purchase are allowed.", - "enum": [ - "Other", - "Allowed", - "Disabled", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "SavingsPlanPurchasesPolicy", - "modelAsString": true - } - }, - "policies": { - "description": "List of all policies defined at the billing scope.", - "type": "array", - "items": { - "$ref": "#/definitions/PolicySummary" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "BillingProfilePolicy": { - "description": "A policy at billing profile scope.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BillingProfilePolicyProperties" - } - }, - "x-ms-azure-resource": true - }, - "BillingProfilePolicyProperties": { - "description": "A policy at billing profile scope.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "enterpriseAgreementPolicies": { - "description": "The policies for Enterprise Agreement enrollments.", - "allOf": [ - { - "$ref": "#/definitions/EnterpriseAgreementPolicies" - } - ] - }, - "invoiceSectionLabelManagement": { - "description": "The policy that controls invoice section label management at invoice section scope. This is allowed by default.", - "enum": [ - "Other", - "Allowed", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "InvoiceSectionLabelManagementPolicy", - "modelAsString": true - } - }, - "marketplacePurchases": { - "description": "The policy that controls whether Azure marketplace purchases are allowed.", - "enum": [ - "Other", - "AllAllowed", - "Disabled", - "NotAllowed", - "OnlyFreeAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "MarketplacePurchasesPolicy", - "modelAsString": true - } - }, - "reservationPurchases": { - "description": "The policy that controls whether Azure reservation purchases are allowed.", - "enum": [ - "Other", - "Allowed", - "Disabled", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "ReservationPurchasesPolicy", - "modelAsString": true - } - }, - "savingsPlanPurchases": { - "description": "The policy that controls whether users with Azure savings plan purchase are allowed.", - "enum": [ - "Other", - "Allowed", - "Disabled", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "SavingsPlanPurchasesPolicy", - "modelAsString": true - } - }, - "viewCharges": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "ViewChargesPolicy", - "modelAsString": true - } - }, - "policies": { - "description": "List of all policies defined at the billing scope.", - "type": "array", - "items": { - "$ref": "#/definitions/PolicySummary" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "CustomerPolicy": { - "description": "A policy at customer scope.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/CustomerPolicyProperties" - } - }, - "x-ms-azure-resource": true - }, - "CustomerPolicyProperties": { - "description": "A policy at customer scope.", - "required": [ - "viewCharges" - ], - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "viewCharges": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "ViewChargesPolicy", - "modelAsString": true - } - }, - "policies": { - "description": "List of all policies defined at the billing scope.", - "type": "array", - "items": { - "$ref": "#/definitions/PolicySummary" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "EnterpriseAgreementPolicies": { - "description": "The policies for Enterprise Agreement enrollments.", - "type": "object", - "properties": { - "authenticationType": { - "description": "The state showing the enrollment auth level.", - "enum": [ - "Other", - "MicrosoftAccountOnly", - "MixedAccount", - "OrganizationalAccountCrossTenant", - "OrganizationalAccountOnly" - ], - "type": "string", - "x-ms-enum": { - "name": "EnrollmentAuthLevelState", - "modelAsString": true - } - }, - "accountOwnerViewCharges": { - "description": "The policy that controls whether account owner can view charges.", - "enum": [ - "Other", - "Allowed", - "Disabled", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "EnrollmentAccountOwnerViewCharges", - "modelAsString": true - } - }, - "departmentAdminViewCharges": { - "description": "The policy that controls whether department admin can view charges.", - "enum": [ - "Other", - "Allowed", - "Disabled", - "NotAllowed" - ], - "type": "string", - "x-ms-enum": { - "name": "EnrollmentDepartmentAdminViewCharges", - "modelAsString": true - } - } - } - }, - "PolicySummary": { - "description": "The summary of the policy.", - "type": "object", - "properties": { - "name": { - "description": "The name of the policy.", - "type": "string" - }, - "value": { - "description": "The value of the policy.", - "type": "string" - }, - "policyType": { - "description": "The type of the policy.", - "enum": [ - "Other", - "UserControlled", - "SystemControlled" - ], - "type": "string", - "x-ms-enum": { - "name": "PolicyType", - "modelAsString": true - } - }, - "scope": { - "description": "The scope at which the policy is defined.", - "type": "string" - } - } - }, - "SubscriptionPolicy": { - "description": "A policy at subscription scope.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SubscriptionPolicyProperties" - } - }, - "x-ms-azure-resource": true - }, - "SubscriptionPolicyProperties": { - "description": "A policy at subscription scope.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state of the resource during a long-running operation.", - "enum": [ - "Succeeded", - "Canceled", - "Failed", - "New", - "Pending", - "Provisioning" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "policies": { - "description": "List of all policies defined at the billing scope.", - "type": "array", - "items": { - "$ref": "#/definitions/PolicySummary" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/product.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/product.json deleted file mode 100644 index 6091f814e723..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/product.json +++ /dev/null @@ -1,826 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products": { - "get": { - "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/" - }, - "operationId": "Products_ListByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", - "schema": { - "$ref": "#/definitions/ProductListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/products": { - "get": { - "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/" - }, - "operationId": "Products_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", - "schema": { - "$ref": "#/definitions/ProductListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/customers/{customerName}/products": { - "get": { - "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/" - }, - "operationId": "Products_ListByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", - "schema": { - "$ref": "#/definitions/ProductListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/products/{productName}/move": { - "post": { - "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/" - }, - "operationId": "Products_Move", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/productName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the product to initiate a transfer.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveProductRequest" - } - } - ], - "responses": { - "200": { - "description": "A product.", - "schema": { - "$ref": "#/definitions/Product" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "ProductMove": { - "$ref": "./examples/productMove.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/validateMoveEligibility": { - "post": { - "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/" - }, - "operationId": "Products_ValidateMoveEligibility", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/productName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The properties of the product to initiate a transfer.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveProductRequest" - } - } - ], - "responses": { - "200": { - "description": "Result of the transfer eligibility validation.", - "schema": { - "$ref": "#/definitions/MoveProductEligibilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ProductValidateMoveSuccess": { - "$ref": "./examples/productValidateMoveSuccess.json" - }, - "ProductValidateMoveFailure": { - "$ref": "./examples/productValidateMoveFailure.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}": { - "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/" - }, - "operationId": "Products_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/productName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A product.", - "schema": { - "$ref": "#/definitions/Product" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ProductsGet": { - "$ref": "./examples/productsGet.json" - } - } - }, - "patch": { - "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/" - }, - "operationId": "Products_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/productName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "A product.", - "required": true, - "schema": { - "$ref": "#/definitions/ProductPatch" - } - } - ], - "responses": { - "200": { - "description": "A product.", - "schema": { - "$ref": "#/definitions/Product" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "get": { - "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/" - }, - "operationId": "Products_ListByBillingAccount", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", - "schema": { - "$ref": "#/definitions/ProductListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ProductsListByBillingAccount": { - "$ref": "./examples/productsListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "ExternalReference": { - "description": "An external reference.", - "type": "object", - "properties": { - "id": { - "description": "The ID that uniquely identifies an external reference.", - "type": "string", - "readOnly": true - }, - "url": { - "description": "The URL of the external reference.", - "type": "string", - "readOnly": true - } - }, - "readOnly": true - }, - "MoveProductEligibilityResult": { - "description": "Result of the transfer eligibility validation.", - "type": "object", - "properties": { - "isMoveEligible": { - "description": "Specifies whether the subscription is eligible to be transferred.", - "type": "boolean" - }, - "errorDetails": { - "description": "Error details of the transfer eligibility validation.", - "allOf": [ - { - "$ref": "#/definitions/MoveProductErrorDetails" - } - ] - } - } - }, - "MoveProductErrorDetails": { - "description": "Error details of the transfer eligibility validation.", - "type": "object", - "properties": { - "code": { - "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" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "MoveValidationErrorCode", - "modelAsString": true - } - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Error details of the transfer eligibility validation.", - "type": "string", - "readOnly": true - } - } - }, - "MoveProductRequest": { - "description": "The properties of the product to initiate a transfer.", - "required": [ - "destinationInvoiceSectionId" - ], - "type": "object", - "properties": { - "destinationInvoiceSectionId": { - "description": "The destination invoice section id.", - "minLength": 1, - "type": "string" - } - } - }, - "Product": { - "description": "A product.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ProductProperties" - } - }, - "x-ms-azure-resource": true - }, - "ProductListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Product" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "ProductPatch": { - "description": "A product.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ProductProperties" - } - }, - "x-ms-azure-resource": true - }, - "ProductProperties": { - "description": "A product.", - "type": "object", - "properties": { - "autoRenew": { - "description": "Indicates whether auto renewal is turned on or off for a product.", - "enum": [ - "Off", - "On" - ], - "type": "string", - "x-ms-enum": { - "name": "AutoRenew", - "modelAsString": true - } - }, - "availabilityId": { - "description": "The availability of the product.", - "type": "string", - "readOnly": true - }, - "billingFrequency": { - "description": "The frequency at which the product will be billed.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "The ID of the billing profile to which the product is billed.", - "type": "string", - "readOnly": true - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile to which the product is billed.", - "type": "string", - "readOnly": true - }, - "customerId": { - "description": "The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", - "type": "string", - "readOnly": true - }, - "customerDisplayName": { - "description": "The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", - "type": "string", - "readOnly": true - }, - "displayName": { - "description": "The display name of the product.", - "type": "string", - "readOnly": true - }, - "endDate": { - "description": "The date when the product will be renewed or canceled.", - "type": "string", - "readOnly": true - }, - "invoiceSectionId": { - "description": "The ID of the invoice section to which the product is billed.", - "type": "string", - "readOnly": true - }, - "invoiceSectionDisplayName": { - "description": "The name of the invoice section to which the product is billed.", - "type": "string", - "readOnly": true - }, - "lastCharge": { - "description": "The last month charges.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "lastChargeDate": { - "description": "The date of the last charge.", - "type": "string", - "readOnly": true - }, - "productType": { - "description": "The description of the type of product.", - "type": "string", - "readOnly": true - }, - "productTypeId": { - "description": "The ID of the type of product.", - "type": "string", - "readOnly": true - }, - "skuId": { - "description": "The sku ID of the product.", - "type": "string", - "readOnly": true - }, - "skuDescription": { - "description": "The sku description of the product.", - "type": "string", - "readOnly": true - }, - "purchaseDate": { - "description": "The date when the product was purchased.", - "type": "string", - "readOnly": true - }, - "quantity": { - "format": "int64", - "description": "The quantity purchased for the product.", - "type": "integer", - "readOnly": true - }, - "status": { - "description": "The status of the product.", - "enum": [ - "Other", - "Active", - "Disabled", - "Deleted", - "PastDue", - "Expiring", - "Expired", - "AutoRenew", - "Canceled", - "Suspended" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProductStatus", - "modelAsString": true - } - }, - "tenantId": { - "description": "The id of the tenant in which the product is used.", - "type": "string", - "readOnly": true - }, - "reseller": { - "description": "Reseller for this product. The fields is not available for Microsoft Partner Agreement products.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Reseller" - } - ] - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/reservation.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/reservation.json deleted file mode 100644 index df50177dd855..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/reservation.json +++ /dev/null @@ -1,1423 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Billing client provides access to billing resources for Azure subscriptions.", - "title": "BillingManagementClient", - "version": "2024-04-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations": { - "get": { - "description": "Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.", - "operationId": "Reservations_ListByBillingAccount", - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "#/parameters/SkipTokenParameter" - }, - { - "$ref": "#/parameters/RefreshSummaryParameter" - }, - { - "$ref": "#/parameters/SelectedStateParameter" - }, - { - "$ref": "#/parameters/TakeParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ReservationsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "tags": [ - "Reservations" - ], - "x-ms-examples": { - "reservationsListByBillingAccount": { - "$ref": "./examples/reservationsListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations": { - "get": { - "tags": [ - "Reservations" - ], - "x-ms-examples": { - "ReservationsListByBillingProfile": { - "$ref": "./examples/reservationsListByBillingProfile.json" - } - }, - "operationId": "Reservations_ListByBillingProfile", - "description": "Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.", - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "#/parameters/SkipTokenParameter" - }, - { - "$ref": "#/parameters/RefreshSummaryParameter" - }, - { - "$ref": "#/parameters/SelectedStateParameter" - }, - { - "$ref": "#/parameters/TakeParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ReservationsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations/{reservationId}": { - "get": { - "summary": "Get Reservation details in the billing account.", - "description": "Get specific Reservation details in the billing account.", - "operationId": "Reservations_GetByReservationOrder", - "x-ms-examples": { - "reservationGetByBillingAccount": { - "$ref": "./examples/reservationGetByBillingAccount.json" - }, - "reservationGetByBillingAccountSingleScope": { - "$ref": "./examples/reservationGetByBillingAccountSingleScope.json" - }, - "reservationGetByBillingAccountSingleResourceGroup": { - "$ref": "./examples/reservationGetByBillingAccountSingleResourceGroup.json" - }, - "reservationGetByBillingAccountManagementGroup": { - "$ref": "./examples/reservationGetByBillingAccountManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/ReservationOrderIdParameter" - }, - { - "$ref": "#/parameters/ReservationIdParameter" - }, - { - "$ref": "#/parameters/ExpandParameter" - } - ], - "tags": [ - "Reservation" - ], - "responses": { - "200": { - "description": "Get `Reservation` details.", - "schema": { - "$ref": "#/definitions/Reservation" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Update reservation by billing account.", - "operationId": "Reservations_UpdateByBillingAccount", - "tags": [ - "Reservation" - ], - "x-ms-examples": { - "ReservationUpdate": { - "$ref": "./examples/reservationUpdateByBillingAccount.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/ReservationOrderIdParameter" - }, - { - "$ref": "#/parameters/ReservationIdParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/PatchParameter" - } - ], - "responses": { - "200": { - "description": "The request is completed.", - "schema": { - "$ref": "#/definitions/Reservation" - } - }, - "202": { - "description": "The request is accepted.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "URL for checking the ongoing status of the operation." - }, - "Location": { - "type": "string", - "description": "URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned." - }, - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "Clients should wait for the Retry-After interval before polling again" - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations": { - "get": { - "summary": "Get Reservations in a given reservation Order in the billing account", - "description": "List Reservations within a single ReservationOrder in the billing account.", - "operationId": "Reservations_ListByReservationOrder", - "x-ms-examples": { - "reservationsGetFromOrderByBillingAccount": { - "$ref": "./examples/reservationsGetFromOrderByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/ReservationOrderIdParameter" - } - ], - "tags": [ - "Reservations" - ], - "responses": { - "200": { - "description": "List `Reservation`s within a single `ReservationOrder`.", - "schema": { - "$ref": "#/definitions/ReservationList" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}": { - "get": { - "summary": "Get a specific ReservationOrder in the billing account.", - "description": "Get the details of the ReservationOrder in the billing account.", - "operationId": "ReservationOrders_GetByBillingAccount", - "x-ms-examples": { - "reservationOrderGetByBillingAccount": { - "$ref": "./examples/reservationOrderGetByBillingAccount.json" - }, - "reservationOrderGetByBillingAccountWithExpandPlanInformation": { - "$ref": "./examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "#/parameters/ReservationOrderIdParameter" - }, - { - "$ref": "#/parameters/ExpandParameter" - } - ], - "tags": [ - "ReservationOrder" - ], - "responses": { - "200": { - "description": "Get the details of the `ReservationOrder`.", - "schema": { - "$ref": "#/definitions/ReservationOrder" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders": { - "get": { - "summary": "Get all `ReservationOrders in the billing account.", - "description": "List all the `ReservationOrders in the billing account.", - "operationId": "ReservationOrders_ListByBillingAccount", - "x-ms-examples": { - "reservationOrderListByBillingAccount": { - "$ref": "./examples/reservationOrdersListByBillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "#/parameters/SkipTokenParameter" - } - ], - "tags": [ - "ReservationOrders" - ], - "responses": { - "200": { - "description": "List of ReservationOrders", - "schema": { - "$ref": "#/definitions/ReservationOrderList" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ReservationOrder": { - "type": "object", - "description": "Details of a reservation order being returned.", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "etag": { - "type": "integer", - "format": "int32" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ReservationOrderProperty", - "description": "The properties associated to this reservation order", - "type": "object" - }, - "tags": { - "description": "Tags for this reservation", - "$ref": "#/definitions/Tags" - } - } - }, - "Reservation": { - "type": "object", - "description": "The definition of the reservation.", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "x-ms-azure-resource": true, - "properties": { - "location": { - "description": "The location of the reservation.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "etag": { - "type": "integer", - "format": "int32" - }, - "properties": { - "$ref": "#/definitions/ReservationProperty", - "description": "The properties associated to this reservation", - "type": "object", - "x-ms-client-flatten": true - }, - "tags": { - "description": "Tags for this reservation", - "$ref": "#/definitions/Tags" - }, - "sku": { - "$ref": "#/definitions/ReservationSkuProperty", - "description": "The sku information associated to this reservation", - "type": "object" - } - } - }, - "ReservationAppliedScope": { - "description": "Reservation applied scope", - "readOnly": true, - "type": "string" - }, - "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": { - "description": "The term of the reservation, e.g. P1Y", - "readOnly": true, - "type": "string" - }, - "provisioningState": { - "description": "The provisioning state of the reservation, e.g. Succeeded", - "readOnly": true, - "type": "string" - }, - "billingPlan": { - "$ref": "#/definitions/ReservationBillingPlan" - }, - "planInformation": { - "$ref": "#/definitions/ReservationOrderBillingPlanInformation" - }, - "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" - }, - "productCode": { - "$ref": "#/definitions/ProductCode" - } - } - }, - "ReservationProperty": { - "type": "object", - "description": "The property of reservation object.", - "properties": { - "reservedResourceType": { - "description": "The reserved source type of the reservation, e.g. virtual machine.", - "readOnly": true, - "type": "string" - }, - "instanceFlexibility": { - "description": "Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.", - "$ref": "#/definitions/InstanceFlexibility" - }, - "displayName": { - "description": "The display name of the reservation", - "readOnly": true, - "type": "string" - }, - "appliedScopes": { - "description": "The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope", - "items": { - "$ref": "#/definitions/ReservationAppliedScope" - }, - "type": "array" - }, - "appliedScopeType": { - "description": "The applied scope type of the reservation.", - "readOnly": true, - "type": "string" - }, - "archived": { - "description": "Indicates if the reservation is archived", - "type": "boolean" - }, - "capabilities": { - "description": "Capabilities of the reservation", - "type": "string" - }, - "quantity": { - "description": "The number of the reservation.", - "readOnly": true, - "type": "number" - }, - "provisioningState": { - "description": "The provisioning state of the reservation, e.g. Succeeded", - "readOnly": true, - "type": "string" - }, - "effectiveDateTime": { - "description": "The effective date time of the reservation", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "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": { - "description": "The expiry date of the reservation", - "readOnly": true, - "type": "string" - }, - "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": { - "description": "The sku description of the reservation", - "readOnly": true, - "type": "string" - }, - "extendedStatusInfo": { - "description": "The message giving detailed information about the status code.", - "$ref": "#/definitions/ReservationExtendedStatusInfo" - }, - "billingPlan": { - "description": "The billing plan options available for this sku.", - "$ref": "#/definitions/ReservationBillingPlan" - }, - "displayProvisioningState": { - "description": "The provisioning state of the reservation for display, e.g. Succeeded", - "readOnly": true, - "type": "string" - }, - "provisioningSubState": { - "description": "The provisioning state of the reservation, e.g. Succeeded", - "readOnly": true, - "type": "string" - }, - "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" - }, - "mergeProperties": { - "$ref": "#/definitions/ReservationMergeProperties" - }, - "swapProperties": { - "$ref": "#/definitions/ReservationSwapProperties" - }, - "appliedScopeProperties": { - "$ref": "#/definitions/ReservationAppliedScopeProperties" - }, - "billingScopeId": { - "description": "Subscription that will be charged for purchasing reservation or savings plan", - "readOnly": true, - "type": "string" - }, - "renew": { - "description": "The renew state of the reservation", - "readOnly": true, - "type": "boolean" - }, - "renewSource": { - "description": "The renew source of the reservation", - "readOnly": true, - "type": "string" - }, - "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" - }, - "term": { - "description": "The term of the reservation, e.g. P1Y", - "readOnly": true, - "type": "string" - }, - "userFriendlyAppliedScopeType": { - "description": "The applied scope type of the reservation for display, e.g. Shared", - "readOnly": true, - "type": "string" - }, - "userFriendlyRenewState": { - "description": "The renew state of the reservation for display, e.g. On", - "readOnly": true, - "type": "string" - }, - "utilization": { - "readOnly": true, - "type": "object", - "description": "Reservation utilization", - "x-ms-client-flatten": true, - "properties": { - "trend": { - "description": "last 7 day utilization trend for a reservation", - "readOnly": true, - "type": "string" - }, - "aggregates": { - "description": "The array of aggregates of a reservation's utilization", - "type": "array", - "items": { - "$ref": "#/definitions/ReservationUtilizationAggregates" - }, - "x-ms-identifiers": [] - } - } - }, - "productCode": { - "$ref": "#/definitions/ProductCode" - } - } - }, - "ReservationSkuProperty": { - "type": "object", - "description": "The property of reservation sku object.", - "properties": { - "name": { - "description": "The name of the reservation sku.", - "readOnly": true, - "type": "string" - } - } - }, - "ReservationsListResult": { - "type": "object", - "description": "The list of reservations and summary of roll out count of reservations in each state.", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "readOnly": true, - "type": "string" - }, - "summary": { - "$ref": "#/definitions/ReservationSummary", - "description": "The roll out count summary of the reservations", - "type": "object" - }, - "value": { - "description": "The list of reservations.", - "items": { - "$ref": "#/definitions/Reservation" - }, - "readOnly": true, - "type": "array" - } - } - }, - "ReservationOrderList": { - "type": "object", - "description": "List of ReservationOrders", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ReservationOrder" - } - }, - "nextLink": { - "type": "string", - "description": "Url to get the next page of reservationOrders." - } - } - }, - "ReservationList": { - "type": "object", - "description": "List of `Reservations", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Reservation" - } - }, - "nextLink": { - "type": "string", - "description": "Url to get the next page of reservations." - } - } - }, - "ReservationSummary": { - "description": "The roll up count summary of reservations in each state", - "properties": { - "cancelledCount": { - "description": "The number of reservation in Cancelled state", - "readOnly": true, - "type": "number" - }, - "expiredCount": { - "description": "The number of reservation in Expired state", - "readOnly": true, - "type": "number" - }, - "expiringCount": { - "description": "The number of reservation in Expiring state", - "readOnly": true, - "type": "number" - }, - "failedCount": { - "description": "The number of reservation in Failed state", - "readOnly": true, - "type": "number" - }, - "pendingCount": { - "description": "The number of reservation in Pending state", - "readOnly": true, - "type": "number" - }, - "succeededCount": { - "description": "The number of reservation in Succeeded state", - "readOnly": true, - "type": "number" - }, - "noBenefitCount": { - "description": "The number of reservation in 'No Benefit' state", - "readOnly": true, - "type": "number" - }, - "warningCount": { - "description": "The number of reservation in Warning state", - "readOnly": true, - "type": "number" - }, - "processingCount": { - "description": "The number of reservation in Processing state", - "readOnly": true, - "type": "number" - } - }, - "type": "object" - }, - "ReservationUtilizationAggregates": { - "description": "The aggregate values of reservation utilization", - "properties": { - "grain": { - "description": "The grain of the aggregate", - "readOnly": true, - "type": "number" - }, - "grainUnit": { - "description": "The grain unit of the aggregate", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "The aggregate value", - "readOnly": true, - "type": "number" - }, - "valueUnit": { - "description": "The aggregate value unit", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "RenewPropertiesResponse": { - "type": "object", - "description": "The renew properties for a reservation.", - "properties": { - "purchaseProperties": { - "$ref": "#/definitions/ReservationPurchaseRequest" - }, - "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." - } - } - }, - "ReservationPurchaseRequest": { - "type": "object", - "description": "The request for reservation purchase", - "properties": { - "sku": { - "$ref": "#/definitions/SkuName" - }, - "location": { - "type": "string", - "description": "The Azure region where the reserved resource lives.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ReservationPurchaseRequestProperties" - } - } - }, - "Patch": { - "type": "object", - "description": "The request for reservation patch", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PatchProperties" - }, - "sku": { - "$ref": "#/definitions/ReservationSkuProperty", - "description": "The sku information associated to this reservation", - "type": "object" - }, - "tags": { - "description": "Tags for this reservation", - "$ref": "#/definitions/Tags" - } - } - }, - "PatchProperties": { - "type": "object", - "description": "Properties for reservation patch", - "properties": { - "appliedScopeType": { - "$ref": "#/definitions/AppliedScopeType" - }, - "appliedScopeProperties": { - "$ref": "#/definitions/ReservationAppliedScopeProperties" - }, - "instanceFlexibility": { - "$ref": "#/definitions/InstanceFlexibility" - }, - "displayName": { - "type": "string", - "description": "Display name of the reservation" - }, - "renew": { - "$ref": "#/definitions/Renew" - }, - "renewProperties": { - "type": "object", - "x-ms-client-flatten": true, - "properties": { - "purchaseProperties": { - "$ref": "#/definitions/ReservationPurchaseRequest" - } - } - }, - "reviewDateTime": { - "type": "string", - "format": "date-time", - "description": "This is the date-time when the Azure hybrid benefit needs to be reviewed." - } - } - }, - "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" - } - } - }, - "SkuName": { - "type": "object", - "description": "The name of sku", - "properties": { - "name": { - "type": "string" - } - } - }, - "ReservationPurchaseRequestProperties": { - "type": "object", - "description": "Properties of reservation purchase request", - "properties": { - "reservedResourceType": { - "description": "The reserved source type of the reservation, e.g. virtual machine.", - "readOnly": true, - "type": "string" - }, - "billingScopeId": { - "type": "string", - "readOnly": true, - "description": "Subscription that will be charged for purchasing reservation or savings plan" - }, - "term": { - "description": "The term of the reservation, e.g. P1Y", - "readOnly": true, - "type": "string" - }, - "billingPlan": { - "$ref": "#/definitions/ReservationBillingPlan" - }, - "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" - }, - "appliedScopes": { - "$ref": "#/definitions/AppliedScopes" - }, - "appliedScopeProperties": { - "$ref": "#/definitions/ReservationAppliedScopeProperties" - }, - "renew": { - "$ref": "#/definitions/Renew" - }, - "reservedResourceProperties": { - "type": "object", - "description": "Properties specific to each reserved resource type. Not required if not applicable.", - "x-ms-client-flatten": true, - "properties": { - "instanceFlexibility": { - "$ref": "#/definitions/InstanceFlexibility" - } - } - }, - "instanceFlexibility": { - "description": "Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.", - "$ref": "#/definitions/InstanceFlexibility" - }, - "reviewDateTime": { - "type": "string", - "format": "date-time", - "description": "This is the date-time when the Azure hybrid benefit needs to be reviewed." - } - } - }, - "ReservationBillingPlan": { - "type": "string", - "description": "Represent the billing plans.", - "enum": [ - "Upfront", - "Monthly" - ], - "x-ms-enum": { - "name": "ReservationBillingPlan", - "modelAsString": true - } - }, - "AppliedScopeType": { - "type": "string", - "description": "Type of the Applied Scope.", - "enum": [ - "Single", - "Shared", - "ManagementGroup" - ], - "x-ms-enum": { - "name": "AppliedScopeType", - "modelAsString": true - } - }, - "AppliedScopes": { - "type": "array", - "description": "List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared.", - "items": { - "type": "string", - "minItems": 1, - "maxItems": 1 - }, - "x-ms-identifiers": [] - }, - "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" - } - } - }, - "Renew": { - "type": "boolean", - "default": false, - "description": "Setting this to true will automatically purchase a new reservation on the expiration date time." - }, - "Tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource Tags" - }, - "ProductCode": { - "type": "string", - "description": "Represents UPN" - }, - "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 - } - }, - "ReservationExtendedStatusInfo": { - "type": "object", - "description": "Extended status information for the reservation.", - "properties": { - "statusCode": { - "$ref": "#/definitions/ReservationStatusCode" - }, - "message": { - "type": "string", - "description": "The message giving detailed information about the status code." - }, - "properties": { - "description": "Properties for extended status information", - "$ref": "#/definitions/ExtendedStatusDefinitionProperties" - } - } - }, - "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 - } - }, - "ExtendedStatusDefinitionProperties": { - "type": "object", - "description": "Extended status definition properties", - "properties": { - "subscriptionId": { - "type": "string", - "description": "Subscription Id" - } - } - }, - "ReservationSplitProperties": { - "type": "object", - "description": "Properties of reservation split", - "properties": { - "splitDestinations": { - "type": "array", - "items": { - "type": "string" - }, - "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}" - }, - "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}" - } - } - }, - "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", - "items": { - "type": "string" - }, - "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}" - } - } - }, - "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}" - } - } - }, - "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": [] - } - } - }, - "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" - }, - "extendedStatusInfo": { - "$ref": "#/definitions/ReservationExtendedStatusInfo" - } - } - }, - "PaymentStatus": { - "type": "string", - "description": "Describes whether the payment is completed, failed, cancelled or scheduled in the future.", - "enum": [ - "Succeeded", - "Failed", - "Scheduled", - "Cancelled", - "Pending", - "Completed" - ], - "x-ms-enum": { - "name": "PaymentStatus", - "modelAsString": true - } - } - }, - "parameters": { - "ExpandParameter": { - "name": "expand", - "description": "May be used to expand the detail information of some properties.", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "string" - }, - "SkipTokenParameter": { - "name": "skiptoken", - "description": "The number of reservations to skip from the list before returning results", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "number" - }, - "TakeParameter": { - "name": "take", - "description": "The number of reservations to return in API response.", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "number" - }, - "SelectedStateParameter": { - "name": "selectedState", - "description": "The selected provisioning state", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "string" - }, - "RefreshSummaryParameter": { - "name": "refreshSummary", - "description": "To indicate whether to refresh the roll up counts of the reservations group by provisioning states", - "in": "query", - "x-ms-parameter-location": "method", - "required": false, - "type": "string" - }, - "ReservationIdParameter": { - "name": "reservationId", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "description": "Id of the reservation item" - }, - "ReservationOrderIdParameter": { - "name": "reservationOrderId", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "description": "Order Id of the reservation" - }, - "PatchParameter": { - "name": "body", - "in": "body", - "x-ms-parameter-location": "method", - "required": true, - "description": "Request body for patching a reservation", - "schema": { - "$ref": "#/definitions/Patch" - } - } - }, - "securityDefinitions": { - "azure_auth": { - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow.", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - } -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/transaction.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/transaction.json deleted file mode 100644 index 94aee97b8143..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/transaction.json +++ /dev/null @@ -1,862 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transactions": { - "get": { - "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/" - }, - "operationId": "Transactions_ListByCustomer", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "in": "query", - "name": "periodStartDate", - "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", - "required": true, - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "periodEndDate", - "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", - "required": true, - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "type", - "description": "The type of transaction.", - "required": true, - "type": "string", - "enum": [ - "Other", - "Billed", - "Unbilled" - ], - "x-ms-enum": { - "name": "TransactionType", - "modelAsString": true - } - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of transactions.", - "schema": { - "$ref": "#/definitions/TransactionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/invoiceSections/{invoiceSectionName}/transactions": { - "get": { - "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/" - }, - "operationId": "Transactions_ListByInvoiceSection", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "in": "query", - "name": "periodStartDate", - "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", - "required": true, - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "periodEndDate", - "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", - "required": true, - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "type", - "description": "The type of transaction.", - "required": true, - "type": "string", - "enum": [ - "Other", - "Billed", - "Unbilled" - ], - "x-ms-enum": { - "name": "TransactionType", - "modelAsString": true - } - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of transactions.", - "schema": { - "$ref": "#/definitions/TransactionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/transactions": { - "get": { - "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/" - }, - "operationId": "Transactions_ListByBillingProfile", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "in": "query", - "name": "periodStartDate", - "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", - "required": true, - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "periodEndDate", - "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", - "required": true, - "type": "string", - "format": "date" - }, - { - "in": "query", - "name": "type", - "description": "The type of transaction.", - "required": true, - "type": "string", - "enum": [ - "Other", - "Billed", - "Unbilled" - ], - "x-ms-enum": { - "name": "TransactionType", - "modelAsString": true - } - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of transactions.", - "schema": { - "$ref": "#/definitions/TransactionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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}/invoices/{invoiceName}/transactions": { - "get": { - "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/" - }, - "operationId": "Transactions_ListByInvoice", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "$ref": "./types.json#/parameters/filter" - }, - { - "$ref": "./types.json#/parameters/orderBy" - }, - { - "$ref": "./types.json#/parameters/top" - }, - { - "$ref": "./types.json#/parameters/skip" - }, - { - "$ref": "./types.json#/parameters/count" - }, - { - "$ref": "./types.json#/parameters/search" - } - ], - "responses": { - "200": { - "description": "The list of transactions.", - "schema": { - "$ref": "#/definitions/TransactionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "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": { - "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/" - }, - "operationId": "Transactions_TransactionsDownloadByInvoice", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "schema": { - "$ref": "#/definitions/DocumentDownloadResult" - } - }, - "202": { - "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", - "headers": { - "Location": { - "type": "string" - }, - "Retry-After": { - "type": "integer", - "format": "int32" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "TransactionsDownloadByInvoice": { - "$ref": "./examples/transactionsDownloadByInvoice.json" - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactionSummary": { - "get": { - "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/" - }, - "operationId": "Transactions_GetTransactionSummaryByInvoice", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/invoiceName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - }, - { - "in": "query", - "name": "filter", - "description": "The filter query option allows clients to filter the line items that are aggregated to create the line item summary.", - "type": "string" - }, - { - "in": "query", - "name": "search", - "description": "The search query option allows clients to filter the line items that are aggregated to create the line item summary.", - "type": "string" - } - ], - "responses": { - "200": { - "description": "A transaction summary.", - "schema": { - "$ref": "#/definitions/TransactionSummary" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "TransactionSummaryGetByInvoice": { - "$ref": "./examples/transactionSummaryGetByInvoice.json" - } - } - } - } - }, - "definitions": { - "DocumentDownloadResult": { - "description": "A secure URL that can be used to download a an entity until the URL expires.", - "type": "object", - "properties": { - "expiryTime": { - "description": "The time in UTC when the download URL will expire.", - "type": "string", - "readOnly": true - }, - "url": { - "description": "The URL to the PDF or .zip file.", - "type": "string", - "readOnly": true - } - } - }, - "RefundTransactionDetails": { - "description": "The refund details of a transaction.", - "type": "object", - "properties": { - "amountRequested": { - "description": "The amount of refund requested.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "amountRefunded": { - "description": "The amount refunded.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "refundOperationId": { - "description": "The ID of refund operation.", - "type": "string" - } - } - }, - "Transaction": { - "description": "A transaction.", - "type": "object", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/TransactionProperties" - } - }, - "x-ms-azure-resource": true - }, - "TransactionListResult": { - "description": "A container for a list of resources", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Transaction" - }, - "readOnly": true, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "TransactionProperties": { - "description": "A transaction.", - "type": "object", - "properties": { - "azureCreditApplied": { - "description": "The amount of any Azure credits automatically applied to this transaction.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "azurePlan": { - "description": "Details of the Azure plan.", - "type": "string" - }, - "billingCurrency": { - "description": "The ISO 4217 code for the currency in which this transaction is billed.", - "type": "string" - }, - "billingProfileDisplayName": { - "description": "The name of the billing profile." - }, - "billingProfileId": { - "description": "The fully qualified ID that uniquely identifies a billing profile.", - "type": "string" - }, - "consumptionCommitmentDecremented": { - "description": "The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "customerDisplayName": { - "description": "The name of the customer.", - "type": "string" - }, - "customerId": { - "description": "The fully qualified ID that uniquely identifies a customer.", - "type": "string" - }, - "creditType": { - "description": "The credit type of the transaction. Applies only to credited transactions.", - "enum": [ - "Other", - "AzureFreeCredit", - "AzureCreditOffer", - "ServiceInterruption", - "Refund" - ], - "type": "string", - "x-ms-enum": { - "name": "CreditType", - "modelAsString": true - } - }, - "date": { - "format": "date-time", - "description": "The date of transaction.", - "type": "string" - }, - "discount": { - "description": "The percentage discount, if any, applied to this transaction.", - "type": "number" - }, - "effectivePrice": { - "description": "The price of the product after applying any discounts.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "exchangeRate": { - "description": "The exchange rate used to convert charged amount to billing currency, if applicable.", - "type": "number" - }, - "invoice": { - "description": "Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed.", - "type": "string" - }, - "invoiceId": { - "description": "The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.", - "type": "string" - }, - "invoiceSectionDisplayName": { - "description": "The name of the invoice section.", - "type": "string" - }, - "invoiceSectionId": { - "description": "The fully qualified ID that uniquely identifies an invoice section.", - "type": "string" - }, - "isThirdParty": { - "description": "Whether or not the transaction is third party.", - "type": "boolean" - }, - "kind": { - "description": "Type of the transaction, billed or unbilled.", - "enum": [ - "Other", - "All", - "Reservation" - ], - "type": "string", - "x-ms-enum": { - "name": "TransactionKind", - "modelAsString": true - } - }, - "marketPrice": { - "description": "The retail price of the product.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "partNumber": { - "description": "The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices.", - "type": "string" - }, - "pricingCurrency": { - "description": "The ISO 4217 code for the currency in which the product is priced.", - "type": "string" - }, - "productDescription": { - "description": "The description of the product for which the transaction took place.", - "type": "string" - }, - "productFamily": { - "description": "The family of the product for which the transaction took place.", - "type": "string" - }, - "productTypeId": { - "description": "The ID of the product type for which the transaction took place.", - "type": "string" - }, - "productType": { - "description": "The type of the product for which the transaction took place.", - "type": "string" - }, - "quantity": { - "format": "int32", - "description": "The quantity purchased in the transaction.", - "type": "integer" - }, - "reasonCode": { - "description": "There reason code for the transaction.", - "type": "string" - }, - "servicePeriodStartDate": { - "format": "date-time", - "description": "The date of the purchase of the product, or the start date of the month in which usage started.", - "type": "string" - }, - "servicePeriodEndDate": { - "format": "date-time", - "description": "The end date of the product term, or the end date of the month in which usage ended.", - "type": "string" - }, - "subTotal": { - "description": "The pre-tax charged amount for the transaction.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "tax": { - "description": "The tax amount applied to the transaction.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "transactionAmount": { - "description": "The charge associated with the transaction.", - "allOf": [ - { - "$ref": "./types.json#/definitions/Amount" - } - ] - }, - "transactionType": { - "description": "The type of transaction.", - "type": "string" - }, - "units": { - "description": "The number of units used for a given product.", - "type": "number" - }, - "unitOfMeasure": { - "description": "The unit of measure used to bill for the product. For example, compute services are billed per hour.", - "type": "string" - }, - "unitType": { - "description": "The description for the unit of measure for a given product.", - "type": "string" - }, - "specialTaxationType": { - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "SpecialTaxationType", - "modelAsString": true - } - }, - "refundTransactionDetails": { - "description": "The refund details of a transaction.", - "allOf": [ - { - "$ref": "#/definitions/RefundTransactionDetails" - } - ] - } - } - }, - "TransactionSummary": { - "description": "A transaction summary.", - "type": "object", - "properties": { - "azureCreditApplied": { - "description": "The total amount of any Azure credits applied.", - "type": "number", - "readOnly": true - }, - "billingCurrency": { - "description": "The ISO 4217 code for the currency in which the transactions are billed.", - "type": "string", - "readOnly": true - }, - "consumptionCommitmentDecremented": { - "description": "The total Microsoft Azure Consumption Commitment (MACC) decrement through the invoice.", - "type": "number", - "readOnly": true - }, - "subTotal": { - "description": "The total pre-tax charged amount.", - "type": "number", - "readOnly": true - }, - "tax": { - "description": "The total tax amount applied.", - "type": "number", - "readOnly": true - }, - "total": { - "description": "The total charges.", - "type": "number", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/transfers.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/transfers.json deleted file mode 100644 index 72a1f86d28ea..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/transfers.json +++ /dev/null @@ -1,1225 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2024-04-01", - "title": "BillingManagementClient", - "description": "Billing client provides access to billing resources for Azure subscriptions." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}": { - "get": { - "tags": [ - "Transfers" - ], - "description": "Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", - "operationId": "Transfers_Get", - "x-ms-examples": { - "TransferGet": { - "$ref": "./examples/transfersGet.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Details of transfer.", - "schema": { - "$ref": "#/definitions/TransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "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.", - "operationId": "Transfers_Initiate", - "x-ms-examples": { - "InitiateTransfer": { - "$ref": "./examples/transfersInitiate.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/InitiateTransferRequest" - }, - "description": "Request parameters that are provided to the initiate transfer operation." - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Initiated transfer details.", - "schema": { - "$ref": "#/definitions/TransferDetails" - } - }, - "201": { - "description": "Initiated transfer details.", - "schema": { - "$ref": "#/definitions/TransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}/cancel": { - "post": { - "tags": [ - "Transfers" - ], - "description": "Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", - "operationId": "Transfers_Cancel", - "x-ms-examples": { - "TransferCancel": { - "$ref": "./examples/transfersCancel.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Details of canceled transfer.", - "schema": { - "$ref": "#/definitions/TransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers": { - "get": { - "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.", - "operationId": "Transfers_List", - "x-ms-examples": { - "TransfersList": { - "$ref": "./examples/transfersList.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/invoiceSectionName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of transfers initiated from this invoice section.", - "schema": { - "$ref": "#/definitions/TransferDetailsListResult" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}": { - "get": { - "tags": [ - "Transfers" - ], - "description": "Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", - "operationId": "PartnerTransfers_Get", - "x-ms-examples": { - "PartnerTransferGet": { - "$ref": "./examples/partnerTransfersGet.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Details of transfer.", - "schema": { - "$ref": "#/definitions/PartnerTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "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.", - "operationId": "PartnerTransfers_Initiate", - "x-ms-examples": { - "InitiatePartnerTransfer": { - "$ref": "./examples/partnerTransfersInitiate.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PartnerInitiateTransferRequest" - }, - "description": "Request parameters that are provided to the initiate transfer operation." - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Initiated transfer details.", - "schema": { - "$ref": "#/definitions/PartnerTransferDetails" - } - }, - "201": { - "description": "Initiated transfer details.", - "schema": { - "$ref": "#/definitions/PartnerTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}/cancel": { - "post": { - "tags": [ - "Transfers" - ], - "description": "Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", - "operationId": "PartnerTransfers_Cancel", - "x-ms-examples": { - "PartnerTransferCancel": { - "$ref": "./examples/partnerTransfersCancel.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Details of canceled transfer.", - "schema": { - "$ref": "#/definitions/PartnerTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers": { - "get": { - "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.", - "operationId": "PartnerTransfers_List", - "x-ms-examples": { - "PartnerTransfersList": { - "$ref": "./examples/partnerTransfersList.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/billingAccountName" - }, - { - "$ref": "./types.json#/parameters/billingProfileName" - }, - { - "$ref": "./types.json#/parameters/customerName" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of transfers initiated from this invoice section.", - "schema": { - "$ref": "#/definitions/PartnerTransferDetailsListResult" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/transfers/{transferName}/accept": { - "post": { - "tags": [ - "RecipientTransfers" - ], - "summary": "Accepts a transfer request.", - "operationId": "RecipientTransfers_Accept", - "x-ms-examples": { - "AcceptTransfer": { - "$ref": "./examples/recipientTransfersAccept.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AcceptTransferRequest" - }, - "description": "Request parameters that are provided to the accept transfer operation." - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Details of the accepted transfer.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/transfers/{transferName}/validate": { - "post": { - "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.", - "operationId": "RecipientTransfers_Validate", - "x-ms-examples": { - "ValidateTransfer": { - "$ref": "./examples/recipientTransfersValidate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AcceptTransferRequest" - }, - "description": "Request parameters that are provided to the validate transfer operation." - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Results of the transfer validation.", - "schema": { - "$ref": "#/definitions/ValidateTransferListResponse" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/transfers/{transferName}/decline": { - "post": { - "tags": [ - "RecipientTransfers" - ], - "summary": "Declines a transfer request.", - "operationId": "RecipientTransfers_Decline", - "x-ms-examples": { - "DeclineTransfer": { - "$ref": "./examples/recipientTransfersDecline.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Details of the declined transfer.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/transfers/{transferName}": { - "get": { - "tags": [ - "RecipientTransfers" - ], - "summary": "Gets a transfer request by ID. The caller must be the recipient of the transfer request.", - "operationId": "RecipientTransfers_Get", - "x-ms-examples": { - "RecipientTransferGet": { - "$ref": "./examples/recipientTransfersGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/transferNameParameter" - }, - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Details of the transfers with given Id.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/transfers": { - "get": { - "tags": [ - "RecipientTransfers" - ], - "summary": "Lists the transfer requests received by the caller.", - "operationId": "RecipientTransfers_List", - "x-ms-examples": { - "RecipientTransfersList": { - "$ref": "./examples/recipientTransfersList.json" - } - }, - "parameters": [ - { - "$ref": "./types.json#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of transfers received by caller.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetailsListResult" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/TransferItemQueryParameter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "InitiateTransferRequest": { - "type": "object", - "description": "Request parameters to initiate transfer.", - "properties": { - "properties": { - "description": "Request parameters to initiate transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/InitiateTransferProperties" - } - } - }, - "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." - } - } - }, - "PartnerInitiateTransferRequest": { - "type": "object", - "description": "Request parameters to initiate partner transfer.", - "properties": { - "properties": { - "description": "Request parameters to initiate partner transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/PartnerInitiateTransferProperties" - } - } - }, - "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." - } - } - }, - "AcceptTransferRequest": { - "type": "object", - "description": "Request parameters to accept transfer.", - "properties": { - "properties": { - "description": "Request parameters to accept transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AcceptTransferProperties" - } - } - }, - "AcceptTransferProperties": { - "type": "object", - "description": "Request parameters to accept transfer.", - "properties": { - "productDetails": { - "description": "Request parameters to accept transfer.", - "type": "array", - "items": { - "$ref": "#/definitions/ProductDetails" - }, - "x-ms-identifiers": [] - } - } - }, - "ProductDetails": { - "type": "object", - "description": "Details of the product that is transferred.", - "properties": { - "productType": { - "description": "Type of the product that is transferred.", - "$ref": "#/definitions/ProductType" - }, - "productId": { - "type": "string", - "description": "The ID of the product that is transferred." - } - } - }, - "ProductType": { - "type": "string", - "description": "The type of product that is transferred.", - "enum": [ - "AzureSubscription", - "AzureReservation", - "Department", - "SavingsPlan", - "SAAS" - ], - "x-ms-enum": { - "name": "productType", - "modelAsString": true - } - }, - "TransferDetails": { - "type": "object", - "description": "Details of the transfer.", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "description": "Details of the transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/TransferProperties" - } - } - }, - "PartnerTransferDetails": { - "type": "object", - "description": "Details of the transfer.", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "description": "Details of the transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/PartnerTransferProperties" - } - } - }, - "RecipientTransferDetails": { - "type": "object", - "description": "Details of the transfer.", - "allOf": [ - { - "$ref": "./types.json#/definitions/ProxyResourceWithTags" - } - ], - "properties": { - "properties": { - "description": "Details of the transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RecipientTransferProperties" - } - } - }, - "DetailedTransferStatus": { - "type": "object", - "description": "Detailed transfer status.", - "properties": { - "productType": { - "type": "string", - "$ref": "#/definitions/ProductType", - "readOnly": true, - "description": "Type of product that is transferred." - }, - "productId": { - "type": "string", - "readOnly": true, - "description": "The ID of the product that is transferred." - }, - "productName": { - "type": "string", - "readOnly": true, - "description": "The name of the product that is transferred." - }, - "skuDescription": { - "type": "string", - "readOnly": true, - "description": "The SKU of the product that is transferred." - }, - "transferStatus": { - "type": "string", - "$ref": "#/definitions/ProductTransferStatus", - "readOnly": true, - "description": "Transfer status." - }, - "errorDetails": { - "description": "Error details for transfer execution.", - "$ref": "#/definitions/TransferError" - } - } - }, - "TransferError": { - "type": "object", - "description": "Error details for transfer execution.", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Error code." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Error message." - } - } - }, - "EligibleProductType": { - "type": "string", - "description": "Type of the products that can be transferred.", - "enum": [ - "DevTestAzureSubscription", - "StandardAzureSubscription", - "AzureReservation" - ], - "x-ms-enum": { - "name": "eligibleProductType", - "modelAsString": true - } - }, - "TransferProperties": { - "description": "Transfer details", - "type": "object", - "properties": { - "expirationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The time at which the transfer request expires." - }, - "transferStatus": { - "type": "string", - "$ref": "#/definitions/TransferStatus", - "description": "Overall transfer status.", - "readOnly": true - }, - "recipientEmailId": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user to whom the transfer request was sent." - }, - "initiatorEmailId": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user who sent the transfer request." - }, - "canceledBy": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user who canceled the transfer request." - }, - "detailedTransferStatus": { - "type": "array", - "readOnly": true, - "description": "Detailed transfer status.", - "items": { - "$ref": "#/definitions/DetailedTransferStatus" - }, - "x-ms-identifiers": [] - } - } - }, - "PartnerTransferProperties": { - "description": "Transfer Details.", - "type": "object", - "properties": { - "expirationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The time at which the transfer request expires." - }, - "transferStatus": { - "type": "string", - "$ref": "#/definitions/TransferStatus", - "description": "Overall transfer status.", - "readOnly": true - }, - "recipientEmailId": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user to whom the transfer request was sent." - }, - "initiatorCustomerType": { - "type": "string", - "$ref": "#/definitions/InitiatorCustomerType", - "description": "The type of customer who sent the transfer request.", - "readOnly": true - }, - "initiatorEmailId": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user who sent the transfer request." - }, - "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", - "readOnly": true, - "description": "The email ID of the user who canceled the transfer request." - }, - "detailedTransferStatus": { - "type": "array", - "readOnly": true, - "description": "Detailed transfer status.", - "items": { - "$ref": "#/definitions/DetailedTransferStatus" - }, - "x-ms-identifiers": [] - } - } - }, - "RecipientTransferProperties": { - "description": "Transfer Details.", - "type": "object", - "properties": { - "expirationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The time at which the transfer request expires." - }, - "allowedProductType": { - "type": "array", - "readOnly": true, - "description": "Type of subscriptions that can be transferred.", - "items": { - "$ref": "#/definitions/EligibleProductType" - } - }, - "transferStatus": { - "type": "string", - "$ref": "#/definitions/TransferStatus", - "description": "Overall transfer status.", - "readOnly": true - }, - "recipientEmailId": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user to whom the transfer request was sent." - }, - "initiatorEmailId": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user who sent the transfer request." - }, - "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": { - "type": "string", - "description": "The type of customer who sent the transfer request.", - "$ref": "#/definitions/InitiatorCustomerType", - "readOnly": true - }, - "canceledBy": { - "type": "string", - "readOnly": true, - "description": "The email ID of the user who canceled the transfer request." - }, - "detailedTransferStatus": { - "type": "array", - "readOnly": true, - "description": "Detailed transfer status.", - "items": { - "$ref": "#/definitions/DetailedTransferStatus" - }, - "x-ms-identifiers": [] - }, - "customerTenantId": { - "type": "string", - "description": "The customer tenant id.", - "readOnly": true - }, - "supportedAccounts": { - "type": "array", - "readOnly": true, - "description": "List of supported account types.", - "items": { - "$ref": "#/definitions/SupportedAccountType" - } - } - } - }, - "InitiatorCustomerType": { - "type": "string", - "description": "The type of customer of the transfer initiator.", - "enum": [ - "Partner", - "EA" - ], - "x-ms-enum": { - "name": "initiatorCustomerType", - "modelAsString": true - } - }, - "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 - } - }, - "ProductTransferStatus": { - "type": "string", - "description": "The status of a transfer.", - "enum": [ - "NotStarted", - "InProgress", - "Completed", - "Failed" - ], - "x-ms-enum": { - "name": "productTransferStatus", - "modelAsString": true - } - }, - "PartnerTransferDetailsListResult": { - "type": "object", - "description": "The list of transfers initiated by partner.", - "properties": { - "value": { - "description": "The list of transfers initiated by partner.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/PartnerTransferDetails" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "RecipientTransferDetailsListResult": { - "type": "object", - "description": "The list of transfers received by caller.", - "properties": { - "value": { - "description": "The list of transfers received by caller.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "TransferDetailsListResult": { - "type": "object", - "description": "The list of transfers initiated by caller.", - "properties": { - "value": { - "description": "The list of transfers initiated by caller.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/TransferDetails" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "ValidateTransferResponse": { - "type": "object", - "description": "Transfer validation response.", - "properties": { - "properties": { - "description": "The properties of transfer validation response.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ValidateTransferResponseProperties" - } - } - }, - "ValidateTransferListResponse": { - "type": "object", - "description": "Result of transfer validation.", - "properties": { - "value": { - "description": "The list of transfer validation results.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ValidateTransferResponse" - }, - "x-ms-identifiers": [] - } - } - }, - "ValidateTransferResponseProperties": { - "type": "object", - "description": "The properties of transfer validation response.", - "properties": { - "status": { - "description": "The status of validation", - "type": "string", - "readOnly": true - }, - "productId": { - "description": "The product id for which this result applies.", - "type": "string", - "readOnly": true - }, - "results": { - "description": "The array of validation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ValidationResultProperties" - }, - "x-ms-identifiers": [] - } - } - }, - "ValidationResultProperties": { - "type": "object", - "description": "The properties of the validation result.", - "properties": { - "level": { - "description": "Result Level.", - "type": "string", - "readOnly": true - }, - "code": { - "description": "Result Code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The validation message.", - "type": "string", - "readOnly": true - } - } - }, - "SupportedAccountType": { - "type": "string", - "description": "The supported account types.", - "enum": [ - "None", - "Partner", - "Individual", - "Enterprise" - ], - "x-ms-enum": { - "name": "supportedAccountType", - "modelAsString": true - } - }, - "TransferItemQueryParameter": { - "description": "Query parameter to enumerate transfer requests.", - "type": "object", - "properties": { - "state": { - "description": "State of the transfer request query filter.", - "type": "string" - } - } - } - }, - "parameters": { - "transferNameParameter": { - "name": "transferName", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "description": "The ID that uniquely identifies a transfer request.", - "pattern": "^[a-z0-9]*$" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/types.json b/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/types.json deleted file mode 100644 index 25a8fe7bbeba..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/Billing/stable/2024-04-01/types.json +++ /dev/null @@ -1,363 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BillingManagementClient", - "description": "Documentation for Microsoft.Billing.", - "contact": { - "name": "Microsoft.Billing", - "url": "https://learn.microsoft.com/en-us/rest/api/billing/", - "email": "pacebpexphot@microsoft.com" - }, - "version": "2024-04-01" - }, - "paths": {}, - "definitions": { - "ProxyResourceWithTags": { - "description": "Common fields that are returned in the response for all Azure Resource Manager resources.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "tags": { - "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 < > % & \\ ? /", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "x-ms-azure-resource": true - }, - "Amount": { - "description": "The amount.", - "type": "object", - "properties": { - "currency": { - "description": "The currency for the amount value.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.", - "type": "number", - "readOnly": true - } - }, - "readOnly": true - }, - "AddressDetails": { - "description": "Address details.", - "required": [ - "addressLine1", - "country" - ], - "type": "object", - "properties": { - "addressLine1": { - "description": "Address line 1.", - "minLength": 1, - "type": "string" - }, - "addressLine2": { - "description": "Address line 2.", - "type": "string" - }, - "addressLine3": { - "description": "Address line 3.", - "type": "string" - }, - "city": { - "description": "Address city.", - "type": "string" - }, - "companyName": { - "description": "Company name. Optional for MCA Individual (Pay-as-you-go).", - "type": "string" - }, - "country": { - "description": "Country code uses ISO 3166-1 Alpha-2 format.", - "minLength": 1, - "type": "string" - }, - "district": { - "description": "Address district.", - "type": "string" - }, - "email": { - "description": "Email address.", - "type": "string" - }, - "firstName": { - "description": "First name. Optional for MCA Enterprise.", - "type": "string" - }, - "lastName": { - "description": "Last name. Optional for MCA Enterprise.", - "type": "string" - }, - "middleName": { - "description": "Middle name.", - "type": "string" - }, - "phoneNumber": { - "description": "Phone number.", - "type": "string" - }, - "postalCode": { - "description": "Postal code.", - "type": "string" - }, - "region": { - "description": "Address region.", - "type": "string" - }, - "isValidAddress": { - "description": "Indicates if the address is incomplete.", - "type": "boolean" - } - } - }, - "AzurePlan": { - "description": "Details of the Azure plan.", - "type": "object", - "properties": { - "productId": { - "description": "The ID that uniquely identifies a product.", - "type": "string" - }, - "skuId": { - "description": "The ID that uniquely identifies a sku.", - "type": "string" - }, - "skuDescription": { - "description": "The sku description.", - "type": "string" - } - } - }, - "IndirectRelationshipInfo": { - "description": "Identifies the billing profile that is linked to another billing profile in indirect purchase motion.", - "type": "object", - "properties": { - "billingAccountName": { - "description": "The billing account name of the partner or the customer for an indirect motion.", - "type": "string" - }, - "billingProfileName": { - "description": "The billing profile name of the partner or the customer for an indirect motion.", - "type": "string" - }, - "displayName": { - "description": "The display name of the partner or customer for an indirect motion.", - "type": "string" - } - } - }, - "PatchResource": { - "description": "Common fields that are in the patch method request body of all Azure Resource Manager patch resources.", - "type": "object" - }, - "Reseller": { - "description": "Details of the reseller.", - "type": "object", - "properties": { - "resellerId": { - "description": "The MPN ID of the reseller.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The name of the reseller.", - "type": "string", - "readOnly": true - } - }, - "readOnly": true - } - }, - "parameters": { - "billingAccountName": { - "in": "path", - "name": "billingAccountName", - "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})?)$", - "x-ms-parameter-location": "method" - }, - "apiVersionParameter": { - "in": "query", - "name": "api-version", - "description": "The version of the API to be used with the client request. The current version is 2024-04-01.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "associatedTenantName": { - "in": "path", - "name": "associatedTenantName", - "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}$", - "x-ms-parameter-location": "method" - }, - "filter": { - "in": "query", - "name": "filter", - "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "orderBy": { - "in": "query", - "name": "orderBy", - "description": "The orderby query option allows clients to request resources in a particular order.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "top": { - "in": "query", - "name": "top", - "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.", - "type": "integer", - "format": "int64", - "x-ms-parameter-location": "method" - }, - "skip": { - "in": "query", - "name": "skip", - "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.", - "type": "integer", - "format": "int64", - "x-ms-parameter-location": "method" - }, - "count": { - "in": "query", - "name": "count", - "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", - "type": "boolean", - "x-ms-parameter-location": "method" - }, - "search": { - "in": "query", - "name": "search", - "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.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingProfileName": { - "in": "path", - "name": "billingProfileName", - "description": "The ID that uniquely identifies a billing profile.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z\\d-_]{1,128}$", - "x-ms-parameter-location": "method" - }, - "customerName": { - "in": "path", - "name": "customerName", - "description": "The ID that uniquely identifies a customer.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z\\d-_]{1,128}$", - "x-ms-parameter-location": "method" - }, - "invoiceSectionName": { - "in": "path", - "name": "invoiceSectionName", - "description": "The ID that uniquely identifies an invoice section.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z\\d-_]{1,128}$", - "x-ms-parameter-location": "method" - }, - "departmentName": { - "in": "path", - "name": "departmentName", - "description": "The name of the department.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z\\d-_]{1,128}$", - "x-ms-parameter-location": "method" - }, - "enrollmentAccountName": { - "in": "path", - "name": "enrollmentAccountName", - "description": "The name of the enrollment account.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z\\d-_]{1,128}$", - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "in": "path", - "name": "subscriptionId", - "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}$", - "x-ms-parameter-location": "client" - }, - "billingRequestName": { - "in": "path", - "name": "billingRequestName", - "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}$", - "x-ms-parameter-location": "method" - }, - "billingRoleAssignmentName": { - "in": "path", - "name": "billingRoleAssignmentName", - "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})?$", - "x-ms-parameter-location": "method" - }, - "roleDefinitionName": { - "in": "path", - "name": "roleDefinitionName", - "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}$", - "x-ms-parameter-location": "method" - }, - "invoiceName": { - "in": "path", - "name": "invoiceName", - "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})$", - "x-ms-parameter-location": "method" - }, - "productName": { - "in": "path", - "name": "productName", - "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}$", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - } -} diff --git a/specification/billing/resource-manager/Microsoft.Billing/Billing/tspconfig.yaml b/specification/billing/resource-manager/Microsoft.Billing/Billing/tspconfig.yaml new file mode 100644 index 000000000000..9b7d68163c45 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/Billing/tspconfig.yaml @@ -0,0 +1,47 @@ +parameters: + service-dir: + default: "sdk/billing" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + omit-unreachable-types: true + emitter-output-dir: "{project-root}" + output-file: "{version-status}/{version}/openapi.json" + emit-lro-options: "all" + arm-types-dir: "{project-root}/../../../../common-types/resource-management" + examples-dir: "{project-root}/examples" + "@azure-tools/typespec-python": + emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-billing" + namespace: "azure.mgmt.billing" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-billing" + namespace: "com.azure.resourcemanager.billing" + service-name: "Billing" + enable-sync-stack: true + flavor: azure + use-object-for-unknown: true + float32-as-double: false + "@azure-tools/typespec-ts": + emitter-output-dir: "{output-dir}/{service-dir}/arm-billing" + compatibility-lro: true + flavor: "azure" + experimental-extensible-enums: true + package-details: + name: "@azure/arm-billing" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/billing" + emitter-output-dir: "{output-dir}/{service-dir}/armbilling" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/armbilling" + fix-const-stuttering: false + flavor: "azure" + generate-samples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager"