Certificates - List
Description for Get all certificates for a subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates?api-version=2022-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates?api-version=2022-03-01&$filter={$filter}
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
|
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
|
api-version
|
query | True |
|
API Version |
|
$filter
|
query |
|
Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId' |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
App Service error response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
List Certificates for subscription
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/certificates?api-version=2022-03-01
Sample Response
{
"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"
}
}
]
}
Definitions
| Certificate |
SSL certificate for an app. |
|
Certificate |
Collection of certificates. |
|
Default |
App Service error response. |
| Details | |
| Error |
Error model. |
|
Hosting |
Specification for an App Service Environment to use for this resource. |
|
Key |
Status of the Key Vault secret. |
Certificate
SSL certificate for an app.
| Name | Type | Description |
|---|---|---|
| id |
|
Resource Id. |
| kind |
|
Kind of resource. |
| location |
|
Resource Location. |
| name |
|
Resource Name. |
| properties.canonicalName |
|
CNAME of the certificate to be issued via free certificate |
| properties.cerBlob |
|
Raw bytes of .cer file |
| properties.domainValidationMethod |
|
Method of domain validation for free cert |
| properties.expirationDate |
|
Certificate expiration date. |
| properties.friendlyName |
|
Friendly name of the certificate. |
| properties.hostNames |
|
Host names the certificate applies to. |
| properties.hostingEnvironmentProfile |
Specification for the App Service Environment to use for the certificate. |
|
| properties.issueDate |
|
Certificate issue Date. |
| properties.issuer |
|
Certificate issuer. |
| properties.keyVaultId |
|
Key Vault Csm resource Id. |
| properties.keyVaultSecretName |
|
Key Vault secret name. |
| properties.keyVaultSecretStatus |
Status of the Key Vault secret. |
|
| properties.password |
|
Certificate password. |
| properties.pfxBlob |
|
Pfx blob. |
| properties.publicKeyHash |
|
Public key hash. |
| properties.selfLink |
|
Self link. |
| properties.serverFarmId |
|
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
| properties.siteName |
|
App name. |
| properties.subjectName |
|
Subject name of the certificate. |
| properties.thumbprint |
|
Certificate thumbprint. |
| properties.valid |
|
Is the certificate valid?. |
| tags |
|
Resource tags. |
| type |
|
Resource type. |
CertificateCollection
Collection of certificates.
| Name | Type | Description |
|---|---|---|
| nextLink |
|
Link to next page of resources. |
| value |
Collection of resources. |
DefaultErrorResponse
App Service error response.
| Name | Type | Description |
|---|---|---|
| error |
Error model. |
Details
| Name | Type | Description |
|---|---|---|
| code |
|
Standardized string to programmatically identify the error. |
| message |
|
Detailed error description and debugging information. |
| target |
|
Detailed error description and debugging information. |
Error
Error model.
| Name | Type | Description |
|---|---|---|
| code |
|
Standardized string to programmatically identify the error. |
| details |
|
Detailed errors. |
| innererror |
|
More information to debug error. |
| message |
|
Detailed error description and debugging information. |
| target |
|
Detailed error description and debugging information. |
HostingEnvironmentProfile
Specification for an App Service Environment to use for this resource.
| Name | Type | Description |
|---|---|---|
| id |
|
Resource ID of the App Service Environment. |
| name |
|
Name of the App Service Environment. |
| type |
|
Resource type of the App Service Environment. |
KeyVaultSecretStatus
Status of the Key Vault secret.
| Name | Type | Description |
|---|---|---|
| AzureServiceUnauthorizedToAccessKeyVault |
|
|
| CertificateOrderFailed |
|
|
| ExternalPrivateKey |
|
|
| Initialized |
|
|
| KeyVaultDoesNotExist |
|
|
| KeyVaultSecretDoesNotExist |
|
|
| OperationNotPermittedOnKeyVault |
|
|
| Succeeded |
|
|
| Unknown |
|
|
| UnknownError |
|
|
| WaitingOnCertificateOrder |
|