App Service Certificate Orders - Create Or Update
Opis Twórca lub zaktualizowanie zamówienia zakupu certyfikatu.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}?api-version=2023-12-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
certificate
|
path | True |
string |
Nazwa zamówienia certyfikatu. |
resource
|
path | True |
string |
Nazwa grupy zasobów, do której należy zasób. Regex pattern: |
subscription
|
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. |
properties.productType | True |
Typ produktu certyfikatu. |
|
kind |
string |
Rodzaj zasobu. |
|
properties.autoRenew |
boolean |
|
|
properties.certificates |
<string,
App |
Stan wpisu tajnego Key Vault. |
|
properties.csr |
string |
Ostatnia operacja CSR utworzona dla tego zamówienia. |
|
properties.distinguishedName |
string |
Nazwa wyróżniająca certyfikatu. |
|
properties.keySize |
integer |
Rozmiar klucza certyfikatu. |
|
properties.validityInYears |
integer |
Czas trwania w latach (musi wynosić 1). |
|
tags |
object |
Tagi zasobów. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
App Service zostanie utworzone zamówienie certyfikatu. |
|
201 Created |
App Service operacja tworzenia zamówienia certyfikatu jest w toku |
|
Other Status Codes |
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 order
Sample Request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName?api-version=2023-12-01
{
"location": "Global",
"properties": {
"certificates": {
"SampleCertName1": {
"keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
"keyVaultSecretName": "SampleSecretName1"
},
"SampleCertName2": {
"keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
"keyVaultSecretName": "SampleSecretName2"
}
},
"distinguishedName": "CN=SampleCustomDomain.com",
"validityInYears": 2,
"keySize": 2048,
"productType": "StandardDomainValidatedSsl",
"autoRenew": true
}
}
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName",
"name": "SampleCertificateOrderName",
"type": "Microsoft.CertificateRegistration/certificateOrders",
"location": "Global",
"properties": {
"certificates": {
"SampleCertName1": {
"keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
"keyVaultSecretName": "SampleSecretName1",
"provisioningState": "Succeeded"
},
"SampleCertName2": {
"keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
"keyVaultSecretName": "SampleSecretName2",
"provisioningState": "KeyVaultSecretDoesNotExist"
}
},
"distinguishedName": "CN=SampleCustomDomain.com",
"domainVerificationToken": "awe4163Br6d32r",
"validityInYears": 2,
"keySize": 2048,
"productType": "StandardDomainValidatedSsl",
"autoRenew": true,
"provisioningState": "Succeeded",
"status": "Issued",
"signedCertificate": {
"version": 1232490,
"serialNumber": "sds12424k",
"thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE",
"subject": "CN=CertSubjectName",
"issuer": "CACert",
"signatureAlgorithm": "SHA",
"notAfter": "2022-11-12T23:40:25+00:00",
"notBefore": "2021-11-12T23:40:25+00:00"
},
"csr": "xdf!x|",
"intermediate": {
"version": 5589220,
"serialNumber": "k45kad0024",
"thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE",
"subject": "CN=IntermediateCertSubjectName",
"issuer": "CACert",
"signatureAlgorithm": "SHA",
"notAfter": "2023-11-12T23:40:25+00:00",
"notBefore": "2021-05-12T23:40:25+00:00"
},
"root": {
"version": 3430921,
"serialNumber": "jkskd890ajdd00124",
"thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE",
"subject": "CN=RootCertSubjectName",
"issuer": "CACert",
"signatureAlgorithm": "SHA",
"notAfter": "2023-11-12T23:40:25+00:00",
"notBefore": "2021-05-12T23:40:25+00:00"
},
"serialNumber": "12324325325",
"lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00",
"expirationTime": "2022-11-12T23:40:25+00:00",
"isPrivateKeyExternal": false,
"appServiceCertificateNotRenewableReasons": [
"ExpirationNotInRenewalTimeRange"
],
"nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00",
"contact": {
"email": "contact@email.com",
"nameFirst": "SampleFirstName",
"nameLast": "SampleLastName",
"phone": "1-224-550-332"
}
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName",
"name": "SampleCertificateOrderName",
"type": "Microsoft.CertificateRegistration/certificateOrders",
"location": "Global",
"properties": {
"certificates": {
"SampleCertName1": {
"keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
"keyVaultSecretName": "SampleSecretName1",
"provisioningState": "Succeeded"
},
"SampleCertName2": {
"keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
"keyVaultSecretName": "SampleSecretName2",
"provisioningState": "KeyVaultSecretDoesNotExist"
}
},
"distinguishedName": "CN=SampleCustomDomain.com",
"domainVerificationToken": "awe4163Br6d32r",
"validityInYears": 2,
"keySize": 2048,
"productType": "StandardDomainValidatedSsl",
"autoRenew": true,
"provisioningState": "InProgress",
"status": "Issued",
"signedCertificate": {
"version": 1232490,
"serialNumber": "sds12424k",
"thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE",
"subject": "CN=CertSubjectName",
"issuer": "CACert",
"signatureAlgorithm": "SHA",
"notAfter": "2022-11-12T23:40:25+00:00",
"notBefore": "2021-11-12T23:40:25+00:00"
},
"csr": "xdf!x|",
"intermediate": {
"version": 5589220,
"serialNumber": "k45kad0024",
"thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE",
"subject": "CN=IntermediateCertSubjectName",
"issuer": "CACert",
"signatureAlgorithm": "SHA",
"notAfter": "2023-11-12T23:40:25+00:00",
"notBefore": "2021-05-12T23:40:25+00:00"
},
"root": {
"version": 3430921,
"serialNumber": "jkskd890ajdd00124",
"thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE",
"subject": "CN=RootCertSubjectName",
"issuer": "CACert",
"signatureAlgorithm": "SHA",
"notAfter": "2023-11-12T23:40:25+00:00",
"notBefore": "2021-05-12T23:40:25+00:00"
},
"serialNumber": "12324325325",
"lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00",
"expirationTime": "2022-11-12T23:40:25+00:00",
"isPrivateKeyExternal": false,
"appServiceCertificateNotRenewableReasons": [
"ExpirationNotInRenewalTimeRange"
],
"nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00",
"contact": {
"email": "contact@email.com",
"nameFirst": "SampleFirstName",
"nameLast": "SampleLastName",
"phone": "1-224-550-332"
}
}
}
Definicje
Nazwa | Opis |
---|---|
App |
Key Vault kontener dla certyfikatu zakupionego za pośrednictwem platformy Azure. |
App |
Zamówienie zakupu certyfikatu SSL. |
Certificate |
Szczegóły certyfikatu SSL. |
Certificate |
|
Certificate |
Bieżący stan zamówienia. |
Certificate |
Typ produktu certyfikatu. |
Default |
App Service odpowiedź na błąd. |
Details | |
Error |
Model błędu. |
Key |
Stan wpisu tajnego Key Vault. |
Provisioning |
Stan zamówienia certyfikatu. |
Resource |
Powody, dla których certyfikat App Service nie jest obecnie odnawialny. |
AppServiceCertificate
Key Vault kontener dla certyfikatu zakupionego za pośrednictwem platformy Azure.
Nazwa | Typ | Opis |
---|---|---|
keyVaultId |
string |
Key Vault identyfikator zasobu. |
keyVaultSecretName |
string |
Key Vault nazwę wpisu tajnego. |
provisioningState |
Stan wpisu tajnego Key Vault. |
AppServiceCertificateOrder
Zamówienie zakupu certyfikatu SSL.
Nazwa | Typ | Wartość domyślna | Opis |
---|---|---|---|
id |
string |
Identyfikator zasobu. |
|
kind |
string |
Rodzaj zasobu. |
|
location |
string |
Lokalizacja zasobu. |
|
name |
string |
Nazwa zasobu. |
|
properties.appServiceCertificateNotRenewableReasons |
Powody, dla których certyfikat App Service nie jest obecnie odnawialny. |
||
properties.autoRenew |
boolean |
True |
|
properties.certificates |
<string,
App |
Stan wpisu tajnego Key Vault. |
|
properties.contact |
Informacje kontaktowe |
||
properties.csr |
string |
Ostatnia operacja CSR utworzona dla tego zamówienia. |
|
properties.distinguishedName |
string |
Nazwa wyróżniająca certyfikatu. |
|
properties.domainVerificationToken |
string |
Token weryfikacji domeny. |
|
properties.expirationTime |
string |
Czas wygaśnięcia certyfikatu. |
|
properties.intermediate |
Certyfikat pośredni. |
||
properties.isPrivateKeyExternal |
boolean |
|
|
properties.keySize |
integer |
2048 |
Rozmiar klucza certyfikatu. |
properties.lastCertificateIssuanceTime |
string |
Czas ostatniego wystawiania certyfikatu. |
|
properties.nextAutoRenewalTimeStamp |
string |
Sygnatura czasowa po automatycznym odnowieniu certyfikatu |
|
properties.productType |
Typ produktu certyfikatu. |
||
properties.provisioningState |
Stan zamówienia certyfikatu. |
||
properties.root |
Certyfikat główny. |
||
properties.serialNumber |
string |
Bieżący numer seryjny certyfikatu. |
|
properties.signedCertificate |
Podpisany certyfikat. |
||
properties.status |
Bieżący stan zamówienia. |
||
properties.validityInYears |
integer |
1 |
Czas trwania w latach (musi wynosić 1). |
tags |
object |
Tagi zasobów. |
|
type |
string |
Typ zasobu. |
CertificateDetails
Szczegóły certyfikatu SSL.
Nazwa | Typ | Opis |
---|---|---|
issuer |
string |
Wystawca certyfikatu. |
notAfter |
string |
Data certyfikatu jest prawidłowa. |
notBefore |
string |
Data certyfikatu jest prawidłowa. |
rawData |
string |
Nieprzetworzone dane certyfikatu. |
serialNumber |
string |
Numer seryjny certyfikatu. |
signatureAlgorithm |
string |
Algorytm podpisu certyfikatu. |
subject |
string |
Podmiot certyfikatu. |
thumbprint |
string |
Odcisk palca certyfikatu. |
version |
integer |
Wersja certyfikatu. |
CertificateOrderContact
Nazwa | Typ | Opis |
---|---|---|
string |
||
nameFirst |
string |
|
nameLast |
string |
|
phone |
string |
CertificateOrderStatus
Bieżący stan zamówienia.
Nazwa | Typ | Opis |
---|---|---|
Canceled |
string |
|
Denied |
string |
|
Expired |
string |
|
Issued |
string |
|
NotSubmitted |
string |
|
PendingRekey |
string |
|
Pendingissuance |
string |
|
Pendingrevocation |
string |
|
Revoked |
string |
|
Unused |
string |
CertificateProductType
Typ produktu certyfikatu.
Nazwa | Typ | Opis |
---|---|---|
StandardDomainValidatedSsl |
string |
|
StandardDomainValidatedWildCardSsl |
string |
DefaultErrorResponse
App Service odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
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 |
ProvisioningState
Stan zamówienia certyfikatu.
Nazwa | Typ | Opis |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
ResourceNotRenewableReason
Powody, dla których certyfikat App Service nie jest obecnie odnawialny.
Nazwa | Typ | Opis |
---|---|---|
ExpirationNotInRenewalTimeRange |
string |
|
RegistrationStatusNotSupportedForRenewal |
string |
|
SubscriptionNotActive |
string |