共用方式為

ProvisioningServiceClient class

  • 參考
套件:
azure-iot-provisioning-service

建構函式

ProvisioningServiceClient(TransportConfig, RestApiClient)

方法

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

針對特定 EnrollmentGroup，建立可用來傳回現有裝置註冊狀態頁面的查詢。
createEnrollmentGroupQuery(QuerySpecification, number)

建立可用來傳回現有註冊群組頁面的查詢。
createIndividualEnrollmentQuery(QuerySpecification, number)

建立可用來傳回現有註冊頁面的查詢。
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

建立或更新裝置註冊群組。
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

建立或更新裝置註冊記錄。
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

刪除裝置註冊狀態。
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

刪除裝置註冊群組。
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

刪除裝置註冊記錄。
fromConnectionString(string)

使用預設傳輸 (Http) ，從指定的連接字串建構 ProvisioningServiceClient 物件。
fromTokenCredential(string, TokenCredential)

使用預設傳輸 (Http) ，從指定的 Azure TokenCredential 建構 ProvisioningServiceClient 物件。
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

取得裝置註冊狀態。
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

取得裝置註冊群組。
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

取得 EnrollmentGroup 記錄的證明機制。
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

取得裝置註冊記錄。
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

取得 IndividualEnrollment 記錄的證明機制。
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

在註冊記錄陣列上執行數位 CRUD 作業。

建構函式詳細資料

ProvisioningServiceClient(TransportConfig, RestApiClient) 

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

參數

config

TransportConfig

restApiClient

RestApiClient

方法詳細資料

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

針對特定 EnrollmentGroup，建立可用來傳回現有裝置註冊狀態頁面的查詢。

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

參數

querySpecification

QuerySpecification

查詢規格。

enrollmentGroupId

string

提供查詢範圍的 EnrollmentGroup 識別碼。

pageSize

number

每個頁面要傳回的元素數目上限。

傳回

Query

createEnrollmentGroupQuery(QuerySpecification, number)

建立可用來傳回現有註冊群組頁面的查詢。

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

參數

querySpecification

QuerySpecification

查詢規格。

pageSize

number

每個頁面要傳回的元素數目上限。

傳回

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

建立可用來傳回現有註冊頁面的查詢。

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

參數

querySpecification

QuerySpecification

查詢規格。

pageSize

number

每個頁面要傳回的元素數目上限。

傳回

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup) 

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

參數

enrollmentGroup

EnrollmentGroup

傳回

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

建立或更新裝置註冊群組。

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

參數

enrollmentGroup

EnrollmentGroup

裝置註冊群組。

callback

HttpResponseCallback<EnrollmentGroup>

作業完成時叫用。

createOrUpdateIndividualEnrollment(IndividualEnrollment) 

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

參數

enrollment

IndividualEnrollment

傳回

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

建立或更新裝置註冊記錄。

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

參數

enrollment

IndividualEnrollment

裝置註冊記錄。

callback

HttpResponseCallback<IndividualEnrollment>

作業完成時叫用。

deleteDeviceRegistrationState(string | DeviceRegistrationState) 

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

參數

idOrRegistrationState

string | DeviceRegistrationState

傳回

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback) 

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

參數

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string) 

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

參數

idOrRegistrationState

string | DeviceRegistrationState

etag

string

傳回

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

刪除裝置註冊狀態。

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

參數

idOrRegistrationState

string | DeviceRegistrationState

包含註冊識別碼或實際 DeviceRegistrationState 的字串。

etag

string

deleteCallback

ErrorCallback

作業完成時叫用。

deleteEnrollmentGroup(string | EnrollmentGroup) 

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

參數

enrollmentGroupOrId

string | EnrollmentGroup

傳回

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback) 

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

參數

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string) 

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

參數

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

傳回

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

刪除裝置註冊群組。

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

參數

enrollmentGroupOrId

string | EnrollmentGroup

EnrollmentGroup 物件或包含註冊群組識別碼的字串。

etag

string

deleteCallback

ErrorCallback

作業完成時叫用。

deleteIndividualEnrollment(string | IndividualEnrollment) 

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

參數

enrollmentOrId

string | IndividualEnrollment

傳回

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback) 

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

參數

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string) 

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

參數

enrollmentOrId

string | IndividualEnrollment

etag

string

傳回

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

刪除裝置註冊記錄。

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

參數

enrollmentOrId

string | IndividualEnrollment

IndividualEnrollment 物件或包含註冊識別碼的字串。

etag

string

deleteCallback

ErrorCallback

作業完成時叫用。

fromConnectionString(string)

使用預設傳輸 (Http) ，從指定的連接字串建構 ProvisioningServiceClient 物件。

static function fromConnectionString(value: string): ProvisioningServiceClient

參數

value

string

連接字串，封裝適當的 (讀取和/或寫入) ProvisioningServiceClient 許可權。

傳回

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

使用預設傳輸 (Http) ，從指定的 Azure TokenCredential 建構 ProvisioningServiceClient 物件。

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

參數

hostName

string

Azure 服務的主機名稱。

tokenCredential
TokenCredential

用來向 Azure 服務進行驗證的 Azure TokenCredential

傳回

ProvisioningServiceClient

getDeviceRegistrationState(string) 

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

參數

id

string

傳回

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

取得裝置註冊狀態。

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

參數

id

string

註冊識別碼。

callback

HttpResponseCallback<DeviceRegistrationState>

作業完成時叫用。

getEnrollmentGroup(string) 

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

參數

id

string

傳回

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

取得裝置註冊群組。

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

參數

id

string

IndividualEnrollment 群組識別碼。

getCallback

HttpResponseCallback<EnrollmentGroup>

作業完成時叫用。

getEnrollmentGroupAttestationMechanism(string) 

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

參數

enrollmentGroupId

string

傳回

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

取得 EnrollmentGroup 記錄的證明機制。

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

參數

enrollmentGroupId

string

EnrollmentGroup 的唯一識別碼。

callback

HttpResponseCallback<AttestationMechanism>

要求完成時呼叫的函式，發生錯誤或 AttestationMechanism 物件。

getIndividualEnrollment(string) 

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

參數

id

string

傳回

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

取得裝置註冊記錄。

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

參數

id

string

註冊識別碼。

getCallback

HttpResponseCallback<IndividualEnrollment>

作業完成時叫用。

getIndividualEnrollmentAttestationMechanism(string) 

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

參數

enrollmentId

string

傳回

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

取得 IndividualEnrollment 記錄的證明機制。

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

參數

enrollmentId

string

註冊的唯一識別碼。

callback

HttpResponseCallback<AttestationMechanism>

要求完成時呼叫的函式，發生錯誤或 AttestationMechanism 物件。

runBulkEnrollmentOperation(BulkEnrollmentOperation) 

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

參數

bulkEnrollmentOperation

BulkEnrollmentOperation

傳回

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

在註冊記錄陣列上執行數位 CRUD 作業。

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

參數

bulkEnrollmentOperation

BulkEnrollmentOperation

物件，指定在屬於物件一部分之 IndividualEnrollment 物件的陣列上，單一類型的 CRUD 作業。

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

作業完成時叫用。