Partilhar via

Subscription - List

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

Lista todas as subscrições da instância do serviço Gestão de API.

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
serviceName
 path True

string

O nome do serviço Gestão de API.

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

string

O ID da subscrição de destino.
api-version
 query True

string

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

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| nome | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| displayName | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| stateComment | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| ownerId | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| âmbito | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| userId | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| productId | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| estado | filtro | eq | |
| utilizador | expandir | | |
$skip
 query

integer

int32

Número de registos a ignorar.
$top
 query

integer

int32

Número de registos a devolver.

Respostas

Name Tipo Description
200 OK

SubscriptionCollection

Uma coleção das entidades subscrição da instância de serviço Gestão de API especificada.
Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual 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

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ApiManagementListSubscriptions

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5600b59475ff190048070001",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "state": "active",
        "createdDate": "2015-09-22T01:57:40.3Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "56eaed3dbaf08b06e46d27fe",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "displayName": "Starter",
        "state": "active",
        "createdDate": "2016-03-17T17:45:33.837Z",
        "startDate": "2016-03-17T00:00:00Z",
        "expirationDate": "2016-04-01T00:00:00Z",
        "notificationDate": "2016-03-20T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5931a769d8d14f0ad8ce13b8",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
        "displayName": "Unlimited",
        "state": "submitted",
        "createdDate": "2017-06-02T17:59:06.223Z"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definições

Name Description
ErrorFieldContract

Contrato de Campo de Erro.
ErrorResponse

Resposta do Erro.
SubscriptionCollection

Representação da lista de Subscrições Paginadas.
SubscriptionContract

Detalhes da subscrição.
SubscriptionState

Estado da subscrição. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.

ErrorFieldContract

Contrato de Campo de Erro.

Name Tipo Description
code

string

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

string

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

string

Nome da propriedade.

ErrorResponse

Resposta do Erro.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.
error.details

ErrorFieldContract[]

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

string

Representação legível por humanos do erro.

SubscriptionCollection

Representação da lista de Subscrições Paginadas.

Name Tipo Description
count

integer

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

string

Ligação da página seguinte, se existir.
value

SubscriptionContract[]

Valores de página.

SubscriptionContract

Detalhes da subscrição.

Name Tipo Description
id

string

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

string

O nome do recurso
properties.allowTracing

boolean

Determina se o rastreio está ativado
properties.createdDate

string

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

string

O nome da subscrição ou nulo se a subscrição não tiver nome.
properties.endDate

string

Data em que a subscrição foi cancelada ou expirou. A definição destina-se apenas a fins de auditoria e a subscrição não é cancelada automaticamente. O ciclo de vida da subscrição pode ser gerido com a state propriedade . A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
properties.expirationDate

string

Data de expiração da subscrição. A definição destina-se apenas a fins de auditoria e a subscrição não expira automaticamente. O ciclo de vida da subscrição pode ser gerido com a state propriedade . A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
properties.notificationDate

string

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

string

O identificador de recurso do utilizador do proprietário da subscrição. O valor é um URL relativo válido no formato de /users/{userId} em que {userId} é um identificador de utilizador.
properties.primaryKey

string

Chave primária da subscrição. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.
properties.scope

string

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

string

Chave secundária da subscrição. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.
properties.startDate

string

Data de ativação da subscrição. A definição destina-se apenas a fins de auditoria e a subscrição não é ativada automaticamente. O ciclo de vida da subscrição pode ser gerido com a state propriedade . A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
properties.state

SubscriptionState

Estado da subscrição. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.
properties.stateComment

string

Comentário de subscrição opcional adicionado por um administrador quando o estado é alterado para "rejeitado".
type

string

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

SubscriptionState

Estado da subscrição. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.

Name Tipo Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string