ProvisioningServiceClient class
Methoden
Details zum Konstruktor
ProvisioningServiceClient(TransportConfig, RestApiClient)
new ProvisioningServiceClient(config: TransportConfig, restApiClient?: RestApiClient)
Parameter
- config
-
TransportConfig
- restApiClient
-
RestApiClient
Details zur Methode
createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification, string, number)
Erstellt eine Abfrage, die verwendet werden kann, um seiten des vorhandenen Geräteregistrierungsstatus für eine bestimmte EnrollmentGroup zurückzugeben.
function createEnrollmentGroupDeviceRegistrationStateQuery(querySpecification: QuerySpecification, enrollmentGroupId: string, pageSize?: number): Query
Parameter
- querySpecification
-
QuerySpecification
Die Abfragespezifikation.
- enrollmentGroupId
-
string
Die EnrollmentGroup-ID, die den Bereich für die Abfrage bereitstellt.
- pageSize
-
number
Die maximale Anzahl von Elementen, die pro Seite zurückgegeben werden sollen.
Gibt zurück
Query
createEnrollmentGroupQuery(QuerySpecification, number)
Erstellt eine Abfrage, mit der Seiten vorhandener Registrierungsgruppen zurückgegeben werden können.
function createEnrollmentGroupQuery(querySpecification: QuerySpecification, pageSize?: number): Query
Parameter
- querySpecification
-
QuerySpecification
Die Abfragespezifikation.
- pageSize
-
number
Die maximale Anzahl von Elementen, die pro Seite zurückgegeben werden sollen.
Gibt zurück
Query
createIndividualEnrollmentQuery(QuerySpecification, number)
Erstellt eine Abfrage, die verwendet werden kann, um Seiten vorhandener Registrierungen zurückzugeben.
function createIndividualEnrollmentQuery(querySpecification: QuerySpecification, pageSize?: number): Query
Parameter
- querySpecification
-
QuerySpecification
Die Abfragespezifikation.
- pageSize
-
number
Die maximale Anzahl von Elementen, die pro Seite zurückgegeben werden sollen.
Gibt zurück
Query
createOrUpdateEnrollmentGroup(EnrollmentGroup)
function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup): Promise<ResultWithHttpResponse<EnrollmentGroup>>
Parameter
- enrollmentGroup
-
EnrollmentGroup
Gibt zurück
Promise<ResultWithHttpResponse<EnrollmentGroup>>
createOrUpdateEnrollmentGroup(EnrollmentGroup, HttpResponseCallback<EnrollmentGroup>)
Erstellen oder Aktualisieren einer Geräteregistrierungsgruppe.
function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup, callback?: HttpResponseCallback<EnrollmentGroup>)
Parameter
- enrollmentGroup
-
EnrollmentGroup
Die Geräteregistrierungsgruppe.
- callback
-
HttpResponseCallback<EnrollmentGroup>
Wird nach Abschluss des Vorgangs aufgerufen.
createOrUpdateIndividualEnrollment(IndividualEnrollment)
function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment): Promise<ResultWithHttpResponse<IndividualEnrollment>>
Parameter
- enrollment
-
IndividualEnrollment
Gibt zurück
Promise<ResultWithHttpResponse<IndividualEnrollment>>
createOrUpdateIndividualEnrollment(IndividualEnrollment, HttpResponseCallback<IndividualEnrollment>)
Dient zum Erstellen oder Aktualisieren eines Geräteregistrierungsdatensatzes.
function createOrUpdateIndividualEnrollment(enrollment: IndividualEnrollment, callback?: HttpResponseCallback<IndividualEnrollment>)
Parameter
- enrollment
-
IndividualEnrollment
Der Geräteregistrierungseintrag.
- callback
-
HttpResponseCallback<IndividualEnrollment>
Wird nach Abschluss des Vorgangs aufgerufen.
deleteDeviceRegistrationState(string | DeviceRegistrationState)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState): Promise<void>
Parameter
- idOrRegistrationState
-
string | DeviceRegistrationState
Gibt zurück
Promise<void>
deleteDeviceRegistrationState(string | DeviceRegistrationState, ErrorCallback)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, deleteCallback: ErrorCallback)
Parameter
- idOrRegistrationState
-
string | DeviceRegistrationState
- deleteCallback
-
ErrorCallback
deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string): Promise<void>
Parameter
- idOrRegistrationState
-
string | DeviceRegistrationState
- etag
-
string
Gibt zurück
Promise<void>
deleteDeviceRegistrationState(string | DeviceRegistrationState, string, ErrorCallback)
Löschen eines Geräteregistrierungsstatus.
function deleteDeviceRegistrationState(idOrRegistrationState: string | DeviceRegistrationState, etag: string, deleteCallback?: ErrorCallback)
Parameter
- idOrRegistrationState
-
string | DeviceRegistrationState
Eine Zeichenfolge, die die Registrierungs-ID ODER einen tatsächlichen DeviceRegistrationState enthält.
- etag
-
string
- deleteCallback
-
ErrorCallback
Wird nach Abschluss des Vorgangs aufgerufen.
deleteEnrollmentGroup(string | EnrollmentGroup)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup): Promise<void>
Parameter
- enrollmentGroupOrId
-
string | EnrollmentGroup
Gibt zurück
Promise<void>
deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, deleteCallback: ErrorCallback)
Parameter
- enrollmentGroupOrId
-
string | EnrollmentGroup
- deleteCallback
-
ErrorCallback
deleteEnrollmentGroup(string | EnrollmentGroup, string)
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string): Promise<void>
Parameter
- enrollmentGroupOrId
-
string | EnrollmentGroup
- etag
-
string
Gibt zurück
Promise<void>
deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)
Löschen einer Geräteregistrierungsgruppe.
function deleteEnrollmentGroup(enrollmentGroupOrId: string | EnrollmentGroup, etag: string, deleteCallback?: ErrorCallback)
Parameter
- enrollmentGroupOrId
-
string | EnrollmentGroup
EnrollmentGroup-Objekt oder eine Zeichenfolge, die die Registrierungsgruppen-ID enthält.
- etag
-
string
- deleteCallback
-
ErrorCallback
Wird nach Abschluss des Vorgangs aufgerufen.
deleteIndividualEnrollment(string | IndividualEnrollment)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment): Promise<void>
Parameter
- enrollmentOrId
-
string | IndividualEnrollment
Gibt zurück
Promise<void>
deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, deleteCallback: ErrorCallback)
Parameter
- enrollmentOrId
-
string | IndividualEnrollment
- deleteCallback
-
ErrorCallback
deleteIndividualEnrollment(string | IndividualEnrollment, string)
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string): Promise<void>
Parameter
- enrollmentOrId
-
string | IndividualEnrollment
- etag
-
string
Gibt zurück
Promise<void>
deleteIndividualEnrollment(string | IndividualEnrollment, string, ErrorCallback)
Löschen eines Geräteregistrierungsdatensatzes.
function deleteIndividualEnrollment(enrollmentOrId: string | IndividualEnrollment, etag: string, deleteCallback?: ErrorCallback)
Parameter
- enrollmentOrId
-
string | IndividualEnrollment
Ein IndividualEnrollment-Objekt oder eine Zeichenfolge, die die Registrierungs-ID enthält.
- etag
-
string
- deleteCallback
-
ErrorCallback
Wird nach Abschluss des Vorgangs aufgerufen.
fromConnectionString(string)
Erstellt ein ProvisioningServiceClient -Objekt aus der angegebenen Verbindungszeichenfolge mithilfe des Standardtransports (Http).
static function fromConnectionString(value: string): ProvisioningServiceClient
Parameter
- value
-
string
Eine Verbindungszeichenfolge, die die entsprechenden ProvisioningServiceClient-Berechtigungen (Lese- und/oder Schreibzugriff) kapselt.
Gibt zurück
fromTokenCredential(string, TokenCredential)
Erstellt ein ProvisioningServiceClient -Objekt aus dem angegebenen Azure TokenCredential mithilfe des Standardtransports (Http).
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): ProvisioningServiceClient
Parameter
- hostName
-
string
Hostname des Azure-Diensts.
- tokenCredential
- TokenCredential
Azure TokenCredential, die für die Authentifizierung beim Azure-Dienst verwendet werden
Gibt zurück
getDeviceRegistrationState(string)
function getDeviceRegistrationState(id: string): Promise<ResultWithHttpResponse<DeviceRegistrationState>>
Parameter
- id
-
string
Gibt zurück
Promise<ResultWithHttpResponse<DeviceRegistrationState>>
getDeviceRegistrationState(string, HttpResponseCallback<DeviceRegistrationState>)
Ruft den Geräteregistrierungsstatus ab.
function getDeviceRegistrationState(id: string, callback?: HttpResponseCallback<DeviceRegistrationState>)
Parameter
- id
-
string
Registrierungs-ID.
- callback
-
HttpResponseCallback<DeviceRegistrationState>
Wird nach Abschluss des Vorgangs aufgerufen.
getEnrollmentGroup(string)
function getEnrollmentGroup(id: string): Promise<ResultWithHttpResponse<EnrollmentGroup>>
Parameter
- id
-
string
Gibt zurück
Promise<ResultWithHttpResponse<EnrollmentGroup>>
getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)
Dient zum Abrufen einer Geräteregistrierungsgruppe.
function getEnrollmentGroup(id: string, getCallback?: HttpResponseCallback<EnrollmentGroup>)
Parameter
- id
-
string
IndividualEnrollment-Gruppen-ID.
- getCallback
-
HttpResponseCallback<EnrollmentGroup>
Wird nach Abschluss des Vorgangs aufgerufen.
getEnrollmentGroupAttestationMechanism(string)
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>
Parameter
- enrollmentGroupId
-
string
Gibt zurück
Promise<ResultWithHttpResponse<AttestationMechanism>>
getEnrollmentGroupAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)
Ruft den Nachweismechanismus für einen EnrollmentGroup-Datensatz ab.
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId: string, callback: HttpResponseCallback<AttestationMechanism>)
Parameter
- enrollmentGroupId
-
string
Eindeutiger Bezeichner der EnrollmentGroup.
- callback
-
HttpResponseCallback<AttestationMechanism>
Funktion wird aufgerufen, wenn die Anforderung abgeschlossen ist, entweder mit einem Fehler oder mit einem AttestationMechanism-Objekt.
getIndividualEnrollment(string)
function getIndividualEnrollment(id: string): Promise<ResultWithHttpResponse<IndividualEnrollment>>
Parameter
- id
-
string
Gibt zurück
Promise<ResultWithHttpResponse<IndividualEnrollment>>
getIndividualEnrollment(string, HttpResponseCallback<IndividualEnrollment>)
Abrufen eines Geräteregistrierungsdatensatzes.
function getIndividualEnrollment(id: string, getCallback?: HttpResponseCallback<IndividualEnrollment>)
Parameter
- id
-
string
Registrierungs-ID.
- getCallback
-
HttpResponseCallback<IndividualEnrollment>
Wird nach Abschluss des Vorgangs aufgerufen.
getIndividualEnrollmentAttestationMechanism(string)
function getIndividualEnrollmentAttestationMechanism(enrollmentId: string): Promise<ResultWithHttpResponse<AttestationMechanism>>
Parameter
- enrollmentId
-
string
Gibt zurück
Promise<ResultWithHttpResponse<AttestationMechanism>>
getIndividualEnrollmentAttestationMechanism(string, HttpResponseCallback<AttestationMechanism>)
Ruft den Nachweismechanismus für einen IndividualEnrollment-Datensatz ab.
function getIndividualEnrollmentAttestationMechanism(enrollmentId: string, callback: HttpResponseCallback<AttestationMechanism>)
Parameter
- enrollmentId
-
string
Eindeutiger Bezeichner der Registrierung.
- callback
-
HttpResponseCallback<AttestationMechanism>
Funktion wird aufgerufen, wenn die Anforderung abgeschlossen ist, entweder mit einem Fehler oder mit einem AttestationMechanism-Objekt.
runBulkEnrollmentOperation(BulkEnrollmentOperation)
function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation): Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
Parameter
- bulkEnrollmentOperation
-
BulkEnrollmentOperation
Gibt zurück
Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
runBulkEnrollmentOperation(BulkEnrollmentOperation, HttpResponseCallback<BulkEnrollmentOperationResult>)
Führt eine Reihe von CRUD-Vorgängen für ein Array von Registrierungsdatensätzen aus.
function runBulkEnrollmentOperation(bulkEnrollmentOperation: BulkEnrollmentOperation, callback: HttpResponseCallback<BulkEnrollmentOperationResult>)
Parameter
- bulkEnrollmentOperation
-
BulkEnrollmentOperation
Ein Objekt, das die einzelne Art von CRUD-Vorgängen im Array von IndividualEnrollment-Objekten angibt, die ebenfalls Teil des Objekts sind.
- callback
-
HttpResponseCallback<BulkEnrollmentOperationResult>
Wird nach Abschluss des Vorgangs aufgerufen.