Instances - Create

インスタンスを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/instances/{instanceName}?api-version=2020-03-01-preview

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

アカウント名。

Regex pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

instanceName
path True
  • string

インスタンス名。

Regex pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

resourceGroupName
path True
  • string

リソース グループ名。

subscriptionId
path True
  • string

Azure サブスクリプション ID。

api-version
query True
  • string

ADU スキーマ API のバージョン。

要求本文

Name Required Type Description
location True
  • string

リソースが存在する地理的な場所

properties.diagnosticStorageProperties

顧客が開始した診断ログ収集ストレージのプロパティ

properties.enableDiagnostics
  • boolean

診断ログの収集を有効または無効にします

properties.iotHubs

アカウントに関連付けられている IoT Hub の一覧。

tags
  • object

リソース タグ。

応答

Name Type Description
201 Created

インスタンスを作成または更新するための非同期操作が作成されました。

Other Status Codes

操作エラーの理由を説明するエラー応答。

セキュリティ

azure_auth

OAuth2 フローをAzure Active Directoryします。

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

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

Creates or updates Instance

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue?api-version=2020-03-01-preview

{
  "location": "westus2",
  "properties": {
    "iotHubs": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub",
        "ioTHubConnectionString": "string",
        "eventHubConnectionString": "string"
      }
    ],
    "enableDiagnostics": false,
    "diagnosticStorageProperties": {
      "authenticationType": "KeyBased",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount",
      "connectionString": "string"
    }
  }
}

Sample Response

{
  "name": "blue",
  "location": "westus2",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue",
  "type": "Microsoft.DeviceUpdate/accounts/instances",
  "properties": {
    "provisioningState": "Accepted",
    "accountName": "contoso",
    "iotHubs": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
      }
    ],
    "enableDiagnostics": false,
    "diagnosticStorageProperties": {
      "authenticationType": "KeyBased",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
    }
  }
}

定義

AuthenticationType

認証の種類

createdByType

リソースを作成した ID の種類。

DiagnosticStorageProperties

顧客が開始した診断ログ収集ストレージのプロパティ

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

Instance

Device Update インスタンスの詳細。

IotHubSettings

Device Update アカウントとIoT Hub設定の統合。

ProvisioningState

プロビジョニングの状態。

systemData

リソースの作成と最後の変更に関連するメタデータ。

AuthenticationType

認証の種類

Name Type Description
KeyBased
  • string

createdByType

リソースを作成した ID の種類。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DiagnosticStorageProperties

顧客が開始した診断ログ収集ストレージのプロパティ

Name Type Description
authenticationType

認証の種類

connectionString
  • string

診断ストレージ アカウントの ConnectionString

resourceId
  • string

診断ストレージ アカウントの ResourceId

ErrorAdditionalInfo

リソース管理エラーの追加情報。

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorDetail

エラーの詳細。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ErrorResponse

エラー応答

Name Type Description
error

エラー オブジェクト。

Instance

Device Update インスタンスの詳細。

Name Type Description
id
  • string

リソースの完全修飾リソース ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

リソースが存在する地理的な場所

name
  • string

リソースの名前

properties.accountName
  • string

インスタンスが属する親デバイス更新アカウント名。

properties.diagnosticStorageProperties

顧客が開始した診断ログ収集ストレージのプロパティ

properties.enableDiagnostics
  • boolean

診断ログの収集を有効または無効にします

properties.iotHubs

アカウントに関連付けられている IoT Hub の一覧。

properties.provisioningState

プロビジョニングの状態。

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

tags
  • object

リソース タグ。

type
  • string

リソースの型。 たとえば、"Microsoft.Compute/virtualMachines" や "Microsoft" などです。Storage/storageAccounts"

IotHubSettings

Device Update アカウントとIoT Hub設定の統合。

Name Type Description
eventHubConnectionString
  • string

EventHub 接続文字列。

ioTHubConnectionString
  • string

IoTHub 接続文字列。

resourceId
  • string

IoTHub リソース ID

ProvisioningState

プロビジョニングの状態。

Name Type Description
Accepted
  • string
Canceled
  • string
Creating
  • string
Deleted
  • string
Failed
  • string
Succeeded
  • string

systemData

リソースの作成と最後の変更に関連するメタデータ。

Name Type Description
createdAt
  • string

リソース作成のタイムスタンプ (UTC)。

createdBy
  • string

リソースを作成した ID。

createdByType

リソースを作成した ID の種類。

lastModifiedAt
  • string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy
  • string

リソースを最後に変更した ID。

lastModifiedByType

リソースを最後に変更した ID の種類。