Certificate - List

Служба:

Batch Service

Версия API:

2024-07-01.20.0

Выводит список всех сертификатов, добавленных в указанную учетную запись.
Предупреждение. Эта операция устарела и будет удалена после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault .

GET {batchUrl}/certificates?api-version=2024-07-01.20.0

С использованием необязательных параметров:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
$filter	query		string	Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Предложение OData $select.
maxresults	query		integer int32	Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 сертификатов.
timeout	query		integer int32	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию.

Заголовок запроса

Media Types: "application/json; odata=minimalmetadata"

Имя	Обязательно	Тип	Описание
client-request-id		string uuid	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date		string date-time-rfc1123	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

Ответы

Имя	Тип	Описание
200 OK	CertificateListResult	Ответ, содержащий список сертификатов. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

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

azure_auth

Поток кода проверки подлинности Microsoft Entra OAuth 2.0

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

Области

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

Authorization

Тип: apiKey
В: header

Примеры

Certificate list

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

HTTP

GET account.region.batch.azure.com/certificates?api-version=2024-07-01.20.0

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

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

200

{
  "value": [
    {
      "thumbprint": "0123456789abcdef0123456789abcdef01234567",
      "thumbprintAlgorithm": "sha1",
      "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)",
      "state": "deletefailed",
      "stateTransitionTime": "2014-07-31T21:12:58.236Z",
      "previousState": "deleting",
      "previousStateTransitionTime": "2014-07-31T21:11:58.236Z",
      "publicData": "#####...",
      "deleteCertificateError": {
        "code": "PoolsReferencingCertificate",
        "message": "The specified certificate is being used by the below mentioned pool(s)",
        "values": [
          {
            "name": "Pools",
            "value": "mypool1"
          }
        ]
      }
    }
  ]
}

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
Certificate	Сертификат, который можно установить на вычислительных узлах и может использоваться для проверки подлинности операций на компьютере.
CertificateListResult	Результат перечисления сертификатов в учетной записи.
CertificateState	Состояние сертификата.
DeleteCertificateError	Ошибка, обнаруженная пакетной службой при удалении сертификата.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
NameValuePair	Представляет пару "имя-значение".

BatchError

Ответ об ошибке, полученный из пакетной службы Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	ErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

Certificate

Сертификат, который можно установить на вычислительных узлах и может использоваться для проверки подлинности операций на компьютере.

Имя	Тип	Описание
deleteCertificateError	DeleteCertificateError	Ошибка, возниквшая при последней попытке удалить этот сертификат. Это свойство задается только в том случае, если сертификат находится в состоянии DeleteFailed.
previousState	CertificateState	Предыдущее состояние сертификата. Это свойство не задано, если сертификат находится в исходном активном состоянии.
previousStateTransitionTime	string	Время ввода сертификата в предыдущее состояние. Это свойство не задано, если сертификат находится в исходном состоянии "Активный".
publicData	string	Общедоступная часть сертификата в виде файла .cer в кодировке base-64.
state	CertificateState	Текущее состояние сертификата.
stateTransitionTime	string	Время ввода сертификата в текущее состояние.
thumbprint	string	Отпечаток сертификата X.509. Это последовательность до 40 шестнадцатеричных цифр.
thumbprintAlgorithm	string	Алгоритм, используемый для наследоваемого отпечатка.
url	string	URL-адрес сертификата.

CertificateListResult

Результат перечисления сертификатов в учетной записи.

Имя	Тип	Описание
odata.nextLink	string	URL-адрес для получения следующего набора результатов.
value	Certificate[]	Список сертификатов.

CertificateState

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

Имя	Тип	Описание
active	string	Сертификат доступен для использования в пулах.
deletefailed	string	Пользователь попросил удалить сертификат, но есть пулы, которые по-прежнему имеют ссылки на сертификат, или он по-прежнему установлен на одном или нескольких узлах. (Последний может произойти, если сертификат был удален из пула, но вычислительный узел еще не перезагрузился. Вычислительные узлы обновляют сертификаты только при перезапуске.) Операцию удаления сертификата отмены можно использовать для отмены удаления или операции удаления сертификата, чтобы повторить удаление.
deleting	string	Пользователь попросил удалить сертификат, но операция удаления еще не завершена. Вы не можете ссылать на сертификат при создании или обновлении пулов.

DeleteCertificateError

Ошибка, обнаруженная пакетной службой при удалении сертификата.

Имя	Тип	Описание
code	string	Идентификатор ошибки удаления сертификата. Коды являются инвариантными и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку удаления сертификата, предназначенную для отображения в пользовательском интерфейсе.
values	NameValuePair[]	Список дополнительных сведений об ошибке об ошибке удаления сертификата. Этот список содержит сведения, такие как активные пулы и вычислительные узлы, ссылающиеся на этот сертификат. Однако если большое количество ресурсов ссылается на сертификат, список содержит только около первой сотни.

ErrorMessage

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке
value	string	Текст сообщения.

NameValuePair

Представляет пару "имя-значение".

Имя	Тип	Описание
name	string	Имя в паре "имя-значение".
value	string	Значение в паре "имя-значение".