Partilhar via


ProvisioningServiceClient class

Construtores

ProvisioningServiceClient(TransportConfig, RestApiClient)

Métodos

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Cria uma consulta que pode ser utilizada para devolver, para um EnrollmentGroup específico, páginas do estado de registo de dispositivos existentes.

createEnrollmentGroupQuery(QuerySpecification, number)

Cria uma consulta que pode ser utilizada para devolver páginas de grupos de inscrição existentes.

createIndividualEnrollmentQuery(QuerySpecification, number)

Cria uma consulta que pode ser utilizada para devolver páginas de inscrições existentes.

createOrUpdateEnrollmentGroup(EnrollmentGroup)
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Criar ou atualizar um grupo de inscrição de dispositivos.

createOrUpdateIndividualEnrollment(IndividualEnrollment)
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Criar ou atualizar um registo de inscrição de dispositivos.

deleteDeviceRegistrationState(string | DeviceRegistrationState)
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Eliminar um estado de registo de dispositivo.

deleteEnrollmentGroup(string | EnrollmentGroup)
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
deleteEnrollmentGroup(string | EnrollmentGroup, string)
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Eliminar um grupo de inscrição de dispositivos.

deleteIndividualEnrollment(string | IndividualEnrollment)
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
deleteIndividualEnrollment(string | IndividualEnrollment, string)
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Eliminar um registo de inscrição de dispositivos.

fromConnectionString(string)

Constrói um objeto ProvisioningServiceClient a partir da cadeia de ligação fornecida com o transporte predefinido (Http).

fromTokenCredential(string, TokenCredential)

Constrói um objeto ProvisioningServiceClient a partir do Azure TokenCredential especificado com o transporte predefinido (Http).

getDeviceRegistrationState(string)
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Obtém o estado de registo do dispositivo.

getEnrollmentGroup(string)
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Obter um grupo de inscrição de dispositivos.

getEnrollmentGroupAttestationMechanism(string)
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtém o mecanismo de atestado para um registo EnrollmentGroup.

getIndividualEnrollment(string)
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Obter um registo de inscrição de dispositivos.

getIndividualEnrollmentAttestationMechanism(string)
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtém o mecanismo de atestado para um registo IndividualEnrollment.

runBulkEnrollmentOperation(BulkEnrollmentOperation)
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Executa um número de operações CRUD numa matriz de registos de inscrição.

Detalhes do Construtor

ProvisioningServiceClient(TransportConfig, RestApiClient)

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

Parâmetros

config

TransportConfig

restApiClient

RestApiClient

Detalhes de Método

createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)

Cria uma consulta que pode ser utilizada para devolver, para um EnrollmentGroup específico, páginas do estado de registo de dispositivos existentes.

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

Parâmetros

querySpecification

QuerySpecification

A especificação da consulta.

enrollmentGroupId

string

O ID enrollmentGroup que fornece o âmbito da consulta.

pageSize

number

O número máximo de elementos a devolver por página.

Devoluções

Query

createEnrollmentGroupQuery(QuerySpecification, number)

Cria uma consulta que pode ser utilizada para devolver páginas de grupos de inscrição existentes.

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

Parâmetros

querySpecification

QuerySpecification

A especificação da consulta.

pageSize

number

O número máximo de elementos a devolver por página.

Devoluções

Query

createIndividualEnrollmentQuery(QuerySpecification, number)

Cria uma consulta que pode ser utilizada para devolver páginas de inscrições existentes.

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

Parâmetros

querySpecification

QuerySpecification

A especificação da consulta.

pageSize

number

O número máximo de elementos a devolver por página.

Devoluções

Query

createOrUpdateEnrollmentGroup(EnrollmentGroup)

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

Parâmetros

enrollmentGroup

EnrollmentGroup

Devoluções

Promise<ResultWithHttpResponse<EnrollmentGroup>>

createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)

Criar ou atualizar um grupo de inscrição de dispositivos.

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

Parâmetros

enrollmentGroup

EnrollmentGroup

O grupo de inscrição de dispositivos.

callback

HttpResponseCallback<EnrollmentGroup>

Invocado após a conclusão da operação.

createOrUpdateIndividualEnrollment(IndividualEnrollment)

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

Parâmetros

enrollment

IndividualEnrollment

Devoluções

Promise<ResultWithHttpResponse<IndividualEnrollment>>

createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)

Criar ou atualizar um registo de inscrição de dispositivos.

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

Parâmetros

enrollment

IndividualEnrollment

O registo de inscrição de dispositivos.

callback

HttpResponseCallback<IndividualEnrollment>

Invocado após a conclusão da operação.

deleteDeviceRegistrationState(string | DeviceRegistrationState)

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

Devoluções

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

deleteCallback

ErrorCallback

deleteDeviceRegistrationState(string | DeviceRegistrationState, string)

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

etag

string

Devoluções

Promise<void>

deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)

Eliminar um estado de registo de dispositivo.

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

Parâmetros

idOrRegistrationState

string | DeviceRegistrationState

Uma cadeia que contém o ID de registo OU um DeviceRegistrationState real.

etag

string

deleteCallback

ErrorCallback

Invocado após a conclusão da operação.

deleteEnrollmentGroup(string | EnrollmentGroup)

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

Devoluções

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

deleteCallback

ErrorCallback

deleteEnrollmentGroup(string | EnrollmentGroup, string)

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

etag

string

Devoluções

Promise<void>

deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)

Eliminar um grupo de inscrição de dispositivos.

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

Parâmetros

enrollmentGroupOrId

string | EnrollmentGroup

Objeto EnrollmentGroup ou uma cadeia que contém o ID do Grupo de inscrição.

etag

string

deleteCallback

ErrorCallback

Invocado após a conclusão da operação.

deleteIndividualEnrollment(string | IndividualEnrollment)

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

Devoluções

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

deleteCallback

ErrorCallback

deleteIndividualEnrollment(string | IndividualEnrollment, string)

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

etag

string

Devoluções

Promise<void>

deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)

Eliminar um registo de inscrição de dispositivos.

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

Parâmetros

enrollmentOrId

string | IndividualEnrollment

Um objeto IndividualEnrollment ou uma cadeia que contenha o ID de registo.

etag

string

deleteCallback

ErrorCallback

Invocado após a conclusão da operação.

fromConnectionString(string)

Constrói um objeto ProvisioningServiceClient a partir da cadeia de ligação fornecida com o transporte predefinido (Http).

static function fromConnectionString(value: string): ProvisioningServiceClient

Parâmetros

value

string

Uma cadeia de ligação que encapsula as permissões adequadas (leitura e/ou escrita) ProvisioningServiceClient.

Devoluções

fromTokenCredential(string, TokenCredential)

Constrói um objeto ProvisioningServiceClient a partir do Azure TokenCredential especificado com o transporte predefinido (Http).

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

Parâmetros

hostName

string

Nome do anfitrião do serviço do Azure.

tokenCredential
TokenCredential

Um TokenCredential do Azure utilizado para autenticar com o serviço do Azure

Devoluções

getDeviceRegistrationState(string)

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

Parâmetros

id

string

Devoluções

Promise<ResultWithHttpResponse<DeviceRegistrationState>>

getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)

Obtém o estado de registo do dispositivo.

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

Parâmetros

id

string

ID de registo.

callback

HttpResponseCallback<DeviceRegistrationState>

Invocado após a conclusão da operação.

getEnrollmentGroup(string)

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

Parâmetros

id

string

Devoluções

Promise<ResultWithHttpResponse<EnrollmentGroup>>

getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)

Obter um grupo de inscrição de dispositivos.

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

Parâmetros

id

string

ID do grupo IndividualEnrollment.

getCallback

HttpResponseCallback<EnrollmentGroup>

Invocado após a conclusão da operação.

getEnrollmentGroupAttestationMechanism(string)

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

Parâmetros

enrollmentGroupId

string

Devoluções

Promise<ResultWithHttpResponse<AttestationMechanism>>

getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtém o mecanismo de atestado para um registo EnrollmentGroup.

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

Parâmetros

enrollmentGroupId

string

Identificador exclusivo do EnrollmentGroup.

callback

HttpResponseCallback<AttestationMechanism>

Função chamada quando o pedido é concluído, com um erro ou com um objeto AttestationMechanism.

getIndividualEnrollment(string)

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

Parâmetros

id

string

Devoluções

Promise<ResultWithHttpResponse<IndividualEnrollment>>

getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)

Obter um registo de inscrição de dispositivos.

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

Parâmetros

id

string

ID de registo.

getCallback

HttpResponseCallback<IndividualEnrollment>

Invocado após a conclusão da operação.

getIndividualEnrollmentAttestationMechanism(string)

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

Parâmetros

enrollmentId

string

Devoluções

Promise<ResultWithHttpResponse<AttestationMechanism>>

getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)

Obtém o mecanismo de atestado para um registo IndividualEnrollment.

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

Parâmetros

enrollmentId

string

Identificador exclusivo da inscrição.

callback

HttpResponseCallback<AttestationMechanism>

Função chamada quando o pedido é concluído, com um erro ou com um objeto AttestationMechanism.

runBulkEnrollmentOperation(BulkEnrollmentOperation)

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

Parâmetros

bulkEnrollmentOperation

BulkEnrollmentOperation

Devoluções

Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>

runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)

Executa um número de operações CRUD numa matriz de registos de inscrição.

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

Parâmetros

bulkEnrollmentOperation

BulkEnrollmentOperation

Um objeto que especifica o tipo único de operações CRUD na matriz de objetos IndividualEnrollment que também fazem parte do objeto.

callback

HttpResponseCallback<BulkEnrollmentOperationResult>

Invocado após a conclusão da operação.