Workspace Certificate - Get

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Ruft die Details des Zertifikats ab, das durch seinen Bezeichner angegeben ist.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Bezeichner der Zertifikatentität. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	CertificateContract	Der Antworttext enthält die angegebene Zertifikatentität. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

CertificateContract

Der Antworttext enthält die angegebene Zertifikatentität.

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementGetWorkspaceCertificate

ApiManagementGetWorkspaceCertificateWithKeyVault

ApiManagementGetWorkspaceCertificate

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCert1?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service//workspaces/wks1/certificates/templateCert1",
  "type": "Microsoft.ApiManagement/service/workspaces/certificates",
  "name": "templateCert1",
  "properties": {
    "subject": "CN=mutual-authcert",
    "thumbprint": "EBA**********************8594A6",
    "expirationDate": "2017-04-23T17:03:41Z"
  }
}

ApiManagementGetWorkspaceCertificateWithKeyVault

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/workspaces/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
CertificateContract	Zertifikatdetails.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
KeyVaultContractProperties	KeyVault-Vertragsdetails.
KeyVaultLastAccessStatusContractProperties	Vertragsaktualisierungseigenschaften ausstellen.

CertificateContract

Objekt

Zertifikatdetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.expirationDate	string (date-time)	Ablaufdatum des Zertifikats. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.keyVault	KeyVaultContractProperties	KeyVault-Standortdetails 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"

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

KeyVaultContractProperties

Objekt

KeyVault-Vertragsdetails.

Name	Typ	Beschreibung
identityClientId	string	Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird.
lastStatus	KeyVaultLastAccessStatusContractProperties	Beim letzten Synchronisieren und Aktualisieren des Status des geheimen Schlüssels aus dem Schlüsseltresor.
secretIdentifier	string	Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden.

KeyVaultLastAccessStatusContractProperties

Objekt

Vertragsaktualisierungseigenschaften ausstellen.

Name	Typ	Beschreibung
code	string	Letzter Statuscode für die Synchronisierung und Aktualisierung des geheimen Schlüssels aus dem Schlüsseltresor.
message	string	Details zu dem Fehler, der sonst leer ist.
timeStampUtc	string (date-time)	Letzter Zugriff auf den geheimen Schlüssel. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.

Freigeben über

Workspace Certificate - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementGetWorkspaceCertificate

Beispielanforderung

Beispiel für eine Antwort

ApiManagementGetWorkspaceCertificateWithKeyVault

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CertificateContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

Zusätzliche Ressourcen