Product Subscriptions - List

Enumera la colección de suscripciones al producto especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01

Parámetros de identificador URI

Name In Required Type Description
productId
path True
  • string

Identificador de producto. Debe ser único en la instancia de servicio de API Management actual.

resourceGroupName
path True
  • string

Nombre del grupo de recursos.

serviceName
path True
  • string

Nombre del servicio API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciales de suscripción que identifican de forma única Microsoft Azure suscripción. El identificador de suscripción forma parte del URI para cada llamada al servicio.

api-version
query True
  • string

Versión de la API que se va a usar con la solicitud de cliente.

$filter
query
  • string

| | de campo Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| name | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ámbito | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filtrar | eq | |
| | de usuario expandir | | |

$skip
query
  • integer
int32

Número de registros que se van a omitir.

$top
query
  • integer
int32

Número de registros que se va a devolver.

Respuestas

Name Type Description
200 OK

Enumera una colección de entidades de suscripción.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

ApiManagementListProductSubscriptions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions?api-version=2021-08-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002",
      "type": "Microsoft.ApiManagement/service/products/subscriptions",
      "name": "5600b57e7e8880006a070002",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002",
        "state": "active",
        "createdDate": "2015-09-22T01:57:18.723Z"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definiciones

ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

SubscriptionCollection

Representación de la lista Suscripciones paginadas.

SubscriptionContract

Detalles de la suscripción.

SubscriptionState

Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida – la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada – el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción ha sido denegada por un administrador, * cancelado – la suscripción ha sido cancelada por el desarrollador o administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.

ErrorFieldContract

Contrato de campo de error.

Name Type Description
code
  • string

Código de error de nivel de propiedad.

message
  • string

Representación legible del error de nivel de propiedad.

target
  • string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Name Type Description
error.code
  • string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message
  • string

Representación legible del error.

SubscriptionCollection

Representación de la lista Suscripciones paginadas.

Name Type Description
count
  • integer

Número total de recuento de registros en todas las páginas.

nextLink
  • string

Vínculo de página siguiente, si existe.

value

Valores de página.

SubscriptionContract

Detalles de la suscripción.

Name Type Description
id
  • string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nombre del recurso.

properties.allowTracing
  • boolean

Determina si el seguimiento está habilitado

properties.createdDate
  • string

Fecha de creación de la suscripción. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

properties.displayName
  • string

Nombre de la suscripción o null si la suscripción no tiene nombre.

properties.endDate
  • string

Fecha en que se canceló o expiró la suscripción. La configuración es solo con fines de auditoría y la suscripción no se cancela automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la state propiedad . La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

properties.expirationDate
  • string

Fecha de expiración de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no expira automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la state propiedad . La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

properties.notificationDate
  • string

Próxima fecha de notificación de expiración de la suscripción. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

properties.ownerId
  • string

Identificador de recurso de usuario del propietario de la suscripción. El valor es una dirección URL relativa válida con el formato /users/{userId} donde {userId} es un identificador de usuario.

properties.primaryKey
  • string

Clave principal de suscripción. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor.

properties.scope
  • string

Ámbito como /products/{productId} o /apis o /apis/{apiId}.

properties.secondaryKey
  • string

Clave secundaria de suscripción. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor.

properties.startDate
  • string

Fecha de activación de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no se activa automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la state propiedad . La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

properties.state

Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida – la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada – el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción ha sido denegada por un administrador, * cancelado – la suscripción ha sido cancelada por el desarrollador o administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.

properties.stateComment
  • string

Comentario de suscripción opcional agregado por un administrador cuando se cambia el estado a "rechazado".

type
  • string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft. Storage/storageAccounts"

SubscriptionState

Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida – la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada – el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción ha sido denegada por un administrador, * cancelado – la suscripción ha sido cancelada por el desarrollador o administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.

Name Type Description
active
  • string
cancelled
  • string
expired
  • string
rejected
  • string
submitted
  • string
suspended
  • string