Product Subscriptions - List

  • Referência
Service:
API Management
API Version:
2022-08-01

Lista a coleção de assinaturas para o produto especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions?api-version=2022-08-01
With optional parameters: 
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=2022-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
productId
 path True

string

Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName
 path True

string

O nome do serviço Gerenciamento de API.

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

string

A ID da assinatura de destino.
api-version
 query True

string

A versão da API a ser usada para esta operação.
$filter
 query

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expanda | | |
$skip
 query

integer

int32

Número de registros a serem ignorados.
$top
 query

integer

int32

Número de registros a serem retornados.

Respostas

Nome Tipo Description
200 OK

SubscriptionCollection

Lista uma coleção de entidades de assinatura.
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementListProductSubscriptions

Sample Request

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

Sample Response

Status code:
200 
{
  "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": ""
}

Definições

Nome Description
ErrorFieldContract

Contrato de campo de erro.
ErrorResponse

Resposta de erro.
SubscriptionCollection

Representação da lista assinaturas paginada.
SubscriptionContract

Detalhes da assinatura.
SubscriptionState

Estado da assinatura. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.

ErrorFieldContract

Contrato de campo de erro.

Nome Tipo Description
code

string

Código de erro no nível da propriedade.
message

string

Representação legível por humanos do erro no nível da propriedade.
target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details

ErrorFieldContract[]

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message

string

Representação legível ao olho humano do erro.

SubscriptionCollection

Representação da lista assinaturas paginada.

Nome Tipo Description
count

integer

Número total de contagem de registros em todas as páginas.
nextLink

string

Próximo link da página, se houver.
value

SubscriptionContract[]

Valores de página.

SubscriptionContract

Detalhes da assinatura.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.allowTracing

boolean

Determina se o rastreamento está habilitado
properties.createdDate

string

Data de criação da assinatura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
properties.displayName

string

O nome da assinatura ou nulo se a assinatura não tiver nenhum nome.
properties.endDate

string

Data em que a assinatura foi cancelada ou expirou. A configuração é somente para fins de auditoria e a assinatura não é cancelada automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a state propriedade . A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
properties.expirationDate

string

Data de validade da assinatura. A configuração é somente para fins de auditoria e a assinatura não expira automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a state propriedade . A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
properties.notificationDate

string

Data de notificação de expiração da assinatura futura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
properties.ownerId

string

O identificador de recurso de usuário do proprietário da assinatura. O valor é uma URL relativa válida no formato /users/{userId} em que {userId} é um identificador de usuário.
properties.primaryKey

string

Chave primária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
properties.scope

string

Escopo como /products/{productId} ou /apis ou /apis/{apiId}.
properties.secondaryKey

string

Chave secundária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
properties.startDate

string

Data de ativação da assinatura. A configuração é somente para fins de auditoria e a assinatura não é ativada automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a state propriedade . A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
properties.state

SubscriptionState

Estado da assinatura. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.
properties.stateComment

string

Comentário de assinatura opcional adicionado por um administrador quando o estado é alterado para 'rejeitado'.
type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SubscriptionState

Estado da assinatura. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.

Nome Tipo Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string