ProvisioningServiceClient class

Pacote:

azure-iot-provisioning-service

Construtores

ProvisioningServiceClient(TransportConfig, RestApiClient)

Métodos

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)	Cria uma consulta que pode ser usada para retornar, para um EnrollmentGroup específico, páginas de status de registro de dispositivo existentes.
createEnrollmentGroupQuery(QuerySpecification, number)	Cria uma consulta que pode ser usada para retornar páginas de grupos de registro existentes.
createIndividualEnrollmentQuery(QuerySpecification, number)	Cria uma consulta que pode ser usada para retornar páginas de registros existentes.
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)	Criar ou atualizar um grupo de registro de dispositivo.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)	Criar ou atualizar um registro de dispositivo.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)	Exclua um status de registro de dispositivo.
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)	Exclua um grupo de registro de dispositivo.
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)	Exclua um registro de dispositivo.
fromConnectionString(string)	Constrói um objeto ProvisioningServiceClient da cadeia de conexão fornecida usando o transporte padrão (Http).
fromTokenCredential(string, TokenCredential)	Constrói um objeto ProvisioningServiceClient do TokenCredential do Azure fornecido usando o transporte padrão (Http).
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)	Obtém o status de registro do dispositivo.
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)	Obter um grupo de registro de dispositivo.
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Obtém o mecanismo de atestado para um registro EnrollmentGroup.
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)	Obter um registro de dispositivo.
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Obtém o mecanismo de atestado para um registro IndividualEnrollment.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)	Executa várias operações CRUD em uma matriz de registros de registro.

Detalhes do construtor

ProvisioningServiceClient(TransportConfig, RestApiClient)

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

Parâmetros

config

TransportConfig

restApiClient

RestApiClient

Detalhes do método

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Cria uma consulta que pode ser usada para retornar, para um EnrollmentGroup específico, páginas de status de registro de dispositivo existentes.

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

Parâmetros

querySpecification

QuerySpecification

A especificação de consulta.

enrollmentGroupId

string

A ID EnrollmentGroup que fornece o escopo da consulta.

pageSize

number

O número máximo de elementos a serem retornados por página.

Retornos

Query

createEnrollmentGroupQuery(QuerySpecification, number)

Cria uma consulta que pode ser usada para retornar páginas de grupos de registro existentes.

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

Parâmetros

querySpecification

QuerySpecification

A especificação de consulta.

pageSize

number

O número máximo de elementos a serem retornados por página.

Retornos

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

Cria uma consulta que pode ser usada para retornar páginas de registros existentes.

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

Parâmetros

querySpecification

QuerySpecification

A especificação de consulta.

pageSize

number

O número máximo de elementos a serem retornados por página.

Retornos

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup)

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

Parâmetros

enrollmentGroup

EnrollmentGroup

Retornos

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Criar ou atualizar um grupo de registro de dispositivo.

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

Parâmetros

enrollmentGroup

EnrollmentGroup

O grupo de registro do dispositivo.

callback

HttpResponseCallback<EnrollmentGroup>

Invocado após a conclusão da operação.

createOrUpdateIndividualEnrollment(IndividualEnrollment)

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

Parâmetros

enrollment

IndividualEnrollment

Retornos

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Criar ou atualizar um registro de dispositivo.

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

Parâmetros

enrollment

IndividualEnrollment

O registro do dispositivo.

callback

HttpResponseCallback<IndividualEnrollment>

Invocado após a conclusão da operação.

deleteDeviceRegistrationState(string | DeviceRegistrationState)

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

Retornos

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string)

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

etag

string

Retornos

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Exclua um status de registro de dispositivo.

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

Uma cadeia de caracteres que contém a ID de registro OU um DeviceRegistrationState real.

etag

string

deleteCallback

ErrorCallback

Invocado após a conclusão da operação.

deleteEnrollmentGroup(string | EnrollmentGroup)

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

Retornos

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string)

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

Retornos

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Exclua um grupo de registro de dispositivo.

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

Objeto EnrollmentGroup ou uma cadeia de caracteres que contém a ID do grupo de registro.

etag

string

deleteCallback

ErrorCallback

Invocado após a conclusão da operação.

deleteIndividualEnrollment(string | IndividualEnrollment)

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

Retornos

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string)

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

etag

string

Retornos

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Exclua um registro de dispositivo.

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

Um objeto IndividualEnrollment ou uma cadeia de caracteres que contém a ID de registro.

etag

string

deleteCallback

ErrorCallback

Invocado após a conclusão da operação.

fromConnectionString(string)

Constrói um objeto ProvisioningServiceClient da cadeia de conexão fornecida usando o transporte padrão (Http).

static function fromConnectionString(value: string): ProvisioningServiceClient

Parâmetros

value

string

Uma cadeia de conexão que encapsula as permissões de ProvisioningServiceClient apropriadas (leitura e/ou gravação).

Retornos

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

Constrói um objeto ProvisioningServiceClient do TokenCredential do Azure fornecido usando o transporte padrão (Http).

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

Parâmetros

hostName

string

Nome do host do serviço do Azure.

tokenCredential

TokenCredential

Um Tokencredential do Azure usado para autenticar com o serviço do Azure

Retornos

ProvisioningServiceClient

getDeviceRegistrationState(string)

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

Parâmetros

id

string

Retornos

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Obtém o status de registro do dispositivo.

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

Parâmetros

id

string

ID de registro.

callback

HttpResponseCallback<DeviceRegistrationState>

Invocado após a conclusão da operação.

getEnrollmentGroup(string)

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

Parâmetros

id

string

Retornos

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Obter um grupo de registro de dispositivo.

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

Parâmetros

id

string

ID do grupo IndividualEnrollment.

getCallback

HttpResponseCallback<EnrollmentGroup>

Invocado após a conclusão da operação.

getEnrollmentGroupAttestationMechanism(string)

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

Parâmetros

enrollmentGroupId

string

Retornos

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtém o mecanismo de atestado para um registro EnrollmentGroup.

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

Parâmetros

enrollmentGroupId

string

Identificador exclusivo do EnrollmentGroup.

callback

HttpResponseCallback<AttestationMechanism>

Função chamada quando a solicitação é concluída, com um erro ou com um objeto AttestationMechanism.

getIndividualEnrollment(string)

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

Parâmetros

id

string

Retornos

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Obter um registro de dispositivo.

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

Parâmetros

id

string

ID de registro.

getCallback

HttpResponseCallback<IndividualEnrollment>

Invocado após a conclusão da operação.

getIndividualEnrollmentAttestationMechanism(string)

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

Parâmetros

enrollmentId

string

Retornos

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtém o mecanismo de atestado para um registro IndividualEnrollment.

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

Parâmetros

enrollmentId

string

Identificador exclusivo do registro.

callback

HttpResponseCallback<AttestationMechanism>

Função chamada quando a solicitação é concluída, com um erro ou com um objeto AttestationMechanism.

runBulkEnrollmentOperation(BulkEnrollmentOperation)

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

Parâmetros

bulkEnrollmentOperation

BulkEnrollmentOperation

Retornos

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Executa várias operações CRUD em uma matriz de registros de registro.

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

Parâmetros

bulkEnrollmentOperation

BulkEnrollmentOperation

Um objeto que especifica o único tipo de operações CRUD na matriz de objetos IndividualEnrollment que também fazem parte do objeto .

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

Invocado após a conclusão da operação.