ProvisioningServiceClient class

Paket:

azure-iot-provisioning-service

Konstruktorer

ProvisioningServiceClient(TransportConfig, RestApiClient)

Metoder

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)	Skapar en fråga som kan användas för att returnera sidor med befintlig enhetsregistreringsstatus för en specifik EnrollmentGroup.
createEnrollmentGroupQuery(QuerySpecification, number)	Skapar en fråga som kan användas för att returnera sidor i befintliga registreringsgrupper.
createIndividualEnrollmentQuery(QuerySpecification, number)	Skapar en fråga som kan användas för att returnera sidor med befintliga registreringar.
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)	Skapa eller uppdatera en enhetsregistreringsgrupp.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)	Skapa eller uppdatera en enhetsregistreringspost.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)	Ta bort status för enhetsregistrering.
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)	Ta bort en enhetsregistreringsgrupp.
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)	Ta bort en enhetsregistreringspost.
fromConnectionString(string)	Skapar ett ProvisioningServiceClient-objekt från den angivna anslutningssträngen med hjälp av standardtransporten (Http).
fromTokenCredential(string, TokenCredential)	Skapar ett ProvisioningServiceClient-objekt från den angivna Azure TokenCredential med hjälp av standardtransporten (Http).
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)	Hämtar status för enhetsregistrering.
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)	Hämta en enhetsregistreringsgrupp.
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Hämtar attesteringsmekanismen för en EnrollmentGroup-post.
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)	Hämta en enhetsregistreringspost.
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Hämtar attesteringsmekanismen för en IndividualEnrollment-post.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)	Kör ett antal CRUD-åtgärder på en matris med registreringsposter.

Konstruktorinformation

ProvisioningServiceClient(TransportConfig, RestApiClient)

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

Parametrar

config

TransportConfig

restApiClient

RestApiClient

Metodinformation

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Skapar en fråga som kan användas för att returnera sidor med befintlig enhetsregistreringsstatus för en specifik EnrollmentGroup.

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

Parametrar

querySpecification

QuerySpecification

Frågespecifikationen.

enrollmentGroupId

string

EnrollmentGroup-ID:t som innehåller omfånget för frågan.

pageSize

number

Det maximala antalet element som ska returneras per sida.

Returer

Query

createEnrollmentGroupQuery(QuerySpecification, number)

Skapar en fråga som kan användas för att returnera sidor i befintliga registreringsgrupper.

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

Parametrar

querySpecification

QuerySpecification

Frågespecifikationen.

pageSize

number

Det maximala antalet element som ska returneras per sida.

Returer

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

Skapar en fråga som kan användas för att returnera sidor med befintliga registreringar.

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

Parametrar

querySpecification

QuerySpecification

Frågespecifikationen.

pageSize

number

Det maximala antalet element som ska returneras per sida.

Returer

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup)

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

Parametrar

enrollmentGroup

EnrollmentGroup

Returer

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Skapa eller uppdatera en enhetsregistreringsgrupp.

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

Parametrar

enrollmentGroup

EnrollmentGroup

Enhetsregistreringsgruppen.

callback

HttpResponseCallback<EnrollmentGroup>

Anropas när åtgärden har slutförts.

createOrUpdateIndividualEnrollment(IndividualEnrollment)

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

Parametrar

enrollment

IndividualEnrollment

Returer

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Skapa eller uppdatera en enhetsregistreringspost.

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

Parametrar

enrollment

IndividualEnrollment

Enhetsregistreringsposten.

callback

HttpResponseCallback<IndividualEnrollment>

Anropas när åtgärden har slutförts.

deleteDeviceRegistrationState(string | DeviceRegistrationState)

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

Parametrar

idOrRegistrationState

string | DeviceRegistrationState

Returer

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)

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

Parametrar

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string)

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

Parametrar

idOrRegistrationState

string | DeviceRegistrationState

etag

string

Returer

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Ta bort status för enhetsregistrering.

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

Parametrar

idOrRegistrationState

string | DeviceRegistrationState

En sträng som innehåller registrerings-ID ELLER en faktisk DeviceRegistrationState.

etag

string

deleteCallback

ErrorCallback

Anropas när åtgärden har slutförts.

deleteEnrollmentGroup(string | EnrollmentGroup)

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

Parametrar

enrollmentGroupOrId

string | EnrollmentGroup

Returer

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)

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

Parametrar

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string)

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

Parametrar

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

Returer

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Ta bort en enhetsregistreringsgrupp.

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

Parametrar

enrollmentGroupOrId

string | EnrollmentGroup

EnrollmentGroup-objekt eller en sträng som innehåller grupp-ID:t för registrering.

etag

string

deleteCallback

ErrorCallback

Anropas när åtgärden har slutförts.

deleteIndividualEnrollment(string | IndividualEnrollment)

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

Parametrar

enrollmentOrId

string | IndividualEnrollment

Returer

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)

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

Parametrar

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string)

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

Parametrar

enrollmentOrId

string | IndividualEnrollment

etag

string

Returer

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Ta bort en enhetsregistreringspost.

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

Parametrar

enrollmentOrId

string | IndividualEnrollment

Ett IndividualEnrollment-objekt eller en sträng som innehåller registrerings-ID:t.

etag

string

deleteCallback

ErrorCallback

Anropas när åtgärden har slutförts.

fromConnectionString(string)

Skapar ett ProvisioningServiceClient-objekt från den angivna anslutningssträngen med hjälp av standardtransporten (Http).

static function fromConnectionString(value: string): ProvisioningServiceClient

Parametrar

value

string

En anslutningssträng som kapslar in lämpliga (läs- och/eller skrivbehörigheter) ProvisioningServiceClient.

Returer

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

Skapar ett ProvisioningServiceClient-objekt från den angivna Azure TokenCredential med hjälp av standardtransporten (Http).

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

Parametrar

hostName

string

Värdnamnet för Azure-tjänsten.

tokenCredential

TokenCredential

En Azure TokenCredential som används för att autentisera med Azure-tjänsten

Returer

ProvisioningServiceClient

getDeviceRegistrationState(string)

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

Parametrar

id

string

Returer

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Hämtar status för enhetsregistrering.

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

Parametrar

id

string

Registrerings-ID.

callback

HttpResponseCallback<DeviceRegistrationState>

Anropas när åtgärden har slutförts.

getEnrollmentGroup(string)

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

Parametrar

id

string

Returer

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Hämta en enhetsregistreringsgrupp.

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

Parametrar

id

string

IndividualEnrollment-grupp-ID.

getCallback

HttpResponseCallback<EnrollmentGroup>

Anropas när åtgärden har slutförts.

getEnrollmentGroupAttestationMechanism(string)

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

Parametrar

enrollmentGroupId

string

Returer

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Hämtar attesteringsmekanismen för en EnrollmentGroup-post.

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

Parametrar

enrollmentGroupId

string

Unik identifierare för EnrollmentGroup.

callback

HttpResponseCallback<AttestationMechanism>

Funktionen anropas när begäran har slutförts, antingen med ett fel eller med ett AttestationMechanism-objekt.

getIndividualEnrollment(string)

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

Parametrar

id

string

Returer

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Hämta en enhetsregistreringspost.

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

Parametrar

id

string

Registrerings-ID.

getCallback

HttpResponseCallback<IndividualEnrollment>

Anropas när åtgärden har slutförts.

getIndividualEnrollmentAttestationMechanism(string)

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

Parametrar

enrollmentId

string

Returer

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Hämtar attesteringsmekanismen för en IndividualEnrollment-post.

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

Parametrar

enrollmentId

string

Unik identifierare för registreringen.

callback

HttpResponseCallback<AttestationMechanism>

Funktionen anropas när begäran har slutförts, antingen med ett fel eller med ett AttestationMechanism-objekt.

runBulkEnrollmentOperation(BulkEnrollmentOperation)

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

Parametrar

bulkEnrollmentOperation

BulkEnrollmentOperation

Returer

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Kör ett antal CRUD-åtgärder på en matris med registreringsposter.

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

Parametrar

bulkEnrollmentOperation

BulkEnrollmentOperation

Ett objekt som anger den enda typen av CRUD-åtgärder i matrisen med IndividualEnrollment-objekt som också ingår i objektet.

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

Anropas när åtgärden har slutförts.