App Service Certificate Orders - Create Or Update Certificate

Referencia

Service:: App Service

API Version:: 2023-12-01

Descripción para Crea o actualiza un certificado y se asocia con el secreto del almacén de claves.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
certificateOrderName	path	True	string	Nombre del pedido de certificado.
name	path	True	string	Nombre del certificado.
resourceGroupName	path	True	string	Nombre del grupo de recursos al que pertenece el recurso. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versión de la API

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación del recurso.
kind		string	Tipo de recurso.
properties.keyVaultId		string	Key Vault id. de recurso.
properties.keyVaultSecretName		string	Key Vault nombre del secreto.
tags		object	Etiquetas del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	AppServiceCertificateResource	App Service se crea el certificado.
201 Created	AppServiceCertificateResource	App Service operación de creación de certificados está en curso
Other Status Codes	DefaultErrorResponse	App Service respuesta de error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Create Certificate

Sample Request

HTTP

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

{
  "location": "Global",
  "properties": {
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
    "keyVaultSecretName": "SampleSecretName1"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1",
  "name": "SampleCertName1",
  "type": "Microsoft.CertificateRegistration/certificateOrders/certificates",
  "location": "Global",
  "properties": {
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
    "keyVaultSecretName": "SampleSecretName1",
    "provisioningState": "Succeeded"
  }
}

Status code:: 201

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1",
  "name": "SampleCertName1",
  "type": "Microsoft.CertificateRegistration/certificateOrders/certificates",
  "location": "Global",
  "properties": {
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
    "keyVaultSecretName": "SampleSecretName1",
    "provisioningState": "Succeeded"
  }
}

Definiciones

Nombre	Description
AppServiceCertificateResource	Key Vault recurso arm de contenedor para un certificado adquirido a través de Azure.
DefaultErrorResponse	App Service respuesta de error.
Details
Error	Modelo de error.
KeyVaultSecretStatus	Estado del secreto de Key Vault.

AppServiceCertificateResource

Key Vault recurso arm de contenedor para un certificado adquirido a través de Azure.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.keyVaultId	string	Key Vault id. de recurso.
properties.keyVaultSecretName	string	Key Vault nombre del secreto.
properties.provisioningState	KeyVaultSecretStatus	Estado del secreto de Key Vault.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso.

DefaultErrorResponse

App Service respuesta de error.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

KeyVaultSecretStatus

Estado del secreto de Key Vault.

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

Share via