Certificate - List By Service
Vypíše kolekci všech certifikátů v zadané instanci služby.
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
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Regex pattern: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
$filter
|
query |
string |
| Pole | Využití | Podporované operátory | Podporované funkce | |
|
$skip
|
query |
integer int32 |
Počet záznamů, které se mají přeskočit |
|
$top
|
query |
integer int32 |
Počet vrácených záznamů. |
|
is
|
query |
boolean |
Pokud je nastavená hodnota true, odpověď obsahuje pouze entity certifikátů, u kterých se nepodařilo aktualizovat. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Vrátí kolekci entity Certificate. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
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": ""
}
Definice
Name | Description |
---|---|
Certificate |
Reprezentace seznamu stránkovaných certifikátů |
Certificate |
Podrobnosti o certifikátu. |
Error |
Chybový kontrakt pole. |
Error |
Odpověď na chybu. |
Key |
Podrobnosti o kontraktu služby KeyVault |
Key |
Aktualizace vlastností smlouvy o vydání. |
CertificateCollection
Reprezentace seznamu stránkovaných certifikátů
Name | Typ | Description |
---|---|---|
count |
integer |
Celkový počet záznamů na všech stránkách |
nextLink |
string |
Odkaz na další stránku, pokud existuje. |
value |
Hodnoty stránky. |
CertificateContract
Podrobnosti o certifikátu.
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku} |
name |
string |
Název prostředku |
properties.expirationDate |
string |
Datum vypršení platnosti certifikátu. Datum odpovídá následujícímu formátu: |
properties.keyVault |
Podrobnosti o umístění certifikátu služby Key Vault |
|
properties.subject |
string |
Atribut předmětu certifikátu. |
properties.thumbprint |
string |
Kryptografický otisk certifikátu |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
ErrorFieldContract
Chybový kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Pro člověka čitelná reprezentace chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v požadavku v případě chyby ověření. |
|
error.message |
string |
Pro člověka čitelná reprezentace chyby. |
KeyVaultContractProperties
Podrobnosti o kontraktu služby KeyVault
Name | Typ | Description |
---|---|---|
identityClientId |
string |
Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. |
lastStatus |
Čas poslední synchronizace a stav aktualizace tajného kódu z trezoru klíčů |
|
secretIdentifier |
string |
Identifikátor tajného kódu trezoru klíčů pro načtení tajného kódu. Poskytnutí tajného kódu s verzí zabrání automatické aktualizaci. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Aktualizace vlastností smlouvy o vydání.
Name | Typ | Description |
---|---|---|
code |
string |
Poslední stavový kód pro synchronizaci a aktualizaci tajného kódu z trezoru klíčů. |
message |
string |
Podrobnosti o chybě jsou prázdné. |
timeStampUtc |
string |
Čas posledního přístupu k tajnému kódu Datum odpovídá následujícímu formátu: |