App Service Certificate Orders - Create Or Update Certificate

Odwołanie

Service:: App Service

API Version:: 2023-12-01

Opis tworzenia lub aktualizowania certyfikatu i kojarzy się z wpisem tajnym magazynu kluczy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
certificateOrderName	path	True	string	Nazwa zamówienia certyfikatu.
name	path	True	string	Nazwa certyfikatu.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-0000000000000000000000000000000000000000 00000).
api-version	query	True	string	Wersja interfejsu API

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu.
kind		string	Rodzaj zasobu.
properties.keyVaultId		string	Key Vault identyfikator zasobu.
properties.keyVaultSecretName		string	Key Vault nazwę wpisu tajnego.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AppServiceCertificateResource	App Service zostanie utworzony certyfikat.
201 Created	AppServiceCertificateResource	App Service Operacja tworzenia certyfikatu jest w toku
Other Status Codes	DefaultErrorResponse	App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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"
  }
}

Definicje

Nazwa	Opis
AppServiceCertificateResource	Key Vault zasób usługi ARM kontenera dla certyfikatu zakupionego za pośrednictwem platformy Azure.
DefaultErrorResponse	App Service odpowiedź na błąd.
Details
Error	Model błędu.
KeyVaultSecretStatus	Stan wpisu tajnego Key Vault.

AppServiceCertificateResource

Key Vault zasób usługi ARM kontenera dla certyfikatu zakupionego za pośrednictwem platformy Azure.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.keyVaultId	string	Key Vault identyfikator zasobu.
properties.keyVaultSecretName	string	Key Vault nazwę wpisu tajnego.
properties.provisioningState	KeyVaultSecretStatus	Stan wpisu tajnego Key Vault.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat błędu debugowania.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

KeyVaultSecretStatus

Stan wpisu tajnego Key Vault.

Nazwa	Typ	Opis
AzureServiceUnauthorizedToAccessKeyVault	string
CertificateOrderFailed	string
ExternalPrivateKey	string
Initialized	string
KeyVaultDoesNotExist	string
KeyVaultSecretDoesNotExist	string
OperationNotPermittedOnKeyVault	string
Succeeded	string
Unknown	string
UnknownError	string
WaitingOnCertificateOrder	string