Dps Certificate - Generate Verification Code

Ссылка

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Создайте код проверки для подтверждения владения.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode?api-version=2022-12-12

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode?certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}&api-version=2022-12-12

Параметры URI

Имя	В	Обязательно	Тип	Описание
certificateName	path	True	string	Обязательное логическое имя сертификата, используемого службой подготовки для доступа.
provisioningServiceName	path	True	string	Имя службы подготовки.
resourceGroupName	path	True	string	имя группы ресурсов.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.
certificate.created	query		string date-time	Время создания сертификата.
certificate.hasPrivateKey	query		boolean	Указывает, содержит ли сертификат закрытый ключ.
certificate.isVerified	query		boolean	Указывает, был ли сертификат проверен владельцем закрытого ключа.
certificate.lastUpdated	query		string date-time	Время последнего обновления сертификата.
certificate.name	query		string	Общее имя сертификата.
certificate.nonce	query		string	Случайное число, созданное для обозначения подтверждения владения.
certificate.purpose	query		CertificatePurpose	Описание с указанием назначения сертификата.
certificate.rawBytes	query		string byte	Необработанные данные сертификата.

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

Имя	Обязательно	Тип	Описание
If-Match	True	string	ETag сертификата. Это необходимо для обновления существующего сертификата и игнорируется при создании нового сертификата.

Ответы

Имя	Тип	Описание
200 OK	VerificationCodeResponse	Возвращается созданный код проверки для этого сертификата.
Other Status Codes	ErrorDetails	Ответ на ошибку по умолчанию.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

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

Примеры

DPSGenerateVerificationCode

Sample Request

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert/generateVerificationCode?certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}&api-version=2022-12-12

Sample Response

Status code:: 200

{
  "name": "cert",
  "properties": {
    "verificationCode": "##################################",
    "subject": "CN=andbucdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "thumbprint": "##############################",
    "certificate": "MA==",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:26:56 GMT"
  }
}

Определения

Имя	Описание
CertificatePurpose	Описание с указанием назначения сертификата.
ErrorDetails	Сведения об ошибке.
Properties
VerificationCodeResponse	Описание ответа кода проверки.

CertificatePurpose

Описание с указанием назначения сертификата.

Имя	Тип	Описание
clientAuthentication	string
serverAuthentication	string

ErrorDetails

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

Имя	Тип	Описание
code	integer	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

Properties

Имя	Тип	Описание
certificate	string	Представление base-64 сертификата X509 .cer файла или только pem-файла.
created	string	Время создания сертификата.
expiry	string	Срок действия кода.
isVerified	boolean	Укажите, проверен ли сертификат владельцем закрытого ключа.
subject	string	Субъект сертификата.
thumbprint	string	Отпечаток сертификата.
updated	string	Время обновления сертификата.
verificationCode	string	Код проверки.

VerificationCodeResponse

Описание ответа кода проверки.

Имя	Тип	Описание
etag	string	Запрос etag.
id	string	Идентификатор ресурса.
name	string	Имя сертификата.
properties	Properties
type	string	Тип ресурса.

Share via