File Uploads - Get

ファイル アップロード ストレージ アカウントの構成を取得します。

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

URI パラメーター

Name In Required Type Description
baseDomain
path True
  • string

すべての Azure IoT Central サービス要求のベース ドメイン。

subdomain
path True
  • string

アプリケーション サブドメイン。

api-version
query True
  • string

呼び出される API のバージョン。

応答

Name Type Description
200 OK

Success

Other Status Codes

IoT Central サービスから受信したエラー応答。

Headers

  • x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

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"
}

定義

Error

応答エラーの定義。

ErrorDetails

エラーの詳細情報。

FileUpload

ファイル アップロード構成定義。

FileUploadState

ファイル アップロード構成の状態

Error

応答エラーの定義。

Name Type Description
error

現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

Name Type Description
code
  • string

エラー コード。

message
  • string

エラー メッセージの詳細。

requestId
  • string

現在の要求の関連付け ID。

time
  • string

エラー要求が失敗した時刻。

FileUpload

ファイル アップロード構成定義。

Name Type Description
account
  • string

ファイルのアップロード先となるストレージ アカウント名

connectionString
  • string

ストレージ アカウントの構成に使用される接続文字列

container
  • string

ストレージ アカウント内のコンテナーの名前

etag
  • string

複数のアップロードとの競合を防ぐために使用される ETag

sasTtl
  • string

ISO 8601 期間の標準、ファイルをアップロードするデバイスの要求が有効期限が切れる前に有効な時間。

state

ファイル アップロード構成の状態

FileUploadState

ファイル アップロード構成の状態

Name Type Description
deleting
  • string
failed
  • string
pending
  • string
succeeded
  • string
updating
  • string