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

쿼리에 대한 scope 제공하는 EnrollmentGroup ID입니다.

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

등록 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>

작업이 완료될 때 호출됩니다.