Certificate - Get
Ruft die Details des Zertifikats ab, das durch seinen Bezeichner angegeben wird.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}?api-version=2021-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
certificate
|
path | True |
string |
Bezeichner der Zertifikatentität. Muss im aktuellen API Management Dienst instance eindeutig sein. RegEx-Muster: |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. |
service
|
path | True |
string |
Der Name des API Management-Diensts. RegEx-Muster: |
subscription
|
path | True |
string |
Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf. |
api-version
|
query | True |
string |
Version der API, die mit der Clientanforderung verwendet werden soll. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Antworttext enthält die angegebene Certificate-Entität. Header ETag: string |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Api |
Api |
ApiManagementGetCertificate
Beispielanforderung
Beispiel für eine Antwort
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "templateCert1",
"properties": {
"subject": "CN=mutual-authcert",
"thumbprint": "EBA**********************8594A6",
"expirationDate": "2017-04-23T17:03:41Z"
}
}
ApiManagementGetCertificateWithKeyVault
Beispielanforderung
Beispiel für eine Antwort
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "templateCertkv",
"properties": {
"subject": "CN=*.msitesting.net",
"thumbprint": "EA**********************9AD690",
"expirationDate": "2037-01-01T07:00:00Z",
"keyVault": {
"secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
"identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
"lastStatus": {
"code": "Success",
"timeStampUtc": "2020-09-22T00:24:53.3191468Z"
}
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Certificate |
Zertifikatdetails. |
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
Key |
KeyVault-Vertragsdetails. |
Key |
Updateeigenschaften des Vertrags ausstellen. |
CertificateContract
Zertifikatdetails.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.expirationDate |
string |
Ablaufdatum des Zertifikats. Das Datum entspricht dem folgenden Format: |
properties.keyVault |
KeyVault-Speicherortdetails des Zertifikats. |
|
properties.subject |
string |
"Subject"-Attribut des Zertifikats. |
properties.thumbprint |
string |
Fingerabdruck des Zertifikats |
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Fehlerfeldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
KeyVaultContractProperties
KeyVault-Vertragsdetails.
Name | Typ | Beschreibung |
---|---|---|
identityClientId |
string |
Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Geheimnis des Schlüsseltresors verwendet wird. |
lastStatus |
Letzte Synchronisierung und Aktualisierung status des Geheimnisses aus dem Schlüsseltresor. |
|
secretIdentifier |
string |
Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines versionsbasierten Geheimnisses verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden. |
KeyVaultLastAccessStatusContractProperties
Updateeigenschaften des Vertrags ausstellen.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Letzter status Code für die Synchronisierung und Aktualisierung des Geheimnisses aus dem Schlüsseltresor. |
message |
string |
Details des Fehlers sonst leer. |
timeStampUtc |
string |
Zuletzt wurde auf das Geheimnis zugegriffen. Das Datum entspricht dem folgenden Format: |