Compartilhar via


Certificate - List By Service

Lista uma coleção de todos os certificados na instância de serviço especificada.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
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.

Padrão Regex: ^[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 |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| impressão digital | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |

$skip
query

integer

int32

Número de registros a serem ignorados.

$top
query

integer

int32

Número de registros a serem retornados.

isKeyVaultRefreshFailed
query

boolean

Quando definida como true, a resposta contém apenas entidades de certificados que falharam na atualização.

Respostas

Nome Tipo Description
200 OK

CertificateCollection

Retorna uma coleção de entidade Certificate.

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.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementListCertificates

Solicitação de exemplo

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

Resposta de exemplo

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1",
      "type": "Microsoft.ApiManagement/service/certificates",
      "name": "templateCert1",
      "properties": {
        "subject": "CN=mutual-authcert",
        "thumbprint": "EBA************************48594A6",
        "expirationDate": "2017-04-23T17:03:41Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
      "type": "Microsoft.ApiManagement/service/certificates",
      "name": "templateCertkv",
      "properties": {
        "subject": "CN=*.msitesting.net",
        "thumbprint": "EA**********************9AD690",
        "expirationDate": "2037-01-01T07:00:00Z",
        "keyVault": {
          "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
          "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
          "lastStatus": {
            "code": "Success",
            "timeStampUtc": "2020-09-22T00:24:53.3191468Z"
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definições

Nome Description
CertificateCollection

Representação da lista certificados paginados.

CertificateContract

Detalhes do certificado.

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

KeyVaultLastAccessStatusContractProperties

Emitir propriedades de atualização de contrato.

CertificateCollection

Representação da lista certificados paginados.

Nome Tipo Description
count

integer

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

nextLink

string

Link da próxima página, se houver.

value

CertificateContract[]

Valores de página.

CertificateContract

Detalhes do certificado.

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.expirationDate

string

Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.keyVault

KeyVaultContractProperties

Detalhes do local do KeyVault do certificado.

properties.subject

string

Atributo de assunto do certificado.

properties.thumbprint

string

Impressão digital do certificado.

type

string

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

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.

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

Nome Tipo Description
identityClientId

string

Nulo para SystemAssignedIdentity ou ID do cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves.

lastStatus

KeyVaultLastAccessStatusContractProperties

Última vez, sincronize e atualize status de segredo do cofre de chaves.

secretIdentifier

string

Identificador de segredo do cofre de chaves para busca de segredo. Fornecer um segredo com controle de versão impedirá a atualização automática. Isso requer que Gerenciamento de API serviço seja configurado com aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Emitir propriedades de atualização de contrato.

Nome Tipo Description
code

string

Último status código para sincronização e atualização do segredo do cofre de chaves.

message

string

Detalhes do erro, caso contrário, vazios.

timeStampUtc

string

Última vez que o segredo foi acessado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.