PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}/?api-version=2023-01-01
Description for Create or update a certificate.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the certificate. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName |
String | Yes |
Name of the resource group to which the resource belongs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id. |
name |
String | No |
Resource Name. |
properties |
Object | No |
CertificatePatchResource resource specific properties |
properties.hostingEnvironmentProfile |
Object | No |
Specification for an App Service Environment to use for this resource. |
properties.hostingEnvironmentProfile.id |
String | No |
Resource ID of the App Service Environment. |
properties.hostingEnvironmentProfile.name |
String | No |
Name of the App Service Environment. |
properties.hostingEnvironmentProfile.type |
String | No |
Resource type of the App Service Environment. |
properties.keyVaultId |
String | No |
Key Vault Csm resource Id. |
properties.friendlyName |
String | No |
Friendly name of the certificate. |
properties.subjectName |
String | No |
Subject name of the certificate. |
properties.issueDate |
String | No |
Certificate issue Date. |
properties.keyVaultSecretStatus |
String | No |
Status of the Key Vault secret. Possible values:
|
properties.cerBlob |
String | No |
Raw bytes of .cer file |
properties.keyVaultSecretName |
String | No |
Key Vault secret name. |
properties.serverFarmId |
String | No |
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
properties.expirationDate |
String | No |
Certificate expiration date. |
properties.publicKeyHash |
String | No |
Public key hash. |
properties.hostNames[] |
Array | No |
Host names the certificate applies to. |
properties.selfLink |
String | No |
Self link. |
properties.thumbprint |
String | No |
Certificate thumbprint. |
properties.canonicalName |
String | No |
CNAME of the certificate to be issued via free certificate |
properties.pfxBlob |
String | No |
Pfx blob. |
properties.password |
String | No |
Certificate password. |
properties.issuer |
String | No |
Certificate issuer. |
properties.siteName |
String | No |
App name. |
properties.valid |
Boolean | No |
Is the certificate valid?. |
properties.domainValidationMethod |
String | No |
Method of domain validation for free cert |
type |
String | No |
Resource type. |
kind |
String | No |
Kind of resource. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.