ProvisioningServiceClient class

Paquet:

azure-iot-provisioning-service

Constructeurs

ProvisioningServiceClient(TransportConfig, RestApiClient)

Méthodes

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)	Crée une requête qui peut être utilisée pour retourner, pour un EnrollmentGroup spécifique, des pages d’inscription d’appareils status existantes.
createEnrollmentGroupQuery(QuerySpecification, number)	Crée une requête qui peut être utilisée pour retourner des pages de groupes d’inscription existants.
createIndividualEnrollmentQuery(QuerySpecification, number)	Crée une requête qui peut être utilisée pour retourner des pages d’inscriptions existantes.
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)	Créer ou mettre à jour un groupe d’inscriptions d’appareils.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)	Créez ou mettez à jour un enregistrement d’inscription d’appareil.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)	Supprimez un status d’inscription d’appareil.
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)	Supprimez un groupe d’inscriptions d’appareils.
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)	Supprimez un enregistrement d’inscription d’appareil.
fromConnectionString(string)	Construit un objet ProvisioningServiceClient à partir de la chaîne de connexion donnée à l’aide du transport par défaut (Http).
fromTokenCredential(string, TokenCredential)	Construit un objet ProvisioningServiceClient à partir de l’objet Azure TokenCredential donné à l’aide du transport par défaut (Http).
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)	Obtient le status d’inscription de l’appareil.
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)	Obtenez un groupe d’inscriptions d’appareils.
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Obtient le mécanisme d’attestation pour un enregistrement EnrollmentGroup.
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)	Obtenir un enregistrement d’inscription d’appareil.
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Obtient le mécanisme d’attestation pour un enregistrement IndividualEnrollment.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)	Exécute un nombre d’opérations CRUD sur un tableau d’enregistrements d’inscription.

Détails du constructeur

ProvisioningServiceClient(TransportConfig, RestApiClient)

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

Paramètres

config

TransportConfig

restApiClient

RestApiClient

Détails de la méthode

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Crée une requête qui peut être utilisée pour retourner, pour un EnrollmentGroup spécifique, des pages d’inscription d’appareils status existantes.

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

Paramètres

querySpecification

QuerySpecification

Spécification de requête.

enrollmentGroupId

string

ID EnrollmentGroup qui fournit l’étendue de la requête.

pageSize

number

Nombre maximal d’éléments à retourner par page.

Retours

Query

createEnrollmentGroupQuery(QuerySpecification, number)

Crée une requête qui peut être utilisée pour retourner des pages de groupes d’inscription existants.

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

Paramètres

querySpecification

QuerySpecification

Spécification de requête.

pageSize

number

Nombre maximal d’éléments à retourner par page.

Retours

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

Crée une requête qui peut être utilisée pour retourner des pages d’inscriptions existantes.

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

Paramètres

querySpecification

QuerySpecification

Spécification de requête.

pageSize

number

Nombre maximal d’éléments à retourner par page.

Retours

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup)

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

Paramètres

enrollmentGroup

EnrollmentGroup

Retours

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Créer ou mettre à jour un groupe d’inscriptions d’appareils.

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

Paramètres

enrollmentGroup

EnrollmentGroup

Groupe d’inscriptions d’appareils.

callback

HttpResponseCallback<EnrollmentGroup>

Appelé à la fin de l’opération.

createOrUpdateIndividualEnrollment(IndividualEnrollment)

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

Paramètres

enrollment

IndividualEnrollment

Retours

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Créez ou mettez à jour un enregistrement d’inscription d’appareil.

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

Paramètres

enrollment

IndividualEnrollment

Enregistrement d’inscription d’appareil.

callback

HttpResponseCallback<IndividualEnrollment>

Appelé à la fin de l’opération.

deleteDeviceRegistrationState(string | DeviceRegistrationState)

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

Paramètres

idOrRegistrationState

string | DeviceRegistrationState

Retours

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)

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

Paramètres

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string)

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

Paramètres

idOrRegistrationState

string | DeviceRegistrationState

etag

string

Retours

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Supprimez un status d’inscription d’appareil.

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

Paramètres

idOrRegistrationState

string | DeviceRegistrationState

Chaîne contenant l’ID d’inscription OU un DeviceRegistrationState réel.

etag

string

deleteCallback

ErrorCallback

Appelé à la fin de l’opération.

deleteEnrollmentGroup(string | EnrollmentGroup)

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

Paramètres

enrollmentGroupOrId

string | EnrollmentGroup

Retours

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)

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

Paramètres

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string)

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

Paramètres

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

Retours

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Supprimez un groupe d’inscriptions d’appareils.

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

Paramètres

enrollmentGroupOrId

string | EnrollmentGroup

Objet EnrollmentGroup ou chaîne contenant l’ID de groupe d’inscription.

etag

string

deleteCallback

ErrorCallback

Appelé à la fin de l’opération.

deleteIndividualEnrollment(string | IndividualEnrollment)

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

Paramètres

enrollmentOrId

string | IndividualEnrollment

Retours

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)

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

Paramètres

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string)

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

Paramètres

enrollmentOrId

string | IndividualEnrollment

etag

string

Retours

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Supprimez un enregistrement d’inscription d’appareil.

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

Paramètres

enrollmentOrId

string | IndividualEnrollment

Objet IndividualEnrollment ou chaîne contenant l’ID d’inscription.

etag

string

deleteCallback

ErrorCallback

Appelé à la fin de l’opération.

fromConnectionString(string)

Construit un objet ProvisioningServiceClient à partir de la chaîne de connexion donnée à l’aide du transport par défaut (Http).

static function fromConnectionString(value: string): ProvisioningServiceClient

Paramètres

value

string

Chaîne de connexion qui encapsule les autorisations ProvisioningServiceClient appropriées (lecture et/ou écriture).

Retours

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

Construit un objet ProvisioningServiceClient à partir de l’objet Azure TokenCredential donné à l’aide du transport par défaut (Http).

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

Paramètres

hostName

string

Nom d’hôte du service Azure.

tokenCredential

TokenCredential

Un jeton Azure TokenCredential utilisé pour s’authentifier auprès du service Azure

Retours

ProvisioningServiceClient

getDeviceRegistrationState(string)

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

Paramètres

id

string

Retours

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Obtient le status d’inscription de l’appareil.

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

Paramètres

id

string

ID d’inscription.

callback

HttpResponseCallback<DeviceRegistrationState>

Appelé à la fin de l’opération.

getEnrollmentGroup(string)

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

Paramètres

id

string

Retours

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Obtenez un groupe d’inscriptions d’appareils.

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

Paramètres

id

string

ID de groupe IndividualEnrollment.

getCallback

HttpResponseCallback<EnrollmentGroup>

Appelé à la fin de l’opération.

getEnrollmentGroupAttestationMechanism(string)

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

Paramètres

enrollmentGroupId

string

Retours

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtient le mécanisme d’attestation pour un enregistrement EnrollmentGroup.

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

Paramètres

enrollmentGroupId

string

Identificateur unique du EnrollmentGroup.

callback

HttpResponseCallback<AttestationMechanism>

Fonction appelée lorsque la demande est terminée, avec une erreur ou avec un objet AttestationMechanism.

getIndividualEnrollment(string)

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

Paramètres

id

string

Retours

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Obtenir un enregistrement d’inscription d’appareil.

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

Paramètres

id

string

ID d’inscription.

getCallback

HttpResponseCallback<IndividualEnrollment>

Appelé à la fin de l’opération.

getIndividualEnrollmentAttestationMechanism(string)

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

Paramètres

enrollmentId

string

Retours

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtient le mécanisme d’attestation pour un enregistrement IndividualEnrollment.

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

Paramètres

enrollmentId

string

Identificateur unique de l’inscription.

callback

HttpResponseCallback<AttestationMechanism>

Fonction appelée lorsque la demande est terminée, avec une erreur ou avec un objet AttestationMechanism.

runBulkEnrollmentOperation(BulkEnrollmentOperation)

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

Paramètres

bulkEnrollmentOperation

BulkEnrollmentOperation

Retours

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Exécute un nombre d’opérations CRUD sur un tableau d’enregistrements d’inscription.

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

Paramètres

bulkEnrollmentOperation

BulkEnrollmentOperation

Objet qui spécifie le type unique d’opérations CRUD sur le tableau d’objets IndividualEnrollment qui font également partie de l’objet.

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

Appelé à la fin de l’opération.