ProvisioningServiceClient class
Metodi
Dettagli costruttore
ProvisioningServiceClient(TransportConfig, RestApiClient)
new ProvisioningServiceClient(config: TransportConfig, restApiClient?: RestApiClient)
Parametri
- config
-
TransportConfig
- restApiClient
-
RestApiClient
Dettagli metodo
createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)
Crea una query che può essere usata per restituire, per uno specifico EnrollmentGroup, pagine dello stato di registrazione del dispositivo esistente.
function createEnrollmentGroupDeviceRegistrationStateQuery(querySpecification: QuerySpecification, enrollmentGroupId: string, pageSize?: number): Query
Parametri
- querySpecification
-
QuerySpecification
Specifica della query.
- enrollmentGroupId
-
string
ID EnrollmentGroup che fornisce l'ambito per la query.
- pageSize
-
number
Numero massimo di elementi da restituire per pagina.
Valori restituiti
Query
createEnrollmentGroupQuery(QuerySpecification, number)
Crea una query che può essere usata per restituire pagine di gruppi di registrazioni esistenti.
function createEnrollmentGroupQuery(querySpecification: QuerySpecification, pageSize?: number): Query
Parametri
- querySpecification
-
QuerySpecification
Specifica della query.
- pageSize
-
number
Numero massimo di elementi da restituire per pagina.
Valori restituiti
Query
createIndividualEnrollmentQuery(QuerySpecification, number)
Crea una query che può essere usata per restituire pagine di registrazioni esistenti.
function createIndividualEnrollmentQuery(querySpecification: QuerySpecification, pageSize?: number): Query
Parametri
- querySpecification
-
QuerySpecification
Specifica della query.
- pageSize
-
number
Numero massimo di elementi da restituire per pagina.
Valori restituiti
Query
createOrUpdateEnrollmentGroup(EnrollmentGroup)
function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup): Promise<ResultWithHttpResponse<EnrollmentGroup>>
Parametri
- enrollmentGroup
-
EnrollmentGroup
Valori restituiti
Promise<ResultWithHttpResponse<EnrollmentGroup>>
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)
Creare o aggiornare un gruppo di registrazione dispositivi.
function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup, callback?: HttpResponseCallback<EnrollmentGroup>)
Parametri
- enrollmentGroup
-
EnrollmentGroup
Gruppo di registrazione dispositivi.
- callback
-
HttpResponseCallback<EnrollmentGroup>
Richiamato al completamento dell'operazione.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment): Promise<ResultWithHttpResponse<IndividualEnrollment>>
Parametri
- enrollment
-
IndividualEnrollment
Valori restituiti
Promise<ResultWithHttpResponse<IndividualEnrollment>>
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)
Creare o aggiornare un record di registrazione del dispositivo.
function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment, callback?: HttpResponseCallback<IndividualEnrollment>)
Parametri
- enrollment
-
IndividualEnrollment
Record di registrazione del dispositivo.
- callback
-
HttpResponseCallback<IndividualEnrollment>
Richiamato al completamento dell'operazione.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState): Promise<void>
Parametri
- idOrRegistrationState
-
string | DeviceRegistrationState
Valori restituiti
Promise<void>
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, deleteCallback: ErrorCallback)
Parametri
- idOrRegistrationState
-
string | DeviceRegistrationState
- deleteCallback
-
ErrorCallback
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string): Promise<void>
Parametri
- idOrRegistrationState
-
string | DeviceRegistrationState
- etag
-
string
Valori restituiti
Promise<void>
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)
Eliminare lo stato di registrazione del dispositivo.
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string, deleteCallback?: ErrorCallback)
Parametri
- idOrRegistrationState
-
string | DeviceRegistrationState
Stringa contenente l'ID di registrazione OPPURE un deviceRegistrationState effettivo.
- etag
-
string
- deleteCallback
-
ErrorCallback
Richiamato al completamento dell'operazione.
deleteEnrollmentGroup(string | EnrollmentGroup)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup): Promise<void>
Parametri
- enrollmentGroupOrId
-
string | EnrollmentGroup
Valori restituiti
Promise<void>
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, deleteCallback: ErrorCallback)
Parametri
- enrollmentGroupOrId
-
string | EnrollmentGroup
- deleteCallback
-
ErrorCallback
deleteEnrollmentGroup(string | EnrollmentGroup, string)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string): Promise<void>
Parametri
- enrollmentGroupOrId
-
string | EnrollmentGroup
- etag
-
string
Valori restituiti
Promise<void>
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)
Eliminare un gruppo di registrazione dispositivi.
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string, deleteCallback?: ErrorCallback)
Parametri
- enrollmentGroupOrId
-
string | EnrollmentGroup
Oggetto EnrollmentGroup o stringa contenente l'ID gruppo di registrazione.
- etag
-
string
- deleteCallback
-
ErrorCallback
Richiamato al completamento dell'operazione.
deleteIndividualEnrollment(string | IndividualEnrollment)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment): Promise<void>
Parametri
- enrollmentOrId
-
string | IndividualEnrollment
Valori restituiti
Promise<void>
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, deleteCallback: ErrorCallback)
Parametri
- enrollmentOrId
-
string | IndividualEnrollment
- deleteCallback
-
ErrorCallback
deleteIndividualEnrollment(string | IndividualEnrollment, string)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string): Promise<void>
Parametri
- enrollmentOrId
-
string | IndividualEnrollment
- etag
-
string
Valori restituiti
Promise<void>
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)
Eliminare un record di registrazione del dispositivo.
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string, deleteCallback?: ErrorCallback)
Parametri
- enrollmentOrId
-
string | IndividualEnrollment
Oggetto IndividualEnrollment o stringa contenente l'ID di registrazione.
- etag
-
string
- deleteCallback
-
ErrorCallback
Richiamato al completamento dell'operazione.
fromConnectionString(string)
Costruisce un oggetto ProvisioningServiceClient dalla data stringa di connessione usando il trasporto predefinito (module:azure-iothub. Http| Http).
static function fromConnectionString(value: string): ProvisioningServiceClient
Parametri
- value
-
string
Stringa di connessione che incapsula le autorizzazioni Appropriate (lettura e/o scrittura) ProvisioningServiceClient.
Valori restituiti
fromTokenCredential(string, TokenCredential)
Costruisce un oggetto ProvisioningServiceClient dal dato Azure TokenCredential usando il trasporto predefinito (module:azure-iothub. Http| Http).
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): ProvisioningServiceClient
Parametri
- hostName
-
string
Nome host del servizio di Azure.
- tokenCredential
- TokenCredential
TokenCredential di Azure usato per l'autenticazione con il servizio di Azure
Valori restituiti
getDeviceRegistrationState(string)
function getDeviceRegistrationState(id: string): Promise<ResultWithHttpResponse<DeviceRegistrationState>>
Parametri
- id
-
string
Valori restituiti
Promise<ResultWithHttpResponse<DeviceRegistrationState>>
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)
Ottiene lo stato di registrazione del dispositivo.
function getDeviceRegistrationState(id: string, callback?: HttpResponseCallback<DeviceRegistrationState>)
Parametri
- id
-
string
ID registrazione.
- callback
-
HttpResponseCallback<DeviceRegistrationState>
Richiamato al completamento dell'operazione.
getEnrollmentGroup(string)
function getEnrollmentGroup(id: string): Promise<ResultWithHttpResponse<EnrollmentGroup>>
Parametri
- id
-
string
Valori restituiti
Promise<ResultWithHttpResponse<EnrollmentGroup>>
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)
Ottenere un gruppo di registrazione dispositivi.
function getEnrollmentGroup(id: string, getCallback?: HttpResponseCallback<EnrollmentGroup>)
Parametri
- id
-
string
ID gruppo individualenrollment.
- getCallback
-
HttpResponseCallback<EnrollmentGroup>
Richiamato al completamento dell'operazione.
getEnrollmentGroupAttestationMechanism(string)
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>
Parametri
- enrollmentGroupId
-
string
Valori restituiti
Promise<ResultWithHttpResponse<AttestationMechanism>>
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)
Ottiene il meccanismo di attestazione per un record EnrollmentGroup.
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string, callback: HttpResponseCallback<AttestationMechanism>)
Parametri
- enrollmentGroupId
-
string
Identificatore univoco di EnrollmentGroup.
- callback
-
HttpResponseCallback<AttestationMechanism>
Funzione chiamata al completamento della richiesta, con un errore o con un oggetto AttestationMechanism.
getIndividualEnrollment(string)
function getIndividualEnrollment(id: string): Promise<ResultWithHttpResponse<IndividualEnrollment>>
Parametri
- id
-
string
Valori restituiti
Promise<ResultWithHttpResponse<IndividualEnrollment>>
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)
Ottenere un record di registrazione del dispositivo.
function getIndividualEnrollment(id: string, getCallback?: HttpResponseCallback<IndividualEnrollment>)
Parametri
- id
-
string
ID registrazione.
- getCallback
-
HttpResponseCallback<IndividualEnrollment>
Richiamato al completamento dell'operazione.
getIndividualEnrollmentAttestationMechanism(string)
function getIndividualEnrollmentAttestationMechanism(enrollmentId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>
Parametri
- enrollmentId
-
string
Valori restituiti
Promise<ResultWithHttpResponse<AttestationMechanism>>
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)
Ottiene il meccanismo di attestazione per un record IndividualEnrollment.
function getIndividualEnrollmentAttestationMechanism(enrollmentId: string, callback: HttpResponseCallback<AttestationMechanism>)
Parametri
- enrollmentId
-
string
Identificatore univoco della registrazione.
- callback
-
HttpResponseCallback<AttestationMechanism>
Funzione chiamata al completamento della richiesta, con un errore o con un oggetto AttestationMechanism.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation): Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
Parametri
- bulkEnrollmentOperation
-
BulkEnrollmentOperation
Valori restituiti
Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)
Esegue un numero di operazioni CRUD su una matrice di record di registrazione.
function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation, callback: HttpResponseCallback<BulkEnrollmentOperationResult>)
Parametri
- bulkEnrollmentOperation
-
BulkEnrollmentOperation
Oggetto che specifica il singolo tipo di operazioni CRUD sulla matrice di oggetti IndividualEnrollment che fanno anche parte dell'oggetto .
- callback
-
HttpResponseCallback<BulkEnrollmentOperationResult>
Richiamato al completamento dell'operazione.