File Uploads - Get

Service:

IoT Central

API Version:

2022-07-31

Ottenere la configurazione dell'account di archiviazione per il caricamento del file.

GET https://{subdomain}.{baseDomain}/api/fileUploads?api-version=2022-07-31

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
baseDomain	path	True	string	Dominio di base per tutte le richieste di servizio Azure IoT Central.
subdomain	path	True	string	Sottodominio dell'applicazione.
api-version	query	True	string	Versione dell'API chiamata.

Risposte

Nome	Tipo	Descrizione
200 OK	FileUpload	Operazione riuscita
Other Status Codes	Error	Risposta di errore ricevuta dal servizio IoT Central. Headers x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get file upload storage account configuration

Sample Request

HTTP

GET https://appsubdomain.azureiotcentral.com/api/fileUploads?api-version=2022-07-31

Sample Response

Status code:

200

{
  "account": "contoso-account",
  "connectionString": "DefaultEndpointsProtocol=https;AccountName=MyAccountName;AccountKey=*****;EndpointSuffix=core.windows.net",
  "container": "container",
  "state": "succeeded"
}

Definizioni

Nome	Descrizione
Error	Definizione dell'errore di risposta.
ErrorDetails	Informazioni dettagliate sull'errore.
FileUpload	Definizione di configurazione del caricamento del file.
FileUploadState	Stato della configurazione di caricamento del file

Error

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli degli errori per la richiesta corrente.

ErrorDetails

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Dettagli del messaggio di errore.
requestId	string	ID di correlazione per la richiesta corrente.
time	string	Ora in cui la richiesta di errore non è riuscita.

FileUpload

Definizione di configurazione del caricamento del file.

Nome	Tipo	Descrizione
account	string	Nome dell'account di archiviazione in cui caricare il file in
connectionString	string	Stringa di connessione usato per configurare l'account di archiviazione
container	string	Nome del contenitore all'interno dell'account di archiviazione
etag	string	ETag usato per evitare conflitti con più caricamenti
sasTtl	string	ISO 8601 duration standard, la quantità di tempo per cui il dispositivo richiede di caricare un file è valido prima della scadenza.
state	FileUploadState	Stato della configurazione di caricamento del file

FileUploadState

Stato della configurazione di caricamento del file

Nome	Tipo	Descrizione
deleting	string
failed	string
pending	string
succeeded	string
updating	string