Certificate - List By Service
Visar en samling med alla certifikat i den angivna tjänstinstansen.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates?$filter={$filter}&$top={$top}&$skip={$skip}&isKeyVaultRefreshFailed={isKeyVaultRefreshFailed}&api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Regex pattern: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
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 | |
|
$skip
|
query |
integer int32 |
Antal poster att hoppa över. |
|
$top
|
query |
integer int32 |
Antal poster som ska returneras. |
|
is
|
query |
boolean |
När värdet är true innehåller svaret endast certifikatentiteter som inte kunde uppdateras. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Returnerar en samling certifikatentiteter. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
ApiManagementListCertificates
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "templateCert1",
"properties": {
"subject": "CN=mutual-authcert",
"thumbprint": "EBA************************48594A6",
"expirationDate": "2017-04-23T17:03:41Z"
}
},
{
"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"
}
}
}
}
],
"count": 2,
"nextLink": ""
}
Definitioner
Name | Description |
---|---|
Certificate |
Representation av listan med växlingscertifikat. |
Certificate |
Certifikatinformation. |
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Key |
Information om KeyVault-kontrakt. |
Key |
Utfärda egenskaper för kontraktsuppdatering. |
CertificateCollection
Representation av listan med växlingscertifikat.
Name | Typ | Description |
---|---|---|
count |
integer |
Totalt antal poster på alla sidor. |
nextLink |
string |
Länk till nästa sida om det finns någon. |
value |
Sidvärden. |
CertificateContract
Certifikatinformation.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.expirationDate |
string |
Certifikatets förfallodatum. Datumet överensstämmer med följande format: |
properties.keyVault |
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" |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
KeyVaultContractProperties
Information om KeyVault-kontrakt.
Name | Typ | Description |
---|---|---|
identityClientId |
string |
Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som används för att komma åt key vault-hemlighet. |
lastStatus |
Senaste synkronisering och uppdateringsstatus för hemligheten från nyckelvalvet. |
|
secretIdentifier |
string |
Key Vault-hemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindras automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Utfärda egenskaper för kontraktsuppdatering.
Name | Typ | Description |
---|---|---|
code |
string |
Senaste statuskod för synkronisering och uppdatering av hemlighet från key vault. |
message |
string |
Information om felet annars tomt. |
timeStampUtc |
string |
Senaste gången hemligheten användes. Datumet överensstämmer med följande format: |