Workspace Certificate - List By Workspace

Tjänst:
API Management
API-version:
2024-05-01

Visar en samling med alla certifikat på den angivna arbetsytan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates?api-version=2024-05-01
Med valfria parametrar: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates?$filter={$filter}&$top={$top}&$skip={$skip}&isKeyVaultRefreshFailed={isKeyVaultRefreshFailed}&api-version=2024-05-01

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Namnet på API Management-tjänsten.
subscriptionId
 path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.
workspaceId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Arbetsyteidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
api-version
 query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.
$filter
 query

string

| Fält | Användning | Operatorer som stöds | Funktioner som stöds |
|-------------|-------------|-------------|-------------|
| namn | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ämne | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| tumavtryck | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
$skip
 query

integer (int32)

minimum: 0

Antal poster att hoppa över.
$top
 query

integer (int32)

minimum: 1

Antal poster som ska returneras.
isKeyVaultRefreshFailed
 query

boolean

När det är inställt på true innehåller svaret endast certifikatentiteter som misslyckades med uppdateringen.

Svar

Name Typ Description
200 OK

CertificateCollection

Returnerar en samling certifikatentiteter.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementListWorkspaceCertificates

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/kjoshiarmtemplateCert1",
      "type": "Microsoft.ApiManagement/service/workspaces/certificates",
      "name": "templateCert1",
      "properties": {
        "subject": "CN=mutual-authcert",
        "thumbprint": "EBA************************48594A6",
        "expirationDate": "2017-04-23T17:03:41Z"
      }
    },
    {
      "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"
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definitioner

Name Description
CertificateCollection

Listrepresentation för växlingscertifikat.
CertificateContract

Certifikatinformation.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
KeyVaultContractProperties

KeyVault-kontraktsinformation.
KeyVaultLastAccessStatusContractProperties

Utfärda kontraktuppdateringsegenskaper.

CertificateCollection

Objekt

Listrepresentation för växlingscertifikat.

Name Typ Description
count

integer (int64)

Totalt antal poster på alla sidor.
nextLink

string

Om det finns någon länk till nästa sida.
value

CertificateContract[]

Sidvärden.

CertificateContract

Objekt

Certifikatinformation.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Namnet på resursen
properties.expirationDate

string (date-time)

Förfallodatum för certifikatet. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.
properties.keyVault

KeyVaultContractProperties

KeyVault-platsinformation för certifikatet.
properties.subject

string

Certifikatets ämnesattribut.
properties.thumbprint

string

Tumavtryck för certifikatet.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

KeyVaultContractProperties

Objekt

KeyVault-kontraktsinformation.

Name Typ Description
identityClientId

string

Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet.
lastStatus

KeyVaultLastAccessStatusContractProperties

Senaste tidssynkronisering och uppdateringsstatus för hemligheten från nyckelvalvet.
secretIdentifier

string

Nyckelvalvshemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Objekt

Utfärda kontraktuppdateringsegenskaper.

Name Typ Description
code

string

Senaste statuskod för synkronisering och uppdatering av hemlighet från nyckelvalv.
message

string

Information om felet är tomt.
timeStampUtc

string (date-time)

Senaste gången hemligheten användes. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.