Products - List By Customer
Enumera los productos de un cliente. Estos no incluyen productos facturados en función del uso. La operación solo se admite para las cuentas de facturación con el tipo de contrato Microsoft Partner Agreement.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products?api-version=2024-04-01&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
billing
|
path | True |
string pattern: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$ |
Identificador que identifica de forma única una cuenta de facturación. |
customer
|
path | True |
string pattern: ^[a-zA-Z\d-_]{1,128}$ |
Identificador que identifica de forma única a un cliente. |
api-version
|
query | True |
string |
Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2024-04-01. |
count
|
query |
boolean |
La opción de consulta count permite a los clientes solicitar un recuento de los recursos coincidentes incluidos con los recursos de la respuesta. |
|
filter
|
query |
string |
La opción de consulta de filtro permite a los clientes filtrar una colección de recursos que se abordan mediante una dirección URL de solicitud. |
|
order
|
query |
string |
La opción de consulta orderby permite a los clientes solicitar recursos en un orden determinado. |
|
search
|
query |
string |
La opción de consulta de búsqueda permite a los clientes solicitar elementos dentro de una colección que coincida con una expresión de búsqueda de texto libre. la búsqueda solo se admite para campos de cadena. |
|
skip
|
query |
integer (int64) |
La opción omitir consulta solicita el número de elementos de la colección consultada que se omitirán y no se incluirán en el resultado. |
|
top
|
query |
integer (int64) |
La opción de consulta superior solicita el número de elementos de la colección consultada que se incluirán en el resultado. El valor máximo admitido para top es 50. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Lista de productos. Contiene una lista de resúmenes de productos disponibles en orden cronológico inverso por fecha de compra. |
|
Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Ejemplos
ProductsListByCustomer
Solicitud de ejemplo
Respuesta de muestra
{
"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",
"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",
"customerDisplayName": "Customer1",
"displayName": "My Product",
"skuId": "0002",
"skuDescription": "Microsoft Azure Standard",
"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",
"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",
"customerDisplayName": "Customer1",
"displayName": "Test Product",
"skuId": "0002",
"skuDescription": "Microsoft Azure Standard",
"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",
"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",
"customerDisplayName": "Customer1",
"displayName": "Dev Test Product",
"skuId": "0001",
"skuDescription": "Domain Name Registration ORG",
"status": "Active"
},
"type": "Microsoft.Billing/billingAccounts/products"
}
]
}
Definiciones
Nombre | Description |
---|---|
Auto |
Indica si la renovación automática está activada o desactivada para un producto. |
created |
Tipo de identidad que creó el recurso. |
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Last |
El último mes cobra. |
Product |
Un producto. |
Product |
Un contenedor para obtener una lista de recursos |
Product |
Un producto. |
Product |
Estado del producto. |
Reseller |
Detalles del revendedor. |
system |
Metadatos relativos a la creación y última modificación del recurso. |
AutoRenew
Indica si la renovación automática está activada o desactivada para un producto.
Valor | Description |
---|---|
Off | |
On |
createdByType
Tipo de identidad que creó el recurso.
Valor | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Detalles del error. |
|
message |
string |
Mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
LastCharge
El último mes cobra.
Nombre | Tipo | Description |
---|---|---|
currency |
string |
Moneda del valor de la cantidad. |
value |
number |
Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00. |
Product
Un producto.
Nombre | Tipo | Description |
---|---|---|
id |
string (arm-id) |
Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Nombre del recurso |
properties |
Un producto. |
|
systemData |
Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy. |
|
tags |
object |
Diccionario de metadatos asociados al recurso. Es posible que no se rellene para todos los tipos de recursos. Longitud máxima de clave/valor admitida de 256 caracteres. Las claves y el valor no deben estar vacíos ni null. Las claves no pueden contener <> % & \ ? / |
type |
string |
Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ProductListResult
Un contenedor para obtener una lista de recursos
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Vínculo (url) a la página siguiente de resultados. |
value |
Product[] |
Lista de recursos. |
ProductProperties
Un producto.
Nombre | Tipo | Description |
---|---|---|
autoRenew |
Indica si la renovación automática está activada o desactivada para un producto. |
|
availabilityId |
string |
Disponibilidad del producto. |
billingFrequency |
string |
Frecuencia con la que se facturará el producto. |
billingProfileDisplayName |
string |
Nombre del perfil de facturación al que se factura el producto. |
billingProfileId |
string |
Identificador del perfil de facturación al que se factura el producto. |
customerDisplayName |
string |
Nombre del cliente para el que se compró el producto. El campo solo es aplicable a la cuenta de facturación del Contrato de partners de Microsoft. |
customerId |
string |
Identificador del cliente para el que se compró el producto. El campo solo es aplicable a la cuenta de facturación del Contrato de partners de Microsoft. |
displayName |
string |
Nombre para mostrar del producto. |
endDate |
string |
Fecha en la que se renovará o cancelará el producto. |
invoiceSectionDisplayName |
string |
Nombre de la sección de factura a la que se factura el producto. |
invoiceSectionId |
string |
Identificador de la sección de factura a la que se factura el producto. |
lastCharge |
El último mes cobra. |
|
lastChargeDate |
string |
Fecha del último cargo. |
productType |
string |
Descripción del tipo de producto. |
productTypeId |
string |
Identificador del tipo de producto. |
purchaseDate |
string |
Fecha en que se compró el producto. |
quantity |
integer (int64) |
Cantidad comprada para el producto. |
reseller |
Revendedor para este producto. Los campos no están disponibles para los productos del Contrato de partners de Microsoft. |
|
skuDescription |
string |
Descripción de la SKU del producto. |
skuId |
string |
Identificador de SKU del producto. |
status |
Estado del producto. |
|
tenantId |
string |
Identificador del inquilino en el que se usa el producto. |
ProductStatus
Estado del producto.
Valor | Description |
---|---|
Active | |
AutoRenew | |
Canceled | |
Deleted | |
Disabled | |
Expired | |
Expiring | |
Other | |
PastDue | |
Suspended |
Reseller
Detalles del revendedor.
Nombre | Tipo | Description |
---|---|---|
description |
string |
Nombre del revendedor. |
resellerId |
string |
Identificador de MPN del revendedor. |
systemData
Metadatos relativos a la creación y última modificación del recurso.
Nombre | Tipo | Description |
---|---|---|
createdAt |
string (date-time) |
Marca de tiempo de creación de recursos (UTC). |
createdBy |
string |
Identidad que creó el recurso. |
createdByType |
Tipo de identidad que creó el recurso. |
|
lastModifiedAt |
string (date-time) |
Marca de tiempo de la última modificación del recurso (UTC) |
lastModifiedBy |
string |
Identidad que modificó por última vez el recurso. |
lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso. |