ProvisioningServiceClient class
Konstruktory
Provisioning |
Metody
Szczegóły konstruktora
ProvisioningServiceClient(TransportConfig, RestApiClient)
new ProvisioningServiceClient(config: TransportConfig, restApiClient?: RestApiClient)
Parametry
- config
-
TransportConfig
- restApiClient
-
RestApiClient
Szczegóły metody
createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)
Tworzy zapytanie, które może służyć do zwracania dla określonej grupy EnrollmentGroup stron istniejącego stanu rejestracji urządzenia.
function createEnrollmentGroupDeviceRegistrationStateQuery(querySpecification: QuerySpecification, enrollmentGroupId: string, pageSize?: number): Query
Parametry
- querySpecification
-
QuerySpecification
Specyfikacja zapytania.
- enrollmentGroupId
-
string
Identyfikator EnrollmentGroup, który zawiera zakres zapytania.
- pageSize
-
number
Maksymalna liczba elementów do zwrócenia na stronę.
Zwraca
Query
createEnrollmentGroupQuery(QuerySpecification, number)
Tworzy zapytanie, które może służyć do zwracania stron istniejących grup rejestracji.
function createEnrollmentGroupQuery(querySpecification: QuerySpecification, pageSize?: number): Query
Parametry
- querySpecification
-
QuerySpecification
Specyfikacja zapytania.
- pageSize
-
number
Maksymalna liczba elementów do zwrócenia na stronę.
Zwraca
Query
createIndividualEnrollmentQuery(QuerySpecification, number)
Tworzy zapytanie, które może służyć do zwracania stron istniejących rejestracji.
function createIndividualEnrollmentQuery(querySpecification: QuerySpecification, pageSize?: number): Query
Parametry
- querySpecification
-
QuerySpecification
Specyfikacja zapytania.
- pageSize
-
number
Maksymalna liczba elementów do zwrócenia na stronę.
Zwraca
Query
createOrUpdateEnrollmentGroup(EnrollmentGroup)
function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup): Promise<ResultWithHttpResponse<EnrollmentGroup>>
Parametry
- enrollmentGroup
-
EnrollmentGroup
Zwraca
Promise<ResultWithHttpResponse<EnrollmentGroup>>
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)
Utwórz lub zaktualizuj grupę rejestracji urządzeń.
function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup, callback?: HttpResponseCallback<EnrollmentGroup>)
Parametry
- enrollmentGroup
-
EnrollmentGroup
Grupa rejestracji urządzeń.
- callback
-
HttpResponseCallback<EnrollmentGroup>
Wywoływane po zakończeniu operacji.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment): Promise<ResultWithHttpResponse<IndividualEnrollment>>
Parametry
- enrollment
-
IndividualEnrollment
Zwraca
Promise<ResultWithHttpResponse<IndividualEnrollment>>
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)
Tworzenie lub aktualizowanie rekordu rejestracji urządzeń.
function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment, callback?: HttpResponseCallback<IndividualEnrollment>)
Parametry
- enrollment
-
IndividualEnrollment
Rekord rejestracji urządzenia.
- callback
-
HttpResponseCallback<IndividualEnrollment>
Wywoływane po zakończeniu operacji.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState): Promise<void>
Parametry
- idOrRegistrationState
-
string | DeviceRegistrationState
Zwraca
Promise<void>
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, deleteCallback: ErrorCallback)
Parametry
- idOrRegistrationState
-
string | DeviceRegistrationState
- deleteCallback
-
ErrorCallback
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string): Promise<void>
Parametry
- idOrRegistrationState
-
string | DeviceRegistrationState
- etag
-
string
Zwraca
Promise<void>
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)
Usuń stan rejestracji urządzenia.
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string, deleteCallback?: ErrorCallback)
Parametry
- idOrRegistrationState
-
string | DeviceRegistrationState
Ciąg zawierający identyfikator rejestracji LUB rzeczywisty element DeviceRegistrationState.
- etag
-
string
- deleteCallback
-
ErrorCallback
Wywoływane po zakończeniu operacji.
deleteEnrollmentGroup(string | EnrollmentGroup)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup): Promise<void>
Parametry
- enrollmentGroupOrId
-
string | EnrollmentGroup
Zwraca
Promise<void>
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, deleteCallback: ErrorCallback)
Parametry
- enrollmentGroupOrId
-
string | EnrollmentGroup
- deleteCallback
-
ErrorCallback
deleteEnrollmentGroup(string | EnrollmentGroup, string)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string): Promise<void>
Parametry
- enrollmentGroupOrId
-
string | EnrollmentGroup
- etag
-
string
Zwraca
Promise<void>
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)
Usuń grupę rejestracji urządzeń.
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string, deleteCallback?: ErrorCallback)
Parametry
- enrollmentGroupOrId
-
string | EnrollmentGroup
Obiekt EnrollmentGroup lub ciąg zawierający identyfikator grupy rejestracji.
- etag
-
string
- deleteCallback
-
ErrorCallback
Wywoływane po zakończeniu operacji.
deleteIndividualEnrollment(string | IndividualEnrollment)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment): Promise<void>
Parametry
- enrollmentOrId
-
string | IndividualEnrollment
Zwraca
Promise<void>
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, deleteCallback: ErrorCallback)
Parametry
- enrollmentOrId
-
string | IndividualEnrollment
- deleteCallback
-
ErrorCallback
deleteIndividualEnrollment(string | IndividualEnrollment, string)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string): Promise<void>
Parametry
- enrollmentOrId
-
string | IndividualEnrollment
- etag
-
string
Zwraca
Promise<void>
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)
Usuwanie rekordu rejestracji urządzenia.
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string, deleteCallback?: ErrorCallback)
Parametry
- enrollmentOrId
-
string | IndividualEnrollment
Obiekt IndividualEnrollment lub ciąg zawierający identyfikator rejestracji.
- etag
-
string
- deleteCallback
-
ErrorCallback
Wywoływane po zakończeniu operacji.
fromConnectionString(string)
Tworzy obiekt ProvisioningServiceClient z podanych parametrów połączenia przy użyciu domyślnego transportu (Http).
static function fromConnectionString(value: string): ProvisioningServiceClient
Parametry
- value
-
string
Parametry połączenia, które hermetyzują odpowiednie (odczyt i/lub zapis) uprawnienia ProvisioningServiceClient.
Zwraca
fromTokenCredential(string, TokenCredential)
Tworzy obiekt ProvisioningServiceClient z danego obiektu Azure TokenCredential przy użyciu transportu domyślnego (Http).
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): ProvisioningServiceClient
Parametry
- hostName
-
string
Nazwa hosta usługi platformy Azure.
- tokenCredential
- TokenCredential
Element Azure TokenCredential używany do uwierzytelniania w usłudze platformy Azure
Zwraca
getDeviceRegistrationState(string)
function getDeviceRegistrationState(id: string): Promise<ResultWithHttpResponse<DeviceRegistrationState>>
Parametry
- id
-
string
Zwraca
Promise<ResultWithHttpResponse<DeviceRegistrationState>>
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)
Pobiera stan rejestracji urządzenia.
function getDeviceRegistrationState(id: string, callback?: HttpResponseCallback<DeviceRegistrationState>)
Parametry
- id
-
string
Identyfikator rejestracji.
- callback
-
HttpResponseCallback<DeviceRegistrationState>
Wywoływane po zakończeniu operacji.
getEnrollmentGroup(string)
function getEnrollmentGroup(id: string): Promise<ResultWithHttpResponse<EnrollmentGroup>>
Parametry
- id
-
string
Zwraca
Promise<ResultWithHttpResponse<EnrollmentGroup>>
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)
Pobierz grupę rejestracji urządzeń.
function getEnrollmentGroup(id: string, getCallback?: HttpResponseCallback<EnrollmentGroup>)
Parametry
- id
-
string
IndividualEnrollment group ID (Identyfikator grupy indywidualnej rejestracji).
- getCallback
-
HttpResponseCallback<EnrollmentGroup>
Wywoływane po zakończeniu operacji.
getEnrollmentGroupAttestationMechanism(string)
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>
Parametry
- enrollmentGroupId
-
string
Zwraca
Promise<ResultWithHttpResponse<AttestationMechanism>>
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)
Pobiera mechanizm zaświadczania dla rekordu EnrollmentGroup.
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string, callback: HttpResponseCallback<AttestationMechanism>)
Parametry
- enrollmentGroupId
-
string
Unikatowy identyfikator grupy EnrollmentGroup.
- callback
-
HttpResponseCallback<AttestationMechanism>
Funkcja wywoływana po zakończeniu żądania z błędem lub obiektem AttestationMechanism.
getIndividualEnrollment(string)
function getIndividualEnrollment(id: string): Promise<ResultWithHttpResponse<IndividualEnrollment>>
Parametry
- id
-
string
Zwraca
Promise<ResultWithHttpResponse<IndividualEnrollment>>
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)
Pobieranie rekordu rejestracji urządzenia.
function getIndividualEnrollment(id: string, getCallback?: HttpResponseCallback<IndividualEnrollment>)
Parametry
- id
-
string
Identyfikator rejestracji.
- getCallback
-
HttpResponseCallback<IndividualEnrollment>
Wywoływane po zakończeniu operacji.
getIndividualEnrollmentAttestationMechanism(string)
function getIndividualEnrollmentAttestationMechanism(enrollmentId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>
Parametry
- enrollmentId
-
string
Zwraca
Promise<ResultWithHttpResponse<AttestationMechanism>>
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)
Pobiera mechanizm zaświadczania dla rekordu IndividualEnrollment.
function getIndividualEnrollmentAttestationMechanism(enrollmentId: string, callback: HttpResponseCallback<AttestationMechanism>)
Parametry
- enrollmentId
-
string
Unikatowy identyfikator rejestracji.
- callback
-
HttpResponseCallback<AttestationMechanism>
Funkcja wywoływana po zakończeniu żądania z błędem lub obiektem AttestationMechanism.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation): Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
Parametry
- bulkEnrollmentOperation
-
BulkEnrollmentOperation
Zwraca
Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)
Uruchamia szereg operacji CRUD na tablicy rekordów rejestracji.
function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation, callback: HttpResponseCallback<BulkEnrollmentOperationResult>)
Parametry
- bulkEnrollmentOperation
-
BulkEnrollmentOperation
Obiekt, który określa pojedynczy rodzaj operacji CRUD na tablicy obiektów IndividualEnrollment, które są również częścią obiektu.
- callback
-
HttpResponseCallback<BulkEnrollmentOperationResult>
Wywoływane po zakończeniu operacji.