Workspace Certificate - Get

Service:

API Management

API-versie:

2024-05-01

Hiermee haalt u de details op van het certificaat dat is opgegeven met de id.

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

URI-parameters

Name	In	Vereist	Type	Description
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Id van de certificaatentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Werkruimte-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	CertificateContract	De antwoordtekst bevat de opgegeven certificaatentiteit. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetWorkspaceCertificate

ApiManagementGetWorkspaceCertificateWithKeyVault

ApiManagementGetWorkspaceCertificate

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
CertificateContract	Certificaatgegevens.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
KeyVaultContractProperties	KeyVault-contractgegevens.
KeyVaultLastAccessStatusContractProperties	Probleem met update-eigenschappen van contract.

CertificateContract

Object

Certificaatgegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.expirationDate	string (date-time)	Vervaldatum van het certificaat. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
properties.keyVault	KeyVaultContractProperties	Locatiedetails van KeyVault van het certificaat.
properties.subject	string	Onderwerpkenmerk van het certificaat.
properties.thumbprint	string	Vingerafdruk van het certificaat.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

KeyVaultContractProperties

Object

KeyVault-contractgegevens.

Name	Type	Description
identityClientId	string	Null voor SystemAssignedIdentity of client-id voor UserAssignedIdentity, die wordt gebruikt voor toegang tot sleutelkluisgeheim.
lastStatus	KeyVaultLastAccessStatusContractProperties	Laatste keer synchroniseren en de status van geheim vernieuwen vanuit de sleutelkluis.
secretIdentifier	string	Sleutelkluisgeheim-id voor het ophalen van een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Object

Probleem met update-eigenschappen van contract.

Name	Type	Description
code	string	Laatste statuscode voor synchronisatie en vernieuwing van geheim uit sleutelkluis.
message	string	Details van de fout leeg.
timeStampUtc	string (date-time)	Laatste keer dat het geheim werd geopend. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.