次の方法で共有

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 ID。

pageSize

number

1 ページあたりに返される要素の最大数。

戻り値

Query

createEnrollmentGroupQuery(QuerySpecification, number)

既存の登録グループのページを返すために使用できるクエリを作成します。

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

パラメーター

querySpecification

QuerySpecification

クエリの仕様。

pageSize

number

1 ページあたりに返される要素の最大数。

戻り値

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

既存の登録のページを返すために使用できるクエリを作成します。

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

パラメーター

querySpecification

QuerySpecification

クエリの仕様。

pageSize

number

1 ページあたりに返される要素の最大数。

戻り値

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

登録 ID または実際の 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 オブジェクト、または登録グループ ID を含む文字列。

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 オブジェクトまたは登録 ID を含む文字列。

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

登録 ID。

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 グループ ID。

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

登録 ID。

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>

操作の完了時に呼び出されます。