Certificate - Add

  • Ссылка
Service:
Batch Service
API Version:
2023-11-01.18.0

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

POST {batchUrl}/certificates?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/certificates?timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

Имя В Обязательно Тип Описание
batchUrl
 path True

string

Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
api-version
 query True

string

Версия API клиента.
timeout
 query

integer

int32

Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 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 напрямую.

Текст запроса

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

Имя Обязательно Тип Описание
data True

string

Содержимое сертификата в кодировке Base64. Максимальный размер — 10 КБ.
thumbprint True

string

Отпечаток сертификата X.509. Это последовательность до 40 шестнадцатеричных цифр (она может включать пробелы, но они удаляются).
thumbprintAlgorithm True

string

Алгоритм, используемый для создания отпечатка. Это должно быть sha1.
certificateFormat

CertificateFormat

Формат данных сертификата.
password

string

Пароль для доступа к закрытому ключу сертификата.
Этот параметр необходимо опустить, если формат сертификата имеет формат cer.

Ответы

Имя Тип Описание
201 Created

Запрос к пакетной службе выполнен успешно.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Ошибка пакетной службы.

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

azure_auth

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Certificate add

Sample Request

POST account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0



{
  "thumbprintAlgorithm": "sha1",
  "thumbprint": "0123456789abcdef0123456789abcdef01234567",
  "data": "#####...",
  "certificateFormat": "pfx",
  "password": "<ExamplePassword>"
}

Sample Response

Status code:
201

Определения

Имя Описание
BatchError

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

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

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

Формат данных сертификата.
ErrorMessage

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

BatchError

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

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message

ErrorMessage

Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
values

BatchErrorDetail[]

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Имя Тип Описание
key

string

Идентификатор, указывающий значение свойства Value.
value

string

Дополнительные сведения, включенные в ответ об ошибке.

CertificateAddParameter

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

Имя Тип Описание
certificateFormat

CertificateFormat

Формат данных сертификата.
data

string

Содержимое сертификата в кодировке Base64. Максимальный размер — 10 КБ.
password

string

Пароль для доступа к закрытому ключу сертификата.
Этот параметр необходимо опустить, если формат сертификата имеет формат cer.
thumbprint

string

Отпечаток сертификата X.509. Это последовательность до 40 шестнадцатеричных цифр (она может включать пробелы, но они удаляются).
thumbprintAlgorithm

string

Алгоритм, используемый для создания отпечатка. Это должно быть sha1.

CertificateFormat

Формат данных сертификата.

Имя Тип Описание
cer

string

Сертификат является сертификатом X.509 в кодировке Base64.
pfx

string

Сертификат — это сертификат или цепочка сертификатов в формате PFX (PKCS#12).

ErrorMessage

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

Имя Тип Описание
lang

string

Код языка сообщения об ошибке
value

string

Текст сообщения.