ProvisioningServiceClient class

Paket:

azure-iot-provisioning-service

Oluşturucular

ProvisioningServiceClient(TransportConfig, RestApiClient)

Yöntemler

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)	Belirli bir EnrollmentGroup için mevcut cihaz kayıt durumunun sayfalarını döndürmek için kullanılabilecek bir sorgu oluşturur.
createEnrollmentGroupQuery(QuerySpecification, number)	Mevcut kayıt gruplarının sayfalarını döndürmek için kullanılabilecek bir sorgu oluşturur.
createIndividualEnrollmentQuery(QuerySpecification, number)	Mevcut kayıtların sayfalarını döndürmek için kullanılabilecek bir sorgu oluşturur.
createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)	Cihaz kayıt grubu oluşturun veya güncelleştirin.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)	Cihaz kayıt kaydı oluşturun veya güncelleştirin.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)	Cihaz kayıt durumunu silin.
deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)	Cihaz kayıt grubunu silin.
deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)	Cihaz kayıt kaydını silme.
fromConnectionString(string)	Varsayılan aktarım (Http) kullanarak verilen bağlantı dizesinden bir ProvisioningServiceClient nesnesi oluşturur.
fromTokenCredential(string, TokenCredential)	Varsayılan aktarım (Http) kullanarak verilen Azure TokenCredential öğesinden bir ProvisioningServiceClient nesnesi oluşturur.
getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)	Cihaz kayıt durumunu alır.
getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)	Bir cihaz kayıt grubu alın.
getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Bir EnrollmentGroup kaydı için kanıtlama mekanizmasını alır.
getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)	Cihaz kayıt kaydı alın.
getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)	Bir IndividualEnrollment kaydı için kanıtlama mekanizmasını alır.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)	Kayıt kayıtları dizisinde bir dizi CRUD işlemi çalıştırır.

Oluşturucu Ayrıntıları

ProvisioningServiceClient(TransportConfig, RestApiClient)

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

Parametreler

config

TransportConfig

restApiClient

RestApiClient

Yöntem Ayrıntıları

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Belirli bir EnrollmentGroup için mevcut cihaz kayıt durumunun sayfalarını döndürmek için kullanılabilecek bir sorgu oluşturur.

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

Parametreler

querySpecification

QuerySpecification

Sorgu belirtimi.

enrollmentGroupId

string

Sorgunun kapsamını sağlayan EnrollmentGroup kimliği.

pageSize

number

Sayfa başına döndürülecek en fazla öğe sayısı.

Döndürülenler

Query

createEnrollmentGroupQuery(QuerySpecification, number)

Mevcut kayıt gruplarının sayfalarını döndürmek için kullanılabilecek bir sorgu oluşturur.

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

Parametreler

querySpecification

QuerySpecification

Sorgu belirtimi.

pageSize

number

Sayfa başına döndürülecek en fazla öğe sayısı.

Döndürülenler

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

Mevcut kayıtların sayfalarını döndürmek için kullanılabilecek bir sorgu oluşturur.

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

Parametreler

querySpecification

QuerySpecification

Sorgu belirtimi.

pageSize

number

Sayfa başına döndürülecek en fazla öğe sayısı.

Döndürülenler

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup)

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

Parametreler

enrollmentGroup

EnrollmentGroup

Döndürülenler

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Cihaz kayıt grubu oluşturun veya güncelleştirin.

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

Parametreler

enrollmentGroup

EnrollmentGroup

Cihaz kayıt grubu.

callback

HttpResponseCallback<EnrollmentGroup>

İşlem tamamlandıktan sonra çağrılır.

createOrUpdateIndividualEnrollment(IndividualEnrollment)

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

Parametreler

enrollment

IndividualEnrollment

Döndürülenler

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Cihaz kayıt kaydı oluşturun veya güncelleştirin.

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

Parametreler

enrollment

IndividualEnrollment

Cihaz kayıt kaydı.

callback

HttpResponseCallback<IndividualEnrollment>

İşlem tamamlandıktan sonra çağrılır.

deleteDeviceRegistrationState(string | DeviceRegistrationState)

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

Parametreler

idOrRegistrationState

string | DeviceRegistrationState

Döndürülenler

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)

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

Parametreler

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string)

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

Parametreler

idOrRegistrationState

string | DeviceRegistrationState

etag

string

Döndürülenler

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Cihaz kayıt durumunu silin.

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

Parametreler

idOrRegistrationState

string | DeviceRegistrationState

Kayıt kimliğini veya gerçek deviceRegistrationState değerini içeren bir dize.

etag

string

deleteCallback

ErrorCallback

İşlem tamamlandıktan sonra çağrılır.

deleteEnrollmentGroup(string | EnrollmentGroup)

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

Parametreler

enrollmentGroupOrId

string | EnrollmentGroup

Döndürülenler

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)

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

Parametreler

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string)

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

Parametreler

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

Döndürülenler

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Cihaz kayıt grubunu silin.

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

Parametreler

enrollmentGroupOrId

string | EnrollmentGroup

EnrollmentGroup nesnesi veya kayıt Grubu Kimliğini içeren bir dize.

etag

string

deleteCallback

ErrorCallback

İşlem tamamlandıktan sonra çağrılır.

deleteIndividualEnrollment(string | IndividualEnrollment)

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

Parametreler

enrollmentOrId

string | IndividualEnrollment

Döndürülenler

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)

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

Parametreler

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string)

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

Parametreler

enrollmentOrId

string | IndividualEnrollment

etag

string

Döndürülenler

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Cihaz kayıt kaydını silme.

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

Parametreler

enrollmentOrId

string | IndividualEnrollment

Bir IndividualEnrollment nesnesi veya kayıt kimliğini içeren bir dize.

etag

string

deleteCallback

ErrorCallback

İşlem tamamlandıktan sonra çağrılır.

fromConnectionString(string)

Varsayılan aktarım (Http) kullanarak verilen bağlantı dizesinden bir ProvisioningServiceClient nesnesi oluşturur.

static function fromConnectionString(value: string): ProvisioningServiceClient

Parametreler

value

string

Uygun (okuma ve/veya yazma) ProvisioningServiceClient izinlerini kapsülleyen bir bağlantı dizesi.

Döndürülenler

ProvisioningServiceClient

fromTokenCredential(string, TokenCredential)

Varsayılan aktarım (Http) kullanarak verilen Azure TokenCredential öğesinden bir ProvisioningServiceClient nesnesi oluşturur.

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

Parametreler

hostName

string

Azure hizmetinin ana bilgisayar adı.

tokenCredential

TokenCredential

Azure hizmetiyle kimlik doğrulaması yapmak için kullanılan bir Azure TokenCredential

Döndürülenler

ProvisioningServiceClient

getDeviceRegistrationState(string)

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

Parametreler

id

string

Döndürülenler

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Cihaz kayıt durumunu alır.

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

Parametreler

id

string

Kayıt Kimliği.

callback

HttpResponseCallback<DeviceRegistrationState>

İşlem tamamlandıktan sonra çağrılır.

getEnrollmentGroup(string)

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

Parametreler

id

string

Döndürülenler

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Bir cihaz kayıt grubu alın.

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

Parametreler

id

string

BireyselKayıt grubu kimliği.

getCallback

HttpResponseCallback<EnrollmentGroup>

İşlem tamamlandıktan sonra çağrılır.

getEnrollmentGroupAttestationMechanism(string)

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

Parametreler

enrollmentGroupId

string

Döndürülenler

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Bir EnrollmentGroup kaydı için kanıtlama mekanizmasını alır.

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

Parametreler

enrollmentGroupId

string

EnrollmentGroup'un benzersiz tanımlayıcısı.

callback

HttpResponseCallback<AttestationMechanism>

İstek tamamlandığında bir hatayla veya AttestationMechanism nesnesiyle çağrılan işlev.

getIndividualEnrollment(string)

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

Parametreler

id

string

Döndürülenler

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Cihaz kayıt kaydı alın.

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

Parametreler

id

string

Kayıt Kimliği.

getCallback

HttpResponseCallback<IndividualEnrollment>

İşlem tamamlandıktan sonra çağrılır.

getIndividualEnrollmentAttestationMechanism(string)

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

Parametreler

enrollmentId

string

Döndürülenler

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Bir IndividualEnrollment kaydı için kanıtlama mekanizmasını alır.

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

Parametreler

enrollmentId

string

Kaydın benzersiz tanımlayıcısı.

callback

HttpResponseCallback<AttestationMechanism>

İstek tamamlandığında bir hatayla veya AttestationMechanism nesnesiyle çağrılan işlev.

runBulkEnrollmentOperation(BulkEnrollmentOperation)

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

Parametreler

bulkEnrollmentOperation

BulkEnrollmentOperation

Döndürülenler

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Kayıt kayıtları dizisinde bir dizi CRUD işlemi çalıştırır.

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

Parametreler

bulkEnrollmentOperation

BulkEnrollmentOperation

Aynı zamanda nesnenin parçası olan IndividualEnrollment nesnelerinin dizisinde tek tür CRUD işlemlerini belirten bir nesne.

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

İşlem tamamlandıktan sonra çağrılır.