ProvisioningServiceClient class

Balíček:

azure-iot-provisioning-service

Konstruktory

ProvisioningServiceClient(TransportConfig, RestApiClient)

Metody

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)	Vytvoří dotaz, který lze použít k vrácení konkrétní skupiny EnrollmentGroup, stránky existujícího stavu registrace zařízení.
createEnrollmentGroupQuery(QuerySpecification, number)	Vytvoří dotaz, který lze použít k vrácení stránek existujících skupin registrací.
createIndividualEnrollmentQuery(QuerySpecification, number)	Vytvoří dotaz, který lze použít k vrácení stránek existujících registrací.
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)	Vytvořte nebo aktualizujte skupinu registrací zařízení.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)	Vytvoření nebo aktualizace záznamu registrace zařízení
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)	Odstraňte stav registrace zařízení.
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)	Odstraňte skupinu registrací zařízení.
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)	Odstranění záznamu registrace zařízení
fromConnectionString(string)	Vytvoří objekt ProvisioningServiceClient z daného připojovacího řetězce pomocí výchozího přenosu (Http).
fromTokenCredential(string, TokenCredential)	Vytvoří objekt ProvisioningServiceClient z daného objektu Azure TokenCredential pomocí výchozího přenosu (Http).
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)	Získá stav registrace zařízení.
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)	Získejte skupinu registrace zařízení.
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Získá mechanismus ověření identity pro záznam EnrollmentGroup.
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)	Získejte záznam registrace zařízení.
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Získá mechanismus ověření identity pro záznam IndividualEnrollment.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)	Spustí několik operací CRUD v poli záznamů registrace.

Podrobnosti konstruktoru

ProvisioningServiceClient(TransportConfig, RestApiClient)

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

Parametry

config

TransportConfig

restApiClient

RestApiClient

Podrobnosti metody

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Vytvoří dotaz, který lze použít k vrácení konkrétní skupiny EnrollmentGroup, stránky existujícího stavu registrace zařízení.

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

Parametry

querySpecification

QuerySpecification

Specifikace dotazu.

enrollmentGroupId

string

ID EnrollmentGroup, které poskytuje obor dotazu.

pageSize

number

Maximální počet prvků, které se mají vrátit na stránku.

Návraty

Query

createEnrollmentGroupQuery(QuerySpecification, number)

Vytvoří dotaz, který lze použít k vrácení stránek existujících skupin registrací.

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

Parametry

querySpecification

QuerySpecification

Specifikace dotazu.

pageSize

number

Maximální počet prvků, které se mají vrátit na stránku.

Návraty

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

Vytvoří dotaz, který lze použít k vrácení stránek existujících registrací.

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

Parametry

querySpecification

QuerySpecification

Specifikace dotazu.

pageSize

number

Maximální počet prvků, které se mají vrátit na stránku.

Návraty

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup)

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

Parametry

enrollmentGroup

EnrollmentGroup

Návraty

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Vytvořte nebo aktualizujte skupinu registrací zařízení.

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

Parametry

enrollmentGroup

EnrollmentGroup

Skupina registrace zařízení.

callback

HttpResponseCallback<EnrollmentGroup>

Vyvoláno po dokončení operace.

createOrUpdateIndividualEnrollment(IndividualEnrollment)

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

Parametry

enrollment

IndividualEnrollment

Návraty

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Vytvoření nebo aktualizace záznamu registrace zařízení

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

Parametry

enrollment

IndividualEnrollment

Záznam registrace zařízení.

callback

HttpResponseCallback<IndividualEnrollment>

Vyvoláno po dokončení operace.

deleteDeviceRegistrationState(string | DeviceRegistrationState)

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

Parametry

idOrRegistrationState

string | DeviceRegistrationState

Návraty

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)

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

Parametry

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string)

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

Parametry

idOrRegistrationState

string | DeviceRegistrationState

etag

string

Návraty

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Odstraňte stav registrace zařízení.

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

Parametry

idOrRegistrationState

string | DeviceRegistrationState

Řetězec obsahující ID registrace NEBO skutečný DeviceRegistrationState.

etag

string

deleteCallback

ErrorCallback

Vyvoláno po dokončení operace.

deleteEnrollmentGroup(string | EnrollmentGroup)

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

Parametry

enrollmentGroupOrId

string | EnrollmentGroup

Návraty

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)

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

Parametry

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string)

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

Parametry

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

Návraty

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Odstraňte skupinu registrací zařízení.

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

Parametry

enrollmentGroupOrId

string | EnrollmentGroup

Objekt EnrollmentGroup nebo řetězec obsahující ID skupiny registrace.

etag

string

deleteCallback

ErrorCallback

Vyvoláno po dokončení operace.

deleteIndividualEnrollment(string | IndividualEnrollment)

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

Parametry

enrollmentOrId

string | IndividualEnrollment

Návraty

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)

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

Parametry

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string)

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

Parametry

enrollmentOrId

string | IndividualEnrollment

etag

string

Návraty

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Odstranění záznamu registrace zařízení

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

Parametry

enrollmentOrId

string | IndividualEnrollment

Objekt IndividualEnrollment nebo řetězec obsahující ID registrace.

etag

string

deleteCallback

ErrorCallback

Vyvoláno po dokončení operace.

fromConnectionString(string)

Vytvoří objekt ProvisioningServiceClient z daného připojovacího řetězce pomocí výchozího přenosu (Http).

static function fromConnectionString(value: string): ProvisioningServiceClient

Parametry

value

string

Připojovací řetězec, který zapouzdřuje příslušná oprávnění (čtení a/nebo zápisu) ProvisioningServiceClient.

Návraty

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

Vytvoří objekt ProvisioningServiceClient z daného objektu Azure TokenCredential pomocí výchozího přenosu (Http).

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

Parametry

hostName

string

Název hostitele služby Azure.

tokenCredential

TokenCredential

TokenCredential Azure sloužící k ověření ve službě Azure

Návraty

ProvisioningServiceClient

getDeviceRegistrationState(string)

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

Parametry

id

string

Návraty

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Získá stav registrace zařízení.

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

Parametry

id

string

ID registrace.

callback

HttpResponseCallback<DeviceRegistrationState>

Vyvoláno po dokončení operace.

getEnrollmentGroup(string)

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

Parametry

id

string

Návraty

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Získejte skupinu registrace zařízení.

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

Parametry

id

string

ID skupiny IndividualEnrollment.

getCallback

HttpResponseCallback<EnrollmentGroup>

Vyvoláno po dokončení operace.

getEnrollmentGroupAttestationMechanism(string)

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

Parametry

enrollmentGroupId

string

Návraty

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Získá mechanismus ověření identity pro záznam EnrollmentGroup.

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

Parametry

enrollmentGroupId

string

Jedinečný identifikátor skupiny EnrollmentGroup.

callback

HttpResponseCallback<AttestationMechanism>

Funkce volala při dokončení požadavku buď s chybou, nebo s objektem AttestationMechanism.

getIndividualEnrollment(string)

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

Parametry

id

string

Návraty

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Získejte záznam registrace zařízení.

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

Parametry

id

string

ID registrace.

getCallback

HttpResponseCallback<IndividualEnrollment>

Vyvoláno po dokončení operace.

getIndividualEnrollmentAttestationMechanism(string)

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

Parametry

enrollmentId

string

Návraty

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Získá mechanismus ověření identity pro záznam IndividualEnrollment.

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

Parametry

enrollmentId

string

Jedinečný identifikátor registrace.

callback

HttpResponseCallback<AttestationMechanism>

Funkce volala při dokončení požadavku buď s chybou, nebo s objektem AttestationMechanism.

runBulkEnrollmentOperation(BulkEnrollmentOperation)

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

Parametry

bulkEnrollmentOperation

BulkEnrollmentOperation

Návraty

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Spustí několik operací CRUD v poli záznamů registrace.

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

Parametry

bulkEnrollmentOperation

BulkEnrollmentOperation

Objekt, který určuje jeden druh operací CRUD v poli IndividualEnrollment objektů, které jsou také součástí objektu.

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

Vyvoláno po dokončení operace.