File Uploads - Get
Pobierz konfigurację konta magazynu przekazywania pliku.
GET https://{subdomain}.{baseDomain}/api/fileUploads?api-version=2022-07-31
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
base
|
path | True |
string |
Domena podstawowa dla wszystkich żądań usług usługi Azure IoT Central. |
subdomain
|
path | True |
string |
Poddomena aplikacji. |
api-version
|
query | True |
string |
Wywoływana wersja interfejsu API. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Powodzenie |
|
Other Status Codes |
Odpowiedź o błędzie odebrana z usługi IoT Central. Headers x-ms-error-code: string |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Get file upload storage account configuration
Sample Request
GET https://appsubdomain.azureiotcentral.com/api/fileUploads?api-version=2022-07-31
Sample Response
{
"account": "contoso-account",
"connectionString": "DefaultEndpointsProtocol=https;AccountName=MyAccountName;AccountKey=*****;EndpointSuffix=core.windows.net",
"container": "container",
"state": "succeeded"
}
Definicje
Nazwa | Opis |
---|---|
Error |
Definicja błędu odpowiedzi. |
Error |
Szczegółowe informacje o błędzie. |
File |
Definicja konfiguracji przekazywania pliku. |
File |
Stan konfiguracji przekazywania pliku |
Error
Definicja błędu odpowiedzi.
Nazwa | Typ | Opis |
---|---|---|
error |
Szczegóły błędu dla bieżącego żądania. |
ErrorDetails
Szczegółowe informacje o błędzie.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
message |
string |
Szczegóły komunikatu o błędzie. |
requestId |
string |
Identyfikator korelacji dla bieżącego żądania. |
time |
string |
Czas niepowodzenia żądania błędu. |
FileUpload
Definicja konfiguracji przekazywania pliku.
Nazwa | Typ | Opis |
---|---|---|
account |
string |
Nazwa konta magazynu, do którego należy przekazać plik |
connectionString |
string |
Parametry połączenia używane do konfigurowania konta magazynu |
container |
string |
Nazwa kontenera na koncie magazynu |
etag |
string |
Element ETag używany do zapobiegania konfliktowi z wieloma przekazywaniem |
sasTtl |
string |
Standard czasu trwania ISO 8601— czas żądania przekazania pliku przez urządzenie jest prawidłowy przed wygaśnięciem. |
state |
Stan konfiguracji przekazywania pliku |
FileUploadState
Stan konfiguracji przekazywania pliku
Nazwa | Typ | Opis |
---|---|---|
deleting |
string |
|
failed |
string |
|
pending |
string |
|
succeeded |
string |
|
updating |
string |