Riferimento API REST di base del Portale di dispositivi di Windows

Articolo
10/05/2023

Tutte le funzionalità del Portale di dispositivi di Windows sono basate su API REST che gli sviluppatori possono chiamare direttamente per accedere alle risorse e controllare i dispositivi a livello di codice.

Distribuzione dell'app

Installare un'app

Richiesta

Puoi installare un'app usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/app/packagemanager/package

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
pacchetto	(Obbligatorio) Nome file del pacchetto da installare.

Intestazioni delle richieste

Nessuno

Testo della richiesta

File con estensione appx o appxbundle, nonché eventuali dipendenze richieste dall'app.
Certificato usato per firmare l'app, se il dispositivo è di tipo IoT o Windows Desktop. Altre piattaforme non richiedono il certificato.

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	Distribuire richieste accettate e in fase di elaborazione
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Nota

Windows Mixed Reality viene eseguito sul desktop normale, quindi è lo stesso portale di Desktop.

Richiesta

Puoi installare un set correlato usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/app/packagemanager/package

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
pacchetto	(Obbligatorio) Nomi file dei pacchetti da installare.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Aggiungi ".opt" ai nomi file dei pacchetti facoltativi che specifichi come parametro, ad esempio "foo.appx.opt" o "bar.appxbundle.opt".
File con estensione appx o appxbundle, nonché eventuali dipendenze richieste dall'app.
Certificato usato per firmare l'app, se il dispositivo è di tipo IoT o Windows Desktop. Altre piattaforme non richiedono il certificato.

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	Distribuire richieste accettate e in fase di elaborazione
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Registrare un'app in una cartella separata

Richiesta

Puoi registrare un'app in una cartella separata usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/app/packagemanager/networkapp

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    }
}

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	Distribuire richieste accettate e in fase di elaborazione
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
Xbox
HoloLens
IoT

Richiesta

Puoi registrare un set correlato in cartelle separate usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/app/packagemanager/networkapp

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    },
    "optionalpackages" :
    [
        {
            "networkshare" : "\\some\share\path2",
            "username" : "optional_username2",
            "password" : "optional_password2"
        },
        ...
    ]
}

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	Distribuire richieste accettate e in fase di elaborazione
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
Xbox
HoloLens
IoT

Ottenere lo stato dell'installazione di un'app

Richiesta

Puoi ottenere lo stato dell'installazione di un'app attualmente in corso usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/app/packagemanager/state

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	Il risultato dell'ultima distribuzione
204	L'installazione è in esecuzione
404	Nessuna azione di installazione rilevata

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Disinstallare un'app

Richiesta

Puoi disinstallare un'app usando il formato di richiesta seguente.

Metodo	URI della richiesta
DELETE	/api/app/packagemanager/package

Parametri URI

Parametro URI	Descrizione
pacchetto	(Obbligatorio) Valore di PackageFullName (da GET /api/app/packagemanager/packages) dell'app di destinazione

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Ottenere app installate

Richiesta

È possibile ottenere l'elenco delle app installate nel sistema usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/app/packagemanager/packages

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include un elenco di pacchetti installati con i dettagli associati. Il modello per la risposta è il seguente.

{"InstalledPackages": [
    {
        "Name": string,
        "PackageFamilyName": string,
        "PackageFullName": string,
        "PackageOrigin": int, (https://msdn.microsoft.com/library/windows/desktop/dn313167(v=vs.85).aspx)
        "PackageRelativeId": string,
        "Publisher": string,
        "Version": {
            "Build": int,
            "Major": int,
            "Minor": int,
            "Revision": int
     },
     "RegisteredUsers": [
     {
        "UserDisplayName": string,
        "UserSID": string
     },...
     ]
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Bluetooth

Ottenere le radio Bluetooth nel computer

Richiesta

Puoi ottenere l'elenco delle radio Bluetooth installate nel sistema usando il formato di richiesta seguente. Può anche avvenire l'aggiornamento a una connessione WebSocket, con gli stessi dati JSON.

Metodo	URI della richiesta
GET	/api/bt/getradios
GET/WebSocket	/api/bt/getradios

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include una matrice JSON delle radio Bluetooth associate al dispositivo.

{"BluetoothRadios" : [
    {
        "BluetoothAddress" : int64,
        "DisplayName" : string,
        "HasUnknownUsbDevice" : boolean,
        "HasProblem" : boolean,
        "ID" : string,
        "ProblemCode" : int,
        "State" : string
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Attivare o disattivare la radio Bluetooth

Richiesta

Attiva o disattiva una radio Bluetooth specifica.

Metodo	URI della richiesta
POST	/api/bt/setradio

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
ID	(Obbligatorio) ID dispositivo per la radio Bluetooth e deve essere codificato in base 64.
Provincia	(obbligatorio) Può essere `"On"` o `"Off"`.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Ottenere un elenco di dispositivi Bluetooth accoppiati

Richiesta

Puoi ottenere un elenco dei dispositivi Bluetooth attualmente accoppiati usando il formato di richiesta seguente. Questo può essere aggiornato a una connessione WebSocket con gli stessi dati JSON. Per tutta la durata della connessione WebSocket, l'elenco dei dispositivi può cambiare. Un elenco completo di dispositivi verrà inviato tramite la connessione WebSocket ogni volta che viene effettuato un aggiornamento.

Metodo	URI della richiesta
GET	/api/bt/getpaired
GET/WebSocket	/api/bt/getpaired

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include una matrice JSON di dispositivi Bluetooth attualmente accoppiati.

{"PairedDevices": [
    {
        "Name" : string,
        "ID" : string,
        "AudioConnectionStatus" : string
    },...
]}

Il campo AudioConnectionStatus sarà presente se il dispositivo può essere usato per l'audio in questo sistema (criteri e componenti facoltativi potrebbero avere un influsso). AudioConnectionStatus sarà "Connected" (Connesso) o "Disconnected" (Disconnesso).

Ottenere un elenco di dispositivi Bluetooth disponibili

Richiesta

Puoi ottenere un elenco dei dispositivi Bluetooth disponibili per l'accoppiamento usando il formato di richiesta seguente. Questo può essere aggiornato a una connessione WebSocket con gli stessi dati JSON. Per tutta la durata della connessione WebSocket, l'elenco dei dispositivi può cambiare. Un elenco completo di dispositivi verrà inviato tramite la connessione WebSocket ogni volta che viene effettuato un aggiornamento.

Metodo	URI della richiesta
GET	/api/bt/getavailable
GET/WebSocket	/api/bt/getavailable

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include una matrice JSON di dispositivi Bluetooth disponibili per l'accoppiamento.

{"AvailableDevices": [
    {
        "Name" : string,
        "ID" : string
    },...
]}

Collegare un dispositivo Bluetooth

Richiesta

Si connetterà al dispositivo se il dispositivo può essere usato per l'audio in questo sistema. (criteri e componenti facoltativi potrebbero avere un influsso).

Metodo	URI della richiesta
POST	/api/bt/connectdevice

Parametri URI

Parametro URI	Descrizione
ID	(obbligatorio) ID dell'endpoint di associazione per il dispositivo Bluetooth e deve essere codificato in Base64.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Disconnettere un dispositivo Bluetooth

Richiesta

Disconnetterà il dispositivo se questo può essere usato per l'audio in questo sistema. (criteri e componenti facoltativi potrebbero avere un influsso).

Metodo	URI della richiesta
POST	/api/bt/disconnectdevice

Parametri URI

Parametro URI	Descrizione
ID	(obbligatorio) ID dell'endpoint di associazione per il dispositivo Bluetooth e deve essere codificato in Base64.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Gestione dispositivi

Ottenere i dispositivi installati nel computer

Richiesta

È possibile ottenere l'elenco dei dispositivi installati nel sistema usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/devicemanager/devices

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include una matrice JSON dei dispositivi associati al dispositivo.

{"DeviceList": [
    {
        "Class": string,
        "Description": string,
        "ID": string,
        "Manufacturer": string,
        "ParentID": string,
        "ProblemCode": int,
        "StatusCode": int
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
IoT

Ottenere i dati sui dispositivi/hub USB connessi

Richiesta

Puoi ottenere un elenco dei descrittori USB per i dispositivi e gli hub USB connessi usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/ext/devices/usbdevices

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta è un oggetto JSON che include il valore DeviceID per il dispositivo USB insieme ai descrittori USB e alle informazioni sulla porta per gli hub.

{
    "DeviceList": [
        {
        "ID": string,
        "ParentID": string, // Will equal an "ID" within the list, or be blank
        "Description": string, // optional
        "Manufacturer": string, // optional
        "ProblemCode": int, // optional
        "StatusCode": int // optional
        },
        ...
    ]
}

Esempio di dati restituiti

{
    "DeviceList": [{
        "ID": "System",
        "ParentID": ""
    }, {
        "Class": "USB",
        "Description": "Texas Instruments USB 3.0 xHCI Host Controller",
        "ID": "PCI\\VEN_104C&DEV_8241&SUBSYS_1589103C&REV_02\\4&37085792&0&00E7",
        "Manufacturer": "Texas Instruments",
        "ParentID": "System",
        "ProblemCode": 0,
        "StatusCode": 25174026
    }, {
        "Class": "USB",
        "Description": "USB Composite Device",
        "DeviceDriverKey": "{36fc9e60-c465-11cf-8056-444553540000}\\0016",
        "ID": "USB\\VID_045E&PID_00DB\\8&2994096B&0&1",
        "Manufacturer": "(Standard USB Host Controller)",
        "ParentID": "USB\\VID_0557&PID_8021\\7&2E9A8711&0&4",
        "ProblemCode": 0,
        "StatusCode": 25182218
    }]
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Raccolta dei dump

Ottenere l'elenco di tutti i dump di arresto anomalo per le app

Richiesta

È possibile ottenere l'elenco di tutti i dump di arresto anomalo disponibili per tutte le app trasferite localmente usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/usermode/dumps

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include un elenco di dump di arresto anomalo per ogni app trasferita localmente.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile (in Programma Windows Insider)
Windows Desktop
HoloLens
IoT

Ottenere le impostazioni della raccolta dei dump di arresto anomalo per un'app

Richiesta

È possibile ottenere le impostazioni della raccolta dei dump di arresto anomalo per un'app trasferita localmente usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/usermode/crashcontrol

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
packageFullName	(Obbligatorio) Nome completo del pacchetto per l'app trasferita localmente.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Il formato della risposta è il seguente.

{"CrashDumpEnabled": bool}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile (in Programma Windows Insider)
Windows Desktop
HoloLens
IoT

Eliminare un dump di arresto anomalo per un'app trasferita localmente

Richiesta

Puoi eliminare un dump di arresto anomalo per un'app trasferita localmente usando il formato di richiesta seguente.

Metodo	URI della richiesta
DELETE	/api/debug/dump/usermode/crashdump

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
packageFullName	(Obbligatorio) Nome completo del pacchetto per l'app trasferita localmente.
fileName	(Obbligatorio) Nome del file di dump da eliminare.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile (in Programma Windows Insider)
Windows Desktop
HoloLens
IoT

Disabilitare i dump di arresto anomalo per un'app trasferita localmente

Richiesta

È possibile disabilitare i dump di arresto anomalo per un'app trasferita localmente usando il formato di richiesta seguente.

Metodo	URI della richiesta
DELETE	/api/debug/dump/usermode/crashcontrol

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
packageFullName	(Obbligatorio) Nome completo del pacchetto per l'app trasferita localmente.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile (in Programma Windows Insider)
Windows Desktop
HoloLens
IoT

Scaricare il dump di arresto anomalo per un'app trasferita localmente

Richiesta

Puoi scaricare il dump di arresto anomalo per un'app trasferita localmente usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/usermode/crashdump

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
packageFullName	(Obbligatorio) Nome completo del pacchetto per l'app trasferita localmente.
fileName	(Obbligatorio) Nome del file di dump da scaricare.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include un file di dump. Per esaminarlo, è possibile usare WinDbg o Visual Studio.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile (in Programma Windows Insider)
Windows Desktop
HoloLens
IoT

Abilitare i dump di arresto anomalo per un'app trasferita localmente

Richiesta

Puoi abilitare i dump di arresto anomalo per un'app trasferita localmente usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/debug/dump/usermode/crashcontrol

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
packageFullName	(Obbligatorio) Nome completo del pacchetto per l'app trasferita localmente.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Mobile (in Programma Windows Insider)
Windows Desktop
HoloLens
IoT

Ottenere l'elenco dei file del controllo errori

Richiesta

Puoi ottenere l'elenco dei file di dump ridotti del controllo errori usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/kernel/dumplist

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include un elenco di nomi di file di dump e le dimensioni di questi file. Il formato dell'elenco sarà il seguente.

{"DumpFiles": [
    {
        "FileName": string,
        "FileSize": int
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Scaricare un file di dump del controllo errori

Richiesta

È possibile scaricare un file di dump del controllo errori usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/kernel/dump

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
filename	(Obbligatorio) Nome del file di dump. Per trovare questo nome, è possibile usare l'API che consente di ottenere l'elenco dei dump.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include il file di dump. Per esaminare questo file, è possibile usare WinDbg.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Ottenere le impostazioni del controllo errori relative agli arresti anomali

Richiesta

È possibile ottenere le impostazioni del controllo errori relative agli arresti anomali usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/kernel/crashcontrol

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include le impostazioni relative agli arresti anomali. Per altre informazioni su CrashControl, vedere l'articolo CrashControl. Il modello per la risposta è il seguente.

{
    "autoreboot": bool (0 or 1),
    "dumptype": int (0 to 4),
    "maxdumpcount": int,
    "overwrite": bool (0 or 1)
}

Tipi di dump

0: disabilitata

1: dump della memoria completo (raccoglie tutta la memoria in uso)

2: dump della memoria Kernel (ignora la memoria in modalità utente)

3: minidump del kernel limitato

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Ottenere un dump in tempo reale del kernel

Richiesta

Puoi ottenere un dump in tempo reale del kernel usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/livekernel

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include il dump completo in modalità kernel. Per esaminare questo file, è possibile usare WinDbg.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Ottenere un dump da un processo utente in tempo reale

Richiesta

Puoi ottenere il dump relativo al processo utente in tempo reale usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/debug/dump/usermode/live

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
pid	(Obbligatorio) ID univoco del processo a cui si è interessati.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include il file di dump del processo. Per esaminare questo file, puoi usare WinDbg o Visual Studio.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Definire le impostazioni del controllo errori relative agli arresti anomali

Richiesta

Puoi definire le impostazioni per la raccolta dei dati del controllo errori usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/debug/dump/kernel/crashcontrol

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
autoreboot	(facoltativo) Può essere True o False. Indica se il sistema viene riavviato automaticamente dopo una condizione di errore o di blocco.
dumptype	(Facoltativo) Tipo di dump. Per i valori supportati, vedi l'articolo relativo all'enumerazione CrashDumpType.
maxdumpcount	(Facoltativo) Numero massimo di dump da salvare.
overwrite	(Facoltativo) Può essere True o False. Indica se sovrascrivere dump precedenti quando viene raggiunto il limite del contatore di dump specificato da maxdumpcount.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

ETW

Creare una sessione ETW in tempo reale attraverso una connessione WebSocket

Richiesta

Puoi creare una sessione ETW in tempo reale usando il formato di richiesta seguente. La sessione verrà gestita attraverso una connessione WebSocket. Gli eventi ETW sono gestiti in batch nel server e inviati al client una volta al secondo.

Metodo	URI della richiesta
GET/WebSocket	/api/etw/session/realtime

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include gli eventi ETW generati dai provider abilitati. Visualizza i comandi WebSocket ETW elencati di seguito.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Comandi WebSocket ETW

Questi comandi vengono inviati dal client al server.

Comando	Descrizione
provider {guid} enable {level}	Abilitare il provider contrassegnato da {guid} (senza parentesi) al livello specificato. {level} è un int che va da 1 (meno dettagliato) a 5 (più dettagliato).
provider {guid} disable	Disabilitare il provider contrassegnato da {guid} (senza parentesi).

Queste risposte vengono inviate dal server al client. Vengono inviate come testo e analizzando JSON otterrai il formato seguente.

{
    "Events":[
        {
            "Timestamp": int,
            "ProviderName": string,
            "ID": int, 
            "TaskName": string,
            "Keyword": int,
            "Level": int,
            payload objects...
        },...
    ],
    "Frequency": int
}

Gli oggetti payload sono coppie chiave-valore aggiuntive fornite nell'evento ETW originale.

Esempio

{
    "ID" : 42, 
    "Keyword" : 9223372036854775824, 
    "Level" : 4, 
    "Message" : "UDPv4: 412 bytes transmitted from 10.81.128.148:510 to 132.215.243.34:510. ",
    "PID" : "1218", 
    "ProviderName" : "Microsoft-Windows-Kernel-Network", 
    "TaskName" : "KERNEL_NETWORK_TASK_UDPIP", 
    "Timestamp" : 131039401761757686, 
    "connid" : "0", 
    "daddr" : "132.245.243.34", 
    "dport" : "500", 
    "saddr" : "10.82.128.118", 
    "seqnum" : "0", 
    "size" : "412", 
    "sport" : "500"
}

Enumerare i provider ETW registrati

Richiesta

Puoi enumerare i provider registrati usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/etw/providers

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include l'elenco dei provider ETW. Sono specificati il nome descrittivo e il GUID per ogni provider nel formato seguente.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Enumerare i provider ETW personalizzati esposti dalla piattaforma.

Richiesta

Puoi enumerare i provider registrati usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/etw/customproviders

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

200 OK. La risposta include l'elenco dei provider ETW. Per ogni provider sono specificati il nome descrittivo e il GUID.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

Codice di stato

Codici di stato standard.

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Location

Ottenere la modalità di override della posizione

Richiesta

Puoi ottenere lo stato di override dello stack di percorsi del dispositivo usando il formato di richiesta seguente. La modalità sviluppatore deve essere attivata perché questa chiamata funzioni.

Metodo	URI della richiesta
GET	/ext/location/override

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include lo stato di override del dispositivo nel formato seguente.

{"Override" : bool}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Impostare la modalità di override della posizione

Richiesta

Puoi impostare lo stato di override dello stack di percorsi del dispositivo usando il formato di richiesta seguente. Se abilitato, lo stack di percorsi consente l'inserimento della posizione. La modalità sviluppatore deve essere attivata perché questa chiamata funzioni.

Metodo	URI della richiesta
PUT	/ext/location/override

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

{"Override" : bool}

Response

La risposta include lo stato di override su cui il dispositivo è stato impostato nel formato seguente.

{"Override" : bool}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Ottenere la posizione inserita

Richiesta

Puoi ottenere la posizione inserita (falsificata) del dispositivo usando il formato di richiesta seguente. Una posizione inserita deve essere impostata oppure verrà generato un errore.

Metodo	URI della richiesta
GET	/ext/location/position

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include i valori di longitudine e latitudine inseriti correnti nel formato seguente.

{
    "Latitude" : double,
    "Longitude" : double
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Impostare la posizione inserita

Richiesta

Puoi impostare la posizione inserita (falsificata) del dispositivo usando il formato di richiesta seguente. La modalità di override della posizione deve essere prima abilitata sul dispositivo e la posizione impostata deve essere valida o verrà generato un errore.

Metodo	URI della richiesta
PUT	/ext/location/override

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

{
    "Latitude" : double,
    "Longitude" : double
}

Response

La risposta include la posizione impostata nel formato seguente.

{
    "Latitude" : double,
    "Longitude" : double
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Informazioni sul sistema operativo

Ottenere il nome del computer

Richiesta

È possibile ottenere il nome di un computer usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/os/machinename

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include il nome del computer nel formato seguente.

{"ComputerName": string}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Ottenere informazioni sul sistema operativo

Richiesta

Puoi ottenere informazioni sul sistema operativo per un computer usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/os/info

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include le informazioni del sistema operativo nel formato seguente.

{
    "ComputerName": string,
    "OsEdition": string,
    "OsEditionId": int,
    "OsVersion": string,
    "Platform": string
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Ottenere la famiglia di dispositivi

Richiesta

Puoi ottenere la famiglia di dispositivi (Xbox, telefono, desktop, ecc.) usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/os/devicefamily

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include la famiglia di dispositivi (SKU - desktop, Xbox, ecc.).

{
   "DeviceType" : string
}

DeviceType avrà un valore come "Windows.Xbox", "Windows.Desktop", ecc.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Impostare il nome del computer

Richiesta

Puoi impostare il nome di un computer usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/os/machinename

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
name	(Obbligatorio) Nuovo nome del computer. Dovrebbe essere applicata la codifica base64.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Informazioni utente

Ottenere l'utente attivo

Richiesta

Puoi ottenere il nome dell'utente attivo del dispositivo usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/users/activeuser

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include le informazioni sull'utente nel formato seguente.

In caso di esito positivo:

{
    "UserDisplayName" : string, 
    "UserSID" : string
}

In caso di esito negativo:

{
    "Code" : int, 
    "CodeText" : string, 
    "Reason" : string, 
    "Success" : bool
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Dati sulle prestazioni

Ottenere l'elenco dei processi in esecuzione

Richiesta

Puoi ottenere l'elenco dei processi attualmente in esecuzione usando il formato di richiesta seguente. Può anche avvenire l'aggiornamento a una connessione WebSocket, con gli stessi dati JSON inviati al client una volta al secondo.

Metodo	URI della richiesta
GET	/api/resourcemanager/processes
GET/WebSocket	/api/resourcemanager/processes

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include un elenco dei processi con i relativi dettagli. Le informazioni sono in formato JSON e prevedono il modello seguente.

{"Processes": [
    {
        "CPUUsage": float,
        "ImageName": string,
        "PageFileUsage": long,
        "PrivateWorkingSet": long,
        "ProcessId": int,
        "SessionId": int,
        "UserName": string,
        "VirtualSize": long,
        "WorkingSetSize": long
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Ottenere le statistiche sulle prestazioni del sistema

Richiesta

Puoi ottenere le statistiche sulle prestazioni del sistema usando il formato di richiesta seguente. Le statistiche includono informazioni che riguardano, ad esempio, i cicli di lettura e scrittura e la quantità di memoria usata.

Metodo	URI della richiesta
GET	/api/resourcemanager/systemperf
GET/WebSocket	/api/resourcemanager/systemperf

Può anche avvenire l'aggiornamento a una connessione WebSocket. Vengono forniti gli stessi dati JSON indicati di seguito una volta al secondo.

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include le statistiche sulle prestazioni del sistema, ad esempio l'utilizzo di CPU e GPU, l'accesso alla memoria e l'accesso alla rete. Le informazioni sono in formato JSON e prevedono il modello seguente.

{
    "AvailablePages": int,
    "CommitLimit": int,
    "CommittedPages": int,
    "CpuLoad": int,
    "IOOtherSpeed": int,
    "IOReadSpeed": int,
    "IOWriteSpeed": int,
    "NonPagedPoolPages": int,
    "PageSize": int,
    "PagedPoolPages": int,
    "TotalInstalledInKb": int,
    "TotalPages": int,
    "GPUData": 
    {
        "AvailableAdapters": [{ (One per detected adapter)
            "DedicatedMemory": int,
            "DedicatedMemoryUsed": int,
            "Description": string,
            "SystemMemory": int,
            "SystemMemoryUsed": int,
            "EnginesUtilization": [ float,... (One per detected engine)]
        },...
    ]},
    "NetworkingData": {
        "NetworkInBytes": int,
        "NetworkOutBytes": int
    }
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Power

Ottenere lo stato corrente della batteria

Richiesta

Puoi ottenere lo stato corrente della batteria usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/power/battery

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Le informazioni sullo stato della batteria corrente vengono restituite nel formato seguente.

{
    "AcOnline": int (0 | 1),
    "BatteryPresent": int (0 | 1),
    "Charging": int (0 | 1),
    "DefaultAlert1": int,
    "DefaultAlert2": int,
    "EstimatedTime": int,
    "MaximumCapacity": int,
    "RemainingCapacity": int
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Ottenere la combinazione attiva per il risparmio di energia

Richiesta

Puoi ottenere la combinazione attiva per il risparmio di energia usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/power/activecfg

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La combinazione attiva per il risparmio di energia ha il formato seguente.

{"ActivePowerScheme": string (guid of scheme)}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Ottenere il valore secondario relativo a una combinazione per il risparmio di energia

Richiesta

È possibile ottenere il valore secondario relativo a una combinazione per il risparmio di energia usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/power/cfg/<percorso dello schema di alimentazione>

Opzioni:

SCHEME_CURRENT

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Un elenco completo degli stati di alimentazione disponibili per ogni applicazione e impostazioni per contrassegnare i diversi stati di alimentazione come "basso" e "critico".

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Ottenere lo stato di alimentazione del sistema

Richiesta

Puoi controllare lo stato di alimentazione del sistema usando il formato di richiesta seguente. Con questa richiesta puoi verificare se è attiva la modalità a basso consumo.

Metodo	URI della richiesta
GET	/api/power/state

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Le informazioni sullo stato di alimentazione prevedono il modello seguente.

{"LowPowerState" : false, "LowPowerStateAvailable" : true }

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Impostare la combinazione attiva per il risparmio di energia

Richiesta

Puoi impostare la combinazione attiva per il risparmio di energia usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/power/activecfg

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
scheme	(Obbligatorio) GUID della combinazione per il risparmio di energia da attivare per il sistema.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Impostare il valore secondario relativo a una combinazione per il risparmio di energia

Richiesta

Puoi impostare il valore secondario relativo a una combinazione per il risparmio di energia usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/power/cfg/<percorso dello schema di alimentazione>

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
valueAC	(Obbligatorio) Valore da usare per l'alimentazione tramite rete elettrica.
valueDC	(Obbligatorio) Valore da usare per l'alimentazione a batteria.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Ottenere un report Studio inattività

Richiesta

Metodo	URI della richiesta
GET	/api/power/sleepstudy/report

È possibile ottenere un report Studio inattività usando il formato di richiesta seguente.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta è un file contenente il report Studio inattività.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Enumerare i report Studio inattività disponibili

Richiesta

Puoi enumerare i report Studio inattività disponibili usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/power/sleepstudy/reports

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

L'elenco dei report disponibili prevede il modello seguente.

{"Reports": [
    {
        "FileName": string
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Ottenere la trasformazione di report Studio inattività

Richiesta

Puoi ottenere la trasformazione di report Studio inattività usando il formato di richiesta seguente. Questa è una trasformazione XSLT che converte il report Studio inattività in un formato XML leggibile da un utente.

Metodo	URI della richiesta
GET	/api/power/sleepstudy/transform

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta contiene la trasformazione di report Studio inattività.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
IoT

Controllo remoto

Riavviare il computer di destinazione

Richiesta

Puoi riavviare il computer di destinazione usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/control/restart

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Arrestare il computer di destinazione

Richiesta

Puoi arrestare il computer di destinazione usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/control/shutdown

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Gestione attività

Avviare un'app moderna

Richiesta

È possibile avviare un'app moderna usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/taskmanager/app

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
appid	(Obbligatorio) PRAID per l'app da avviare. Per questo valore deve essere usata la codifica hex64.
pacchetto	(necessario) Nome completo del pacchetto dell'app da avviare. Per questo valore deve essere usata la codifica hex64.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Arrestare un'app moderna

Richiesta

È possibile arrestare un'app moderna usando il formato di richiesta seguente.

Metodo	URI della richiesta
DELETE	/api/taskmanager/app

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
pacchetto	(Obbligatorio) Nome completo dei pacchetti di app da arrestare. Per questo valore deve essere usata la codifica hex64.
forcestop	(Facoltativo) Il valore yes indica che il sistema deve forzare l'arresto di tutti i processi.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Termina processo mediante il PID

Richiesta

Puoi terminare un processo usando il formato di richiesta seguente.

Metodo	URI della richiesta
DELETE	/api/taskmanager/process

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
pid	(obbligatorio) ID univoco del processo per il suo arresto.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Rete

Ottenere la configurazione IP corrente

Richiesta

Puoi ottenere la configurazione IP corrente usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/networking/ipconfig

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

La risposta include la configurazione IP nel modello seguente.

{"Adapters": [
    {
        "Description": string,
        "HardwareAddress": string,
        "Index": int,
        "Name": string,
        "Type": string,
        "DHCP": {
            "LeaseExpires": int, (timestamp)
            "LeaseObtained": int, (timestamp)
            "Address": {
                "IpAddress": string,
                "Mask": string
            }
        },
        "WINS": {(WINS is optional)
            "Primary": {
                "IpAddress": string,
                "Mask": string
            },
            "Secondary": {
                "IpAddress": string,
                "Mask": string
            }
        },
        "Gateways": [{ (always 1+)
            "IpAddress": "10.82.128.1",
            "Mask": "255.255.255.255"
            },...
        ],
        "IpAddresses": [{ (always 1+)
            "IpAddress": "10.82.128.148",
            "Mask": "255.255.255.0"
            },...
        ]
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Impostare un indirizzo IP statico (configurazione IPV4)

Richiesta

Imposta la configurazione IPV4 con IP statico e DNS. Se non si specifica un indirizzo IP statico, viene abilitato DHCP. Se viene specificato un indirizzo IP statico, è necessario specificare anche DNS.

Metodo	URI della richiesta
PUT	/api/networking/ipv4config

Parametri URI

Parametro URI	Descrizione
AdapterName	(obbligatorio) GUID dell'interfaccia di rete.
IPAddress	Indirizzo IP statico da impostare.
SubnetMask	(obbligatorio se IPAddress non è null) Subnet mask statica.
DefaultGateway	(obbligatorio se IPAddress non è null) Gateway predefinito statico.
PrimaryDNS	(obbligatorio se IPAddress non è null) DNS primario statico da impostare.
SecondayDNS	(obbligatorio se PrimaryDNS non è null) DNS secondario statico da impostare.

Per maggiore chiarezza, per impostare un'interfaccia su DHCP, serializza solo i AdapterName in transito:

{
    "AdapterName":"{82F86C1B-2BAE-41E3-B08D-786CA44FEED7}"
}

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Enumerare le interfacce di rete wireless

Richiesta

Puoi enumerare le interfacce di rete wireless disponibili usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wifi/interfaces

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Elenco delle interfacce wireless disponibili con i dettagli nel formato seguente.

{"Interfaces": [{
    "Description": string,
    "GUID": string (guid with curly brackets),
    "Index": int,
    "ProfilesList": [
        {
            "GroupPolicyProfile": bool,
            "Name": string, (Network currently connected to)
            "PerUserProfile": bool
        },...
    ]
    }
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Enumerare le reti wireless

Richiesta

È possibile enumerare le reti wireless sull'interfaccia specificata usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wifi/networks

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
interface	(Obbligatorio) GUID dell'interfaccia di rete da usare per la ricerca di reti wireless, senza parentesi.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Elenco delle reti wireless trovate nell'interfaccia fornita. Sono inclusi i dettagli relativi alle reti nel formato seguente.

{"AvailableNetworks": [
    {
        "AlreadyConnected": bool,
        "AuthenticationAlgorithm": string, (WPA2, etc)
        "Channel": int,
        "CipherAlgorithm": string, (for example, AES)
        "Connectable": int, (0 | 1)
        "InfrastructureType": string,
        "ProfileAvailable": bool,
        "ProfileName": string,
        "SSID": string,
        "SecurityEnabled": int, (0 | 1)
        "SignalQuality": int,
        "BSSID": [int,...],
        "PhysicalTypes": [string,...]
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Connettersi a una rete Wi-Fi e disconnettersi da tale rete

Richiesta

Puoi connetterti a una rete Wi-Fi o disconnetterti da tale rete usando il formato di richiesta seguente.

Metodo	URI della richiesta
POST	/api/wifi/network

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
interface	(Obbligatorio) GUID dell'interfaccia di rete da usare per la connessione alla rete.
Op	(Obbligatorio) Azione da eseguire. I valori possibili sono connect o disconnect.
ssid	(obbligatorio se op == connect) SSID a cui connettersi.
key	(obbligatorio se op == connect e la rete richiede l'autenticazione) La chiave condivisa.
createprofile	(Obbligatorio) Creare un profilo per la rete nel dispositivo. Questo determinerà la connessione automatica del dispositivo alla rete in futuro. Il valore può essere yes o no.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Eliminare un profilo Wi-Fi

Richiesta

Puoi eliminare un profilo associato a una rete su un'interfaccia specifica usando il formato di richiesta seguente.

Metodo	URI della richiesta
DELETE	/api/wifi/profile

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
interface	(Obbligatorio) GUID dell'interfaccia di rete associata al profilo da eliminare.
profile	(Obbligatorio) Nome del profilo da eliminare.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Segnalazione errori Windows

Scaricare un file di Segnalazione errori Windows

Richiesta

È possibile scaricare un file correlato a Segnalazione errori Windows usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wer/report/file

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
utente	(Obbligatorio) Nome utente associato al report.
tipo	(Obbligatorio) Tipo di report. Può essere queried o archived.
name	(Obbligatorio) Nome del report. Dovrebbe essere applicata la codifica base64.
file	(Obbligatorio) Nome del file da scaricare dal report. Dovrebbe essere applicata la codifica base64.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Risposta contenente il file richiesto.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Enumerare i file in un report di Segnalazione errori Windows

Richiesta

Puoi enumerare i file in un report di Segnalazione errori Windows usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wer/report/files

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
utente	(Obbligatorio) Utente associato al report.
tipo	(Obbligatorio) Tipo di report. Può essere queried o archived.
name	(Obbligatorio) Nome del report. Dovrebbe essere applicata la codifica base64.

Intestazioni delle richieste

Nessuno

Testo della richiesta

{"Files": [
    {
        "Name": string, (Filename, not base64 encoded)
        "Size": int (bytes)
    },...
]}

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Elencare i report di Segnalazione errori Windows

Richiesta

È possibile ottenere i report di Segnalazione errori Windows usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wer/reports

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

I report di Segnalazione errori Windows presentano il formato seguente.

{"WerReports": [
    {
        "User": string,
        "Reports": [
            {
                "CreationTime": int,
                "Name": string, (not base64 encoded)
                "Type": string ("Queue" or "Archive")
            },
    ]},...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Desktop
HoloLens
IoT

Windows Performance Recorder (WPR)

Avviare la traccia con un profilo personalizzato

Richiesta

Puoi caricare un profilo WPR e avviare la traccia con tale profilo usando il formato di richiesta seguente. Può essere eseguita una sola traccia per volta. Il profilo non rimarrà nel dispositivo.

Metodo	URI della richiesta
POST	/api/wpr/customtrace

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Corpo multiparte conforme al corpo HTTP che contiene il profilo WPR personalizzato.

Response

Lo stato della sessione WPR nel formato seguente.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Avviare una sessione di traccia delle prestazioni di avvio

Richiesta

Puoi avviare una sessione di traccia WPR di avvio usando il formato di richiesta seguente. La sessione è denominata anche sessione di traccia delle prestazioni.

Metodo	URI della richiesta
POST	/api/wpr/boottrace

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
profile	(Obbligatorio) Questo parametro è obbligatorio all'avvio. Definisce il nome del profilo che deve avviare una sessione di traccia delle prestazioni. I profili possibili sono memorizzati in perfprofiles/profiles.json.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

All'avvio, questa API restituisce lo stato della sessione WPR nel formato seguente.

{
    "SessionType": string, (Running or Idle) 
    "State": string (boot)
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Arrestare una sessione di traccia delle prestazioni di avvio

Richiesta

Puoi arrestare una sessione di traccia WPR di avvio usando il formato di richiesta seguente. La sessione è denominata anche sessione di traccia delle prestazioni.

Metodo	URI della richiesta
GET	/api/wpr/boottrace

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Nessuno. Nota:questa è un'operazione a esecuzione prolungata, che terminerà quando il file ETL avrà completato la scrittura sul disco.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Avviare una sessione di traccia delle prestazioni

Richiesta

Puoi avviare una sessione di traccia WPR usando il formato di richiesta seguente. La sessione è denominata anche sessione di traccia delle prestazioni. Può essere eseguita una sola traccia per volta.

Metodo	URI della richiesta
POST	/api/wpr/trace

Parametri URI

Nell'URI della richiesta puoi specificare i parametri seguenti:

Parametro URI	Descrizione
profile	(Obbligatorio) Nome del profilo che deve avviare una sessione di traccia delle prestazioni. I profili possibili sono memorizzati in perfprofiles/profiles.json.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

All'avvio, questa API restituisce lo stato della sessione WPR nel formato seguente.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal)
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Arrestare una sessione di traccia delle prestazioni

Richiesta

È possibile arrestare una sessione di traccia WPR usando il formato di richiesta seguente. La sessione è denominata anche sessione di traccia delle prestazioni.

Metodo	URI della richiesta
GET	/api/wpr/trace

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Nessuno. Nota:questa è un'operazione a esecuzione prolungata, che terminerà quando il file ETL avrà completato la scrittura sul disco.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Recuperare lo stato di una sessione di traccia

Richiesta

È possibile recuperare lo stato della sessione WPR corrente usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wpr/status

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Stato della sessione di traccia WPR nel formato seguente.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Elencare le sessioni di traccia completate (ETL)

Richiesta

È possibile ottenere un elenco di tracce ETL nel dispositivo usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wpr/tracefiles

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

L'elenco di sessioni di traccia completate è disponibile nel formato seguente.

{"Items": [{
    "CurrentDir": string (filepath),
    "DateCreated": int (File CreationTime),
    "FileSize": int (bytes),
    "Id": string (filename),
    "Name": string (filename),
    "SubPath": string (filepath),
    "Type": int
}]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Scaricare una sessione di traccia (ETL)

Richiesta

È possibile scaricare un file di traccia (traccia di avvio o traccia in modalità utente) usando il formato di richiesta seguente.

Metodo	URI della richiesta
GET	/api/wpr/tracefile

Parametri URI

Nell'URI della richiesta è possibile specificare il parametro seguente:

Parametro URI	Descrizione
filename	(obbligatorio) Nome della traccia ETL da scaricare. È possibile trovarli in /api/wpr/tracefiles.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Restituisce il file di traccia ETL.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Eliminare una sessione di traccia (ETL)

Richiesta

È possibile eliminare un file di traccia (traccia di avvio o traccia in modalità utente) usando il formato di richiesta seguente.

Metodo	URI della richiesta
DELETE	/api/wpr/tracefile

Parametri URI

Nell'URI della richiesta è possibile specificare il parametro seguente:

Parametro URI	Descrizione
filename	(obbligatorio) Nome della traccia ETL da eliminare. È possibile trovarli in /api/wpr/tracefiles.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Restituisce il file di traccia ETL.

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
IoT

Tag DNS-SD

Visualizzare tag

Richiesta

Visualizzare i tag attualmente applicati per il dispositivo. Questi sono annunciati tramite record DNS-SD TXT nella chiave T.

Metodo	URI della richiesta
GET	/api/dns-sd/tags

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Risposta I tag attualmente applicati nel formato seguente.

 {
    "tags": [
        "tag1", 
        "tag2", 
        ...
     ]
}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
5XX	Errore del server

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Eliminare tag

Richiesta

Eliminare tutti i tag attualmente annunciati da DNS-SD.

Metodo	URI della richiesta
DELETE	/api/dns-sd/tags

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Nessuno

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
5XX	Errore del server

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Eliminare un tag

Richiesta

Eliminare un tag attualmente annunciato da DNS-SD.

Metodo	URI della richiesta
DELETE	/api/dns-sd/tag

Parametri URI

Parametro URI	Descrizione
tagValue	(Obbligatorio) Il tag da rimuovere.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Nessuno

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Aggiungere un tag

Richiesta

Aggiungere un tag all'annuncio DNS-SD.

Metodo	URI della richiesta
POST	/api/dns-sd/tag

Parametri URI

Parametro URI	Descrizione
tagValue	(Obbligatorio) Il tag da aggiungere.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Nessuno

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
401	Overflow di spazio per il tag. Si verifica quando il tag proposto è troppo lungo per il record di servizio DNS-SD risultante.

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
Xbox
HoloLens
IoT

Esplora file dell'app

Recuperare le cartelle note

Richiesta

Ottenere un elenco delle cartelle di primo livello accessibili.

Metodo	URI della richiesta
GET	/api/filesystem/apps/knownfolders

Parametri URI

Nessuno

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Risposta Le cartelle disponibili nel formato seguente.

 {"KnownFolders": [
    "folder0",
    "folder1",...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	Distribuire richieste accettate e in fase di elaborazione
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Recuperare file

Richiesta

Ottenere un elenco dei file in una cartella.

Metodo	URI della richiesta
GET	/api/filesystem/apps/files

Parametri URI

Parametro URI	Descrizione
knownfolderid	(Obbligatorio) Directory di primo livello di cui si vogliono elencare i file. Usare LocalAppData per accedere alle app trasferite tramite sideload.
packagefullname	(*obbligatorio se knownfolderid* == LocalAppData**) Nome completo del pacchetto dell'app che ti interessa.
path	(Facoltativo) Sottodirectory all'interno della cartella o del pacchetto specificati in precedenza.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Risposta Le cartelle disponibili nel formato seguente.

{"Items": [
    {
        "CurrentDir": string (folder under the requested known folder),
        "DateCreated": int,
        "FileSize": int (bytes),
        "Id": string,
        "Name": string,
        "SubPath": string (present if this item is a folder, this is the name of the folder),
        "Type": int
    },...
]}

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Scaricare un file

Richiesta

Ottenere un file da una cartella nota o da appLocalData.

Metodo	URI della richiesta
GET	/api/filesystem/apps/file

Parametri URI

Parametro URI	Descrizione
knownfolderid	(Obbligatorio) Directory di primo livello in cui si vogliono scaricare i file. Usare LocalAppData per accedere alle app trasferite tramite sideload.
filename	(Obbligatorio) Nome del file da scaricare.
packagefullname	(*obbligatorio se knownfolderid* == LocalAppData**) Nome completo del pacchetto che ti interessa.
path	(Facoltativo) Sottodirectory all'interno della cartella o del pacchetto specificati in precedenza.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Il file richiesto, se presente

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	Il file richiesto
404	File non trovato
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Rinominare un file

Richiesta

Rinominare un file in una cartella.

Metodo	URI della richiesta
POST	/api/filesystem/apps/rename

Parametri URI

Parametro URI	Descrizione
knownfolderid	(Obbligatorio) Directory di primo livello in cui si trova il file. Usare LocalAppData per accedere alle app trasferite tramite sideload.
filename	(Obbligatorio) Nome originale del file da rinominare.
newfilename	(Obbligatorio) Nuovo nome del file.
packagefullname	(*obbligatorio se knownfolderid* == LocalAppData**) Nome completo del pacchetto dell'app che ti interessa.
path	(Facoltativo) Sottodirectory all'interno della cartella o del pacchetto specificati in precedenza.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Nessuno

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK. Il file viene rinominato
404	File non trovato
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Eliminare un file

Richiesta

Eliminare un file in una cartella.

Metodo	URI della richiesta
DELETE	/api/filesystem/apps/file

Parametri URI

Parametro URI	Descrizione
knownfolderid	(Obbligatorio) Directory di primo livello in cui si vuole eliminare i file. Usare LocalAppData per accedere alle app trasferite tramite sideload.
filename	(Obbligatorio) Nome del file da eliminare.
packagefullname	(*obbligatorio se knownfolderid* == LocalAppData**) Nome completo del pacchetto dell'app che ti interessa.
path	(Facoltativo) Sottodirectory all'interno della cartella o del pacchetto specificati in precedenza.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Nessuno

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK. File eliminato
404	File non trovato
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Caricare un file

Richiesta

Caricare un file in una cartella. Se esiste un file con lo stesso nome verrà sovrascritto, ma non vengono create nuove cartelle.

Metodo	URI della richiesta
POST	/api/filesystem/apps/file

Parametri URI

Parametro URI	Descrizione
knownfolderid	(Obbligatorio) Directory di primo livello in cui si vuole caricare i file. Usare LocalAppData per accedere alle app trasferite tramite sideload.
packagefullname	(*obbligatorio se knownfolderid* == LocalAppData**) Nome completo del pacchetto dell'app che ti interessa.
extract	(Obbligatorio) Può essere True o false. Indica se il file deve essere estratto dopo il caricamento.
path	(Facoltativo) Sottodirectory all'interno della cartella o del pacchetto specificati in precedenza.

Intestazioni delle richieste

Nessuno

Testo della richiesta

Nessuno

Response

Codice di stato

Questa API ha i codici di stato previsto seguenti.

Codice di stato HTTP	Descrizione
200	OK. File caricato
4XX	Codici di errore
5XX	Codici di errore

Famiglie di dispositivi disponibili

Windows Mobile
Windows Desktop
HoloLens
Xbox
IoT

Condividi tramite

Riferimento API REST di base del Portale di dispositivi di Windows

Distribuzione dell'app

Installare un'app

Installare un set correlato

Registrare un'app in una cartella separata

Registrare un set correlato in cartelle di file separate

Ottenere lo stato dell'installazione di un'app

Disinstallare un'app

Ottenere app installate

Bluetooth

Ottenere le radio Bluetooth nel computer

Attivare o disattivare la radio Bluetooth

Ottenere un elenco di dispositivi Bluetooth accoppiati

Ottenere un elenco di dispositivi Bluetooth disponibili

Collegare un dispositivo Bluetooth

Disconnettere un dispositivo Bluetooth

Gestione dispositivi

Ottenere i dispositivi installati nel computer

Ottenere i dati sui dispositivi/hub USB connessi

Raccolta dei dump

Ottenere l'elenco di tutti i dump di arresto anomalo per le app

Ottenere le impostazioni della raccolta dei dump di arresto anomalo per un'app

Eliminare un dump di arresto anomalo per un'app trasferita localmente

Disabilitare i dump di arresto anomalo per un'app trasferita localmente

Scaricare il dump di arresto anomalo per un'app trasferita localmente

Abilitare i dump di arresto anomalo per un'app trasferita localmente

Ottenere l'elenco dei file del controllo errori

Scaricare un file di dump del controllo errori

Ottenere le impostazioni del controllo errori relative agli arresti anomali

Ottenere un dump in tempo reale del kernel

Ottenere un dump da un processo utente in tempo reale

Definire le impostazioni del controllo errori relative agli arresti anomali

ETW

Creare una sessione ETW in tempo reale attraverso una connessione WebSocket

Comandi WebSocket ETW

Enumerare i provider ETW registrati

Enumerare i provider ETW personalizzati esposti dalla piattaforma.

Location

Ottenere la modalità di override della posizione

Impostare la modalità di override della posizione

Ottenere la posizione inserita

Impostare la posizione inserita

Informazioni sul sistema operativo

Ottenere il nome del computer

Ottenere informazioni sul sistema operativo

Ottenere la famiglia di dispositivi

Impostare il nome del computer

Informazioni utente

Ottenere l'utente attivo

Dati sulle prestazioni

Ottenere l'elenco dei processi in esecuzione

Ottenere le statistiche sulle prestazioni del sistema

Power

Ottenere lo stato corrente della batteria

Ottenere la combinazione attiva per il risparmio di energia

Ottenere il valore secondario relativo a una combinazione per il risparmio di energia

Ottenere lo stato di alimentazione del sistema

Impostare la combinazione attiva per il risparmio di energia

Impostare il valore secondario relativo a una combinazione per il risparmio di energia

Ottenere un report Studio inattività

Enumerare i report Studio inattività disponibili

Ottenere la trasformazione di report Studio inattività

Controllo remoto

Riavviare il computer di destinazione

Arrestare il computer di destinazione

Gestione attività

Avviare un'app moderna

Arrestare un'app moderna

Termina processo mediante il PID

Rete

Ottenere la configurazione IP corrente

Impostare un indirizzo IP statico (configurazione IPV4)

Enumerare le interfacce di rete wireless

Enumerare le reti wireless

Connettersi a una rete Wi-Fi e disconnettersi da tale rete

Eliminare un profilo Wi-Fi

Segnalazione errori Windows

Scaricare un file di Segnalazione errori Windows

Enumerare i file in un report di Segnalazione errori Windows