App Service Certificate Orders - Get

Referencia

Szolgáltatás:: App Service

API-verzió:: 2024-11-01

A tanúsítványrendelés lekérésének leírása.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}?api-version=2024-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
certificateOrderName	path	True	string	A tanúsítványrendelés neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Ön Azure előfizetési azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Válaszok

Name	Típus	Description
200 OK	AppServiceCertificateOrder	OKÉ
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get App Service Certificate Order

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-11-01/examples/GetAppServiceCertificateOrder.json
// this example is just showing the usage of "AppServiceCertificateOrders_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AppServiceCertificateOrderResource created on azure
// for more information of creating AppServiceCertificateOrderResource, please refer to the document of AppServiceCertificateOrderResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string certificateOrderName = "SampleCertificateOrderName";
ResourceIdentifier appServiceCertificateOrderResourceId = AppServiceCertificateOrderResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, certificateOrderName);
AppServiceCertificateOrderResource appServiceCertificateOrder = client.GetAppServiceCertificateOrderResource(appServiceCertificateOrderResourceId);

// invoke the operation
AppServiceCertificateOrderResource result = await appServiceCertificateOrder.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppServiceCertificateOrderData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
AppServiceCertificate	Key Vault-tároló az Azure-on keresztül vásárolt tanúsítványhoz.
AppServiceCertificateOrder	SSL-tanúsítvány vásárlási megrendelése.
CertificateDetails	SSL-tanúsítvány részletei.
CertificateOrderContact
CertificateOrderStatus	Aktuális rendelés állapota.
CertificateProductType	Tanúsítvány terméktípusa.
DefaultErrorResponse	App Service-hibaválasz.
Details
Error	Hibamodell.
KeyVaultSecretStatus	A Key Vault titkos kulcsának állapota.
ProvisioningState	A tanúsítványrendelés állapota.
ResourceNotRenewableReason	Az App Service-tanúsítvány jelenleg nem megújítható okai.

AppServiceCertificate

Objektum

Key Vault-tároló az Azure-on keresztül vásárolt tanúsítványhoz.

Name	Típus	Description
keyVaultId	string	Key Vault-erőforrás-azonosító.
keyVaultSecretName	string	Key Vault titkos neve.
provisioningState	KeyVaultSecretStatus	A Key Vault titkos kulcsának állapota.

AppServiceCertificateOrder

Objektum

SSL-tanúsítvány vásárlási megrendelése.

Name	Típus	Alapértelmezett érték	Description
id	string		Erőforrás-azonosító.
kind	string		Erőforrás típusa. Ha az erőforrás egy alkalmazás, a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference a természetben támogatott értékek részleteiért tekintse meg.
location	string		Erőforrás helye.
name	string		Erőforrás neve.
properties.appServiceCertificateNotRenewableReasons	ResourceNotRenewableReason[]		Az App Service-tanúsítvány jelenleg nem megújítható okai.
properties.autoRenew	boolean	True	`true`, hogy a tanúsítványt a lejáratkor automatikusan meg kell-e újítani; ellenkező esetben `false`.
properties.certificates	<string, AppServiceCertificate>		A Key Vault titkos kulcsának állapota.
properties.contact	CertificateOrderContact		Kapcsolattartási adatok
properties.csr	string		A rendeléshez létrehozott utolsó CSR.
properties.distinguishedName	string		Tanúsítvány megkülönböztető neve.
properties.domainVerificationToken	string		Tartomány-ellenőrzési jogkivonat.
properties.expirationTime	string (date-time)		A tanúsítvány lejárati ideje.
properties.intermediate	CertificateDetails		Köztes tanúsítvány.
properties.isPrivateKeyExternal	boolean		`true`, ha a titkos kulcs külső; ellenkező esetben `false`.
properties.keySize	integer (int32)	2048	Tanúsítványkulcs mérete.
properties.lastCertificateIssuanceTime	string (date-time)		A tanúsítvány utolsó kiállítási ideje.
properties.nextAutoRenewalTimeStamp	string (date-time)		Időbélyeg, amikor a tanúsítvány automatikusan megújul a következő lépésben
properties.productType	CertificateProductType		Tanúsítvány terméktípusa.
properties.provisioningState	ProvisioningState		A tanúsítványrendelés állapota.
properties.root	CertificateDetails		Főtanúsítvány.
properties.serialNumber	string		A tanúsítvány aktuális sorozatszáma.
properties.signedCertificate	CertificateDetails		Aláírt tanúsítvány.
properties.status	CertificateOrderStatus		Aktuális rendelés állapota.
properties.validityInYears	integer (int32)	1	Időtartam években (1-nek kell lennie).
tags	object		Erőforráscímkék.
type	string		Erőforrás típusa.

CertificateDetails

Objektum

SSL-tanúsítvány részletei.

Name	Típus	Description
issuer	string	Tanúsítványkibocsátó.
notAfter	string (date-time)	Dátumtanúsítvány érvényes.
notBefore	string (date-time)	Dátum tanúsítvány érvényességétől.
rawData	string	Nyers tanúsítványadatok.
serialNumber	string	Tanúsítvány sorozatszáma.
signatureAlgorithm	string	Tanúsítvány-aláírási algoritmus.
subject	string	Tanúsítvány tárgya.
thumbprint	string	Tanúsítvány ujjlenyomata.
version	integer (int32)	Tanúsítvány verziója.

CertificateOrderContact

Objektum

Name	Típus	Description
email	string
nameFirst	string
nameLast	string
phone	string

CertificateOrderStatus

Enumerálás

Aktuális rendelés állapota.

Érték	Description
Canceled
Denied
Expired
Issued
NotSubmitted
PendingRekey
Pendingissuance
Pendingrevocation
Revoked
Unused

CertificateProductType

Enumerálás

Tanúsítvány terméktípusa.

Érték	Description
StandardDomainValidatedSsl
StandardDomainValidatedWildCardSsl

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

KeyVaultSecretStatus

Enumerálás

A Key Vault titkos kulcsának állapota.

Érték	Description
AzureServiceUnauthorizedToAccessKeyVault
CertificateOrderFailed
ExternalPrivateKey
Initialized
KeyVaultDoesNotExist
KeyVaultSecretDoesNotExist
OperationNotPermittedOnKeyVault
Succeeded
Unknown
UnknownError
WaitingOnCertificateOrder

ProvisioningState

Enumerálás

A tanúsítványrendelés állapota.

Érték	Description
Canceled
Deleting
Failed
InProgress
Succeeded

ResourceNotRenewableReason

Enumerálás

Az App Service-tanúsítvány jelenleg nem megújítható okai.

Érték	Description
ExpirationNotInRenewalTimeRange
RegistrationStatusNotSupportedForRenewal
SubscriptionNotActive

Megosztás a következőn keresztül:

App Service Certificate Orders - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Get App Service Certificate Order

Mintakérelem

Mintaválasz

Definíciók

AppServiceCertificate

AppServiceCertificateOrder

CertificateDetails

CertificateOrderContact

CertificateOrderStatus

CertificateProductType

DefaultErrorResponse

Details

Error

KeyVaultSecretStatus

ProvisioningState

ResourceNotRenewableReason