ProvisioningServiceClient class

Paquete:

azure-iot-provisioning-service

Constructores

ProvisioningServiceClient(TransportConfig, RestApiClient)

Métodos

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)	Crea una consulta que se puede usar para devolver, para un EnrollmentGroup específico, páginas del estado de registro de dispositivos existente.
createEnrollmentGroupQuery(QuerySpecification, number)	Crea una consulta que se puede usar para devolver páginas de grupos de inscripción existentes.
createIndividualEnrollmentQuery(QuerySpecification, number)	Crea una consulta que se puede usar para devolver páginas de inscripciones existentes.
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)	Cree o actualice un grupo de inscripción de dispositivos.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)	Cree o actualice un registro de inscripción de dispositivos.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)	Elimine un estado de registro de dispositivo.
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)	Elimine un grupo de inscripción de dispositivos.
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)	Elimine un registro de inscripción de dispositivos.
fromConnectionString(string)	Construye un objeto ProvisioningServiceClient a partir de la cadena de conexión especificada mediante el transporte predeterminado (Http).
fromTokenCredential(string, TokenCredential)	Construye un objeto ProvisioningServiceClient a partir del TokenCredential de Azure especificado mediante el transporte predeterminado (Http).
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)	Obtiene el estado de registro del dispositivo.
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)	Obtiene un grupo de inscripción de dispositivos.
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Obtiene el mecanismo de atestación de un registro EnrollmentGroup.
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)	Obtenga un registro de inscripción de dispositivos.
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Obtiene el mecanismo de atestación de un registro IndividualEnrollment.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)	Ejecuta una serie de operaciones CRUD en una matriz de registros de inscripción.

Detalles del constructor

ProvisioningServiceClient(TransportConfig, RestApiClient)

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

Parámetros

config

TransportConfig

restApiClient

RestApiClient

Detalles del método

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Crea una consulta que se puede usar para devolver, para un EnrollmentGroup específico, páginas del estado de registro de dispositivos existente.

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

Parámetros

querySpecification

QuerySpecification

Especificación de consulta.

enrollmentGroupId

string

Identificador enrollmentGroup que proporciona el ámbito de la consulta.

pageSize

number

Número máximo de elementos que se van a devolver por página.

Devoluciones

Query

createEnrollmentGroupQuery(QuerySpecification, number)

Crea una consulta que se puede usar para devolver páginas de grupos de inscripción existentes.

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

Parámetros

querySpecification

QuerySpecification

Especificación de consulta.

pageSize

number

Número máximo de elementos que se van a devolver por página.

Devoluciones

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

Crea una consulta que se puede usar para devolver páginas de inscripciones existentes.

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

Parámetros

querySpecification

QuerySpecification

Especificación de consulta.

pageSize

number

Número máximo de elementos que se van a devolver por página.

Devoluciones

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup)

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

Parámetros

enrollmentGroup

EnrollmentGroup

Devoluciones

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Cree o actualice un grupo de inscripción de dispositivos.

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

Parámetros

enrollmentGroup

EnrollmentGroup

El grupo de inscripción de dispositivos.

callback

HttpResponseCallback<EnrollmentGroup>

Se invoca al finalizar la operación.

createOrUpdateIndividualEnrollment(IndividualEnrollment)

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

Parámetros

enrollment

IndividualEnrollment

Devoluciones

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Cree o actualice un registro de inscripción de dispositivos.

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

Parámetros

enrollment

IndividualEnrollment

Registro de inscripción de dispositivos.

callback

HttpResponseCallback<IndividualEnrollment>

Se invoca al finalizar la operación.

deleteDeviceRegistrationState(string | DeviceRegistrationState)

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

Parámetros

idOrRegistrationState

string | DeviceRegistrationState

Devoluciones

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

Devoluciones

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Elimine un estado de registro de dispositivo.

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

Parámetros

idOrRegistrationState

string | DeviceRegistrationState

Cadena que contiene el identificador de registro O un deviceRegistrationState real.

etag

string

deleteCallback

ErrorCallback

Se invoca al finalizar la operación.

deleteEnrollmentGroup(string | EnrollmentGroup)

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

Parámetros

enrollmentGroupOrId

string | EnrollmentGroup

Devoluciones

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

Devoluciones

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Elimine un grupo de inscripción de dispositivos.

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

Parámetros

enrollmentGroupOrId

string | EnrollmentGroup

EnrollmentGroup objeto o una cadena que contiene el identificador de grupo de inscripción.

etag

string

deleteCallback

ErrorCallback

Se invoca al finalizar la operación.

deleteIndividualEnrollment(string | IndividualEnrollment)

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

Parámetros

enrollmentOrId

string | IndividualEnrollment

Devoluciones

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

Devoluciones

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Elimine un registro de inscripción de dispositivos.

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

Parámetros

enrollmentOrId

string | IndividualEnrollment

Objeto IndividualEnrollment o una cadena que contiene el identificador de registro.

etag

string

deleteCallback

ErrorCallback

Se invoca al finalizar la operación.

fromConnectionString(string)

Construye un objeto ProvisioningServiceClient a partir de la cadena de conexión especificada mediante el transporte predeterminado (Http).

static function fromConnectionString(value: string): ProvisioningServiceClient

Parámetros

value

string

Cadena de conexión que encapsula los permisos de ProvisioningServiceClient adecuados (lectura o escritura).

Devoluciones

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

Construye un objeto ProvisioningServiceClient a partir del TokenCredential de Azure especificado mediante el transporte predeterminado (Http).

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

Parámetros

hostName

string

Nombre de host del servicio de Azure.

tokenCredential

TokenCredential

Un TokenCredential de Azure que se usa para autenticarse con el servicio de Azure

Devoluciones

ProvisioningServiceClient

getDeviceRegistrationState(string)

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

Parámetros

id

string

Devoluciones

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Obtiene el estado de registro del dispositivo.

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

Parámetros

id

string

Id. de registro.

callback

HttpResponseCallback<DeviceRegistrationState>

Se invoca al finalizar la operación.

getEnrollmentGroup(string)

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

Parámetros

id

string

Devoluciones

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Obtiene un grupo de inscripción de dispositivos.

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

Parámetros

id

string

Id. de grupo de inscripción individual.

getCallback

HttpResponseCallback<EnrollmentGroup>

Se invoca al finalizar la operación.

getEnrollmentGroupAttestationMechanism(string)

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

Parámetros

enrollmentGroupId

string

Devoluciones

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtiene el mecanismo de atestación de un registro EnrollmentGroup.

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

Parámetros

enrollmentGroupId

string

Identificador único del EnrollmentGroup.

callback

HttpResponseCallback<AttestationMechanism>

Función a la que se llama cuando se completa la solicitud, ya sea con un error o con un objeto AttestationMechanism.

getIndividualEnrollment(string)

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

Parámetros

id

string

Devoluciones

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Obtenga un registro de inscripción de dispositivos.

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

Parámetros

id

string

Id. de registro.

getCallback

HttpResponseCallback<IndividualEnrollment>

Se invoca al finalizar la operación.

getIndividualEnrollmentAttestationMechanism(string)

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

Parámetros

enrollmentId

string

Devoluciones

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtiene el mecanismo de atestación de un registro IndividualEnrollment.

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

Parámetros

enrollmentId

string

Identificador único de la inscripción.

callback

HttpResponseCallback<AttestationMechanism>

Función a la que se llama cuando se completa la solicitud, ya sea con un error o con un objeto AttestationMechanism.

runBulkEnrollmentOperation(BulkEnrollmentOperation)

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

Parámetros

bulkEnrollmentOperation

BulkEnrollmentOperation

Devoluciones

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Ejecuta una serie de operaciones CRUD en una matriz de registros de inscripción.

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

Parámetros

bulkEnrollmentOperation

BulkEnrollmentOperation

Objeto que especifica el tipo único de operaciones CRUD en la matriz de objetos IndividualEnrollment que también forman parte del objeto .

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

Se invoca al finalizar la operación.