App Service Certificate Orders - Renew

Service:

App Service

API Version:

2023-12-01

Description for Renew an existing certificate order.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/renew?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
certificateOrderName	path	True	string	Name of the certificate order.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Type	Description
kind	string	Kind of resource.
properties.csr	string	Csr to be used for re-key operation.
properties.isPrivateKeyExternal	boolean	Should we change the ASC type (from managed private key to external private key and vice versa).
properties.keySize	integer	Certificate Key Size.

Responses

Name	Type	Description
204 No Content		No Content
Other Status Codes	DefaultErrorResponse	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

Renew App Service Certificate Order

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/renew?api-version=2023-12-01

{
  "properties": {
    "keySize": 2048,
    "csr": "CSR1223238Value",
    "isPrivateKeyExternal": false
  }
}

Sample Response

Status code:

204

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
RenewCertificateOrderRequest	Class representing certificate renew request.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

RenewCertificateOrderRequest

Class representing certificate renew request.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.csr	string	Csr to be used for re-key operation.
properties.isPrivateKeyExternal	boolean	Should we change the ASC type (from managed private key to external private key and vice versa).
properties.keySize	integer	Certificate Key Size.
type	string	Resource type.