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

ProvisioningServiceClient class

  • Ссылка
Пакет:
azure-iot-provisioning-service

Конструкторы

ProvisioningServiceClient(TransportConfig, RestApiClient)

Методы

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Создает запрос, который можно использовать для возврата страниц существующего состояния регистрации устройства для определенной группы enrollmentGroup.
createEnrollmentGroupQuery(QuerySpecification, number)

Создает запрос, который можно использовать для возврата страниц существующих групп регистрации.
createIndividualEnrollmentQuery(QuerySpecification, number)

Создает запрос, который можно использовать для возврата страниц существующих регистраций.
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Создайте или обновите группу регистрации устройств.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Создайте или обновите запись регистрации устройства.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Удаление состояния регистрации устройства.
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Удаление группы регистрации устройств.
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Удаление записи регистрации устройства.
fromConnectionString(string)

Создает объект ProvisioningServiceClient из заданной строки подключения, используя транспорт по умолчанию (HTTP).
fromTokenCredential(string, TokenCredential)

Создает объект ProvisioningServiceClient из заданного Azure TokenCredential, используя транспорт по умолчанию (HTTP).
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Возвращает состояние регистрации устройства.
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Получение группы регистрации устройств.
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Возвращает механизм аттестации для записи EnrollmentGroup.
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Получение записи о регистрации устройства.
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Возвращает механизм аттестации для записи IndividualEnrollment.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Выполняет число операций CRUD с массивом записей регистрации.

Сведения о конструкторе

ProvisioningServiceClient(TransportConfig, RestApiClient) 

new ProvisioningServiceClient(config: TransportConfig, restApiClient?: RestApiClient)

Параметры

config

TransportConfig

restApiClient

RestApiClient

Сведения о методе

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

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

function createEnrollmentGroupDeviceRegistrationStateQuery(querySpecification: QuerySpecification, enrollmentGroupId: string, pageSize?: number): Query

Параметры

querySpecification

QuerySpecification

Спецификация запроса.

enrollmentGroupId

string

Идентификатор EnrollmentGroup, предоставляющий область для запроса.

pageSize

number

Максимальное количество возвращаемых элементов на страницу.

Возвращаемое значение

Query

createEnrollmentGroupQuery(QuerySpecification, number)

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

function createEnrollmentGroupQuery(querySpecification: QuerySpecification, pageSize?: number): Query

Параметры

querySpecification

QuerySpecification

Спецификация запроса.

pageSize

number

Максимальное количество возвращаемых элементов на страницу.

Возвращаемое значение

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

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

function createIndividualEnrollmentQuery(querySpecification: QuerySpecification, pageSize?: number): Query

Параметры

querySpecification

QuerySpecification

Спецификация запроса.

pageSize

number

Максимальное количество возвращаемых элементов на страницу.

Возвращаемое значение

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup) 

function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup): Promise<ResultWithHttpResponse<EnrollmentGroup>>

Параметры

enrollmentGroup

EnrollmentGroup

Возвращаемое значение

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Создайте или обновите группу регистрации устройств.

function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup, callback?: HttpResponseCallback<EnrollmentGroup>)

Параметры

enrollmentGroup

EnrollmentGroup

Группа регистрации устройств.

callback

HttpResponseCallback<EnrollmentGroup>

Вызывается после завершения операции.

createOrUpdateIndividualEnrollment(IndividualEnrollment) 

function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment): Promise<ResultWithHttpResponse<IndividualEnrollment>>

Параметры

enrollment

IndividualEnrollment

Возвращаемое значение

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Создайте или обновите запись регистрации устройства.

function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment, callback?: HttpResponseCallback<IndividualEnrollment>)

Параметры

enrollment

IndividualEnrollment

Запись регистрации устройства.

callback

HttpResponseCallback<IndividualEnrollment>

Вызывается после завершения операции.

deleteDeviceRegistrationState(string | DeviceRegistrationState) 

function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState): Promise<void>

Параметры

idOrRegistrationState

string | DeviceRegistrationState

Возвращаемое значение

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback) 

function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, deleteCallback: ErrorCallback)

Параметры

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string) 

function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string): Promise<void>

Параметры

idOrRegistrationState

string | DeviceRegistrationState

etag

string

Возвращаемое значение

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Удаление состояния регистрации устройства.

function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string, deleteCallback?: ErrorCallback)

Параметры

idOrRegistrationState

string | DeviceRegistrationState

Строка, содержащая идентификатор регистрации или фактический объект DeviceRegistrationState.

etag

string

deleteCallback

ErrorCallback

Вызывается после завершения операции.

deleteEnrollmentGroup(string | EnrollmentGroup) 

function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup): Promise<void>

Параметры

enrollmentGroupOrId

string | EnrollmentGroup

Возвращаемое значение

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback) 

function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, deleteCallback: ErrorCallback)

Параметры

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string) 

function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string): Promise<void>

Параметры

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

Возвращаемое значение

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Удаление группы регистрации устройств.

function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string, deleteCallback?: ErrorCallback)

Параметры

enrollmentGroupOrId

string | EnrollmentGroup

Объект EnrollmentGroup или строка, содержащая идентификатор группы регистрации.

etag

string

deleteCallback

ErrorCallback

Вызывается после завершения операции.

deleteIndividualEnrollment(string | IndividualEnrollment) 

function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment): Promise<void>

Параметры

enrollmentOrId

string | IndividualEnrollment

Возвращаемое значение

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback) 

function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, deleteCallback: ErrorCallback)

Параметры

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string) 

function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string): Promise<void>

Параметры

enrollmentOrId

string | IndividualEnrollment

etag

string

Возвращаемое значение

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Удаление записи регистрации устройства.

function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string, deleteCallback?: ErrorCallback)

Параметры

enrollmentOrId

string | IndividualEnrollment

Объект IndividualEnrollment или строка, содержащая идентификатор регистрации.

etag

string

deleteCallback

ErrorCallback

Вызывается после завершения операции.

fromConnectionString(string)

Создает объект ProvisioningServiceClient из заданной строки подключения, используя транспорт по умолчанию (HTTP).

static function fromConnectionString(value: string): ProvisioningServiceClient

Параметры

value

string

Строка подключения, которая инкапсулирует соответствующие разрешения (чтение и запись) ProvisioningServiceClient.

Возвращаемое значение

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

Создает объект ProvisioningServiceClient из заданного Azure TokenCredential, используя транспорт по умолчанию (HTTP).

static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): ProvisioningServiceClient

Параметры

hostName

string

Имя узла службы Azure.

tokenCredential
TokenCredential

Azure TokenCredential, используемый для проверки подлинности в службе Azure.

Возвращаемое значение

ProvisioningServiceClient

getDeviceRegistrationState(string) 

function getDeviceRegistrationState(id: string): Promise<ResultWithHttpResponse<DeviceRegistrationState>>

Параметры

id

string

Возвращаемое значение

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Возвращает состояние регистрации устройства.

function getDeviceRegistrationState(id: string, callback?: HttpResponseCallback<DeviceRegistrationState>)

Параметры

id

string

Идентификатор регистрации.

callback

HttpResponseCallback<DeviceRegistrationState>

Вызывается после завершения операции.

getEnrollmentGroup(string) 

function getEnrollmentGroup(id: string): Promise<ResultWithHttpResponse<EnrollmentGroup>>

Параметры

id

string

Возвращаемое значение

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Получение группы регистрации устройств.

function getEnrollmentGroup(id: string, getCallback?: HttpResponseCallback<EnrollmentGroup>)

Параметры

id

string

Идентификатор группы индивидуальной регистрации.

getCallback

HttpResponseCallback<EnrollmentGroup>

Вызывается после завершения операции.

getEnrollmentGroupAttestationMechanism(string) 

function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>

Параметры

enrollmentGroupId

string

Возвращаемое значение

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Возвращает механизм аттестации для записи EnrollmentGroup.

function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string, callback: HttpResponseCallback<AttestationMechanism>)

Параметры

enrollmentGroupId

string

Уникальный идентификатор EnrollmentGroup.

callback

HttpResponseCallback<AttestationMechanism>

Функция, вызываемая при выполнении запроса с ошибкой или с объектом AttestationMechanism.

getIndividualEnrollment(string) 

function getIndividualEnrollment(id: string): Promise<ResultWithHttpResponse<IndividualEnrollment>>

Параметры

id

string

Возвращаемое значение

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Получение записи о регистрации устройства.

function getIndividualEnrollment(id: string, getCallback?: HttpResponseCallback<IndividualEnrollment>)

Параметры

id

string

Идентификатор регистрации.

getCallback

HttpResponseCallback<IndividualEnrollment>

Вызывается после завершения операции.

getIndividualEnrollmentAttestationMechanism(string) 

function getIndividualEnrollmentAttestationMechanism(enrollmentId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>

Параметры

enrollmentId

string

Возвращаемое значение

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Возвращает механизм аттестации для записи IndividualEnrollment.

function getIndividualEnrollmentAttestationMechanism(enrollmentId: string, callback: HttpResponseCallback<AttestationMechanism>)

Параметры

enrollmentId

string

Уникальный идентификатор регистрации.

callback

HttpResponseCallback<AttestationMechanism>

Функция, вызываемая при выполнении запроса с ошибкой или с объектом AttestationMechanism.

runBulkEnrollmentOperation(BulkEnrollmentOperation) 

function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation): Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

Параметры

bulkEnrollmentOperation

BulkEnrollmentOperation

Возвращаемое значение

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Выполняет число операций CRUD с массивом записей регистрации.

function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation, callback: HttpResponseCallback<BulkEnrollmentOperationResult>)

Параметры

bulkEnrollmentOperation

BulkEnrollmentOperation

Объект , указывающий один тип операций CRUD в массиве объектов IndividualEnrollment, которые также являются частью объекта .

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

Вызывается после завершения операции.