Certificate - List By Service

Ссылка

Служба:: API Management

Версия API:: 2024-05-01

Выводит коллекцию всех сертификатов в указанном экземпляре службы.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates?api-version=2024-05-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=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
$filter	query		string	\| Поле \| Использование \| Поддерживаемые операторы \| Поддерживаемые функции \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| тема \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| отпечаток \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| дата окончания срока действия \| filter \| ge, le, eq, ne, lt \|
$skip	query		integer (int32) minimum: 0	Количество пропускаемых записей.
$top	query		integer (int32) minimum: 1	Количество возвращаемых записей.
isKeyVaultRefreshFailed	query		boolean	Если задано значение true, ответ содержит только сущности сертификатов, которые не удалось обновить.

Ответы

Имя	Тип	Описание
200 OK	CertificateCollection	Возвращает коллекцию сущности Certificate.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementListCertificates

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/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": ""
}

Определения

Имя	Описание
CertificateCollection	Представление списка сертификатов со страницами.
CertificateContract	Сведения о сертификате.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
KeyVaultContractProperties	Сведения о контракте KeyVault.
KeyVaultLastAccessStatusContractProperties	Выдача свойств обновления контракта.

CertificateCollection

Object

Представление списка сертификатов со страницами.

Имя	Тип	Описание
count	integer (int64)	Общее число записей на всех страницах.
nextLink	string	Следующая ссылка на страницу, если она есть.
value	CertificateContract[]	Значения страницы.

CertificateContract

Object

Сведения о сертификате.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.expirationDate	string (date-time)	Дата окончания срока действия сертификата. Дата соответствует следующему формату: `yyyy-MM-ddTHH:mm:ssZ`, как указано в стандарте ISO 8601.
properties.keyVault	KeyVaultContractProperties	Сведения о расположении keyVault для сертификата.
properties.subject	string	Атрибут субъекта сертификата.
properties.thumbprint	string	Отпечаток сертификата.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

KeyVaultContractProperties

Object

Сведения о контракте KeyVault.

Имя	Тип	Описание
identityClientId	string	Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей.
lastStatus	KeyVaultLastAccessStatusContractProperties	Последнее время синхронизации и обновления состояния секрета из хранилища ключей.
secretIdentifier	string	Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Object

Выдача свойств обновления контракта.

Имя	Тип	Описание
code	string	Последний код состояния для синхронизации и обновления секрета из хранилища ключей.
message	string	Сведения об ошибке, пустой.
timeStampUtc	string (date-time)	При последнем доступе к секрету. Дата соответствует следующему формату: `yyyy-MM-ddTHH:mm:ssZ`, как указано в стандарте ISO 8601.

Поделиться через

Certificate - List By Service

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

ApiManagementListCertificates

Образец запроса

Пример ответа

Определения

CertificateCollection

CertificateContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

Дополнительные ресурсы