Certificates - List

Referência

Service:: App Service

API Version:: 2023-12-01

Descrição para Obter todos os certificados de uma assinatura.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates?api-version=2023-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates?api-version=2023-12-01&$filter={$filter}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-0000000000000000000000).
api-version	query	True	string	Versão da API
$filter	query		string	Retornar somente informações especificadas no filtro (usando a sintaxe OData). Por exemplo: $filter=KeyVaultId eq 'KeyVaultId'

Respostas

Nome	Tipo	Description
200 OK	CertificateCollection	OK
Other Status Codes	DefaultErrorResponse	Serviço de Aplicativo resposta de erro.

Segurança

azure_auth

Fluxo do 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

List Certificates for subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/certificates?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282",
      "name": "testc6282",
      "type": "Microsoft.Web/certificates",
      "location": "East US",
      "properties": {
        "friendlyName": "",
        "subjectName": "ServerCert",
        "hostNames": [
          "ServerCert"
        ],
        "issuer": "CACert",
        "issueDate": "2015-11-12T23:40:25+00:00",
        "expirationDate": "2039-12-31T23:59:59+00:00",
        "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE"
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc4912",
      "name": "testc4912",
      "type": "Microsoft.Web/certificates",
      "location": "West US",
      "properties": {
        "friendlyName": "",
        "subjectName": "ServerCert2",
        "hostNames": [
          "ServerCert2"
        ],
        "issuer": "CACert",
        "issueDate": "2015-12-12T23:40:25+00:00",
        "expirationDate": "2040-12-31T23:59:59+00:00",
        "thumbprint": "FE703D7411A44163B6D32B3AD9B0490D5886EBFE"
      }
    }
  ]
}

Definições

Nome	Description
Certificate	Certificado SSL para um aplicativo.
CertificateCollection	Coleção de certificados.
DefaultErrorResponse	Serviço de Aplicativo resposta de erro.
Details
Error	Modelo de erro.
HostingEnvironmentProfile	Especificação de um Ambiente do Serviço de Aplicativo a ser usado para esse recurso.
KeyVaultSecretStatus	Status do segredo Key Vault.

Certificate

Certificado SSL para um aplicativo.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.canonicalName	string	CNAME do certificado a ser emitido por meio de certificado gratuito
properties.cerBlob	string	Bytes brutos do arquivo de .cer
properties.domainValidationMethod	string	Método de validação de domínio para certificado gratuito
properties.expirationDate	string	Data de validade do certificado.
properties.friendlyName	string	Nome amigável do certificado.
properties.hostNames	string[]	Nomes de host aos qual o certificado se aplica.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Especificação para o Ambiente do Serviço de Aplicativo a ser usado para o certificado.
properties.issueDate	string	Data do problema do certificado.
properties.issuer	string	Emissor de certificado.
properties.keyVaultId	string	Key Vault ID do recurso Csm.
properties.keyVaultSecretName	string	Key Vault nome do segredo.
properties.keyVaultSecretStatus	KeyVaultSecretStatus	Status do segredo Key Vault.
properties.password	string	Senha do certificado.
properties.pfxBlob	string	Blob Pfx.
properties.publicKeyHash	string	Hash de chave pública.
properties.selfLink	string	Auto-vinculação.
properties.serverFarmId	string	ID do recurso do plano de Serviço de Aplicativo associado, formatado como: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
properties.siteName	string	Nome do aplicativo.
properties.subjectName	string	Nome da entidade do certificado.
properties.thumbprint	string	Impressão digital do certificado.
properties.valid	boolean	O certificado é válido?.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

CertificateCollection

Coleção de certificados.

Nome	Tipo	Description
nextLink	string	Link para a próxima página de recursos.
value	Certificate[]	Coleção de recursos.

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erro.
target	string	Informações detalhadas de descrição e depuração de erro.

Error

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erro.
target	string	Informações detalhadas de descrição e depuração de erro.

HostingEnvironmentProfile

Especificação de um Ambiente do Serviço de Aplicativo a ser usado para esse recurso.

Nome	Tipo	Description
id	string	ID do recurso do Ambiente do Serviço de Aplicativo.
name	string	Nome do Ambiente do Serviço de Aplicativo.
type	string	Tipo de recurso do Ambiente do Serviço de Aplicativo.

KeyVaultSecretStatus

Status do segredo Key Vault.

Nome	Tipo	Description
AzureServiceUnauthorizedToAccessKeyVault	string
CertificateOrderFailed	string
ExternalPrivateKey	string
Initialized	string
KeyVaultDoesNotExist	string
KeyVaultSecretDoesNotExist	string
OperationNotPermittedOnKeyVault	string
Succeeded	string
Unknown	string
UnknownError	string
WaitingOnCertificateOrder	string