Addons - List By Role

ロールで構成されているすべてのアドオンを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons?api-version=2021-02-01

URI パラメーター

Name In Required Type Description
deviceName
path True
  • string

デバイス名。

resourceGroupName
path True
  • string

リソース グループ名。

roleName
path True
  • string

ロール名。

subscriptionId
path True
  • string

サブスクリプション ID です。

api-version
query True
  • string

API のバージョン。

応答

Name Type Description
200 OK

ロールで構成されているすべてのアドオンの一覧。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

RoleListAddOns

Sample Request

GET https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1/addons?api-version=2021-02-01

Sample Response

{
  "value": [
    {
      "properties": {
        "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
        "resourceGroupName": "testrg1",
        "resourceName": "testresource1",
        "resourceLocation": "EastUS",
        "version": "0.2.18",
        "hostPlatform": "Linux",
        "hostPlatformType": "KubernetesCluster",
        "provisioningState": "Created"
      },
      "kind": "ArcForKubernetes",
      "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
      "name": "arcName",
      "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
    }
  ]
}

定義

AddonList

Azure Stack Edge デバイス上のすべてのロールアドオンのコレクション。

AddonState

アドオンのプロビジョニング状態

ArcAddon

弧のアドオン。

AsymmetricEncryptedSecret

非対称キーペアを使用した暗号化を目的としたシークレットを表します。

Authentication

IoT デバイスの認証メカニズム。

CloudError

サービスからのエラー応答。

CloudErrorBody

サービスからのエラー応答。

createdByType

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

EncryptionAlgorithm

"Value" を暗号化するために使用されるアルゴリズム。

HostPlatformType

ランタイムがホストされているプラットフォーム。

IoTAddon

IoT アドオン。

IoTDeviceInfo

構成する IoT デバイス/IoT Edge デバイスのメタデータ。

PlatformType

Arc アドオンによってサポートされているホスト OS。

SymmetricKey

認証用の対称キー。

SystemData

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

AddonList

Azure Stack Edge デバイス上のすべてのロールアドオンのコレクション。

Name Type Description
nextLink
  • string

次の結果セットにリンクします。

value Addon[]:

値。

AddonState

アドオンのプロビジョニング状態

Name Type Description
Created
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Invalid
  • string
Reconfiguring
  • string
Updating
  • string

ArcAddon

弧のアドオン。

Name Type Description
id
  • string

オブジェクトを一意に識別するパス ID。

kind string:
  • ArcForKubernetes

アドオンの種類。

name
  • string

オブジェクト名。

properties.hostPlatform

Arc アドオンによってサポートされているホスト OS。

properties.hostPlatformType

ランタイムがホストされているプラットフォーム。

properties.provisioningState

アドオンのプロビジョニング状態

properties.resourceGroupName
  • string

Arc リソースグループ名

properties.resourceLocation
  • string

Arc リソースの場所

properties.resourceName
  • string

Arc リソース名

properties.subscriptionId
  • string

Arc リソースサブスクリプション Id

properties.version
  • string

Arc リソースバージョン

systemData

アドオンの種類

type
  • string

オブジェクトの階層型。

AsymmetricEncryptedSecret

非対称キーペアを使用した暗号化を目的としたシークレットを表します。

Name Type Description
encryptionAlgorithm

"Value" を暗号化するために使用されるアルゴリズム。

encryptionCertThumbprint
  • string

値を暗号化するために使用するサムプリント証明書 " " 。 値が暗号化されていない場合、null になります。

value
  • string

シークレットの値。

Authentication

IoT デバイスの認証メカニズム。

Name Type Description
symmetricKey

認証用の対称キー。

CloudError

サービスからのエラー応答。

Name Type Description
error

エラーの詳細です。

CloudErrorBody

サービスからのエラー応答。

Name Type Description
code
  • string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

details

エラーに関する追加情報の一覧。

message
  • string

エラーを説明するメッセージ。ユーザーインターフェイスに表示するのに適しています。

createdByType

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

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

EncryptionAlgorithm

"Value" を暗号化するために使用されるアルゴリズム。

Name Type Description
AES256
  • string
None
  • string
RSAES_PKCS1_v_1_5
  • string

HostPlatformType

ランタイムがホストされているプラットフォーム。

Name Type Description
KubernetesCluster
  • string
LinuxVM
  • string

IoTAddon

IoT アドオン。

Name Type Description
id
  • string

オブジェクトを一意に識別するパス ID。

kind string:
  • IotEdge

アドオンの種類。

name
  • string

オブジェクト名。

properties.hostPlatform

IoT アドオンによってサポートされるホスト OS。

properties.hostPlatformType

ランタイムがホストされているプラットフォーム。

properties.ioTDeviceDetails

アプライアンスを接続する必要がある IoT デバイスのメタデータ。

properties.ioTEdgeDeviceDetails

IoT アドオンを構成する必要がある IoT edge デバイス。

properties.provisioningState

アドオンのプロビジョニング状態

properties.version
  • string

アプライアンスで実行されている IoT のバージョン。

systemData

アドオンの種類

type
  • string

オブジェクトの階層型。

IoTDeviceInfo

構成する IoT デバイス/IoT Edge デバイスのメタデータ。

Name Type Description
authentication

暗号化された IoT デバイス/IoT edge デバイスの接続文字列。

deviceId
  • string

IoT デバイス/エッジデバイスの ID。

ioTHostHub
  • string

デバイスに関連付けられている IoT hub のホスト名。

ioTHostHubId
  • string

デバイスに関連付けられている IoT hub の Id。

PlatformType

Arc アドオンによってサポートされているホスト OS。

Name Type Description
Linux
  • string
Windows
  • string

SymmetricKey

認証用の対称キー。

Name Type Description
connectionString

対称キーに基づく接続文字列。

SystemData

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

Name Type Description
createdAt
  • string

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

createdBy
  • string

リソースを作成した id。

createdByType

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

lastModifiedAt
  • string

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

lastModifiedBy
  • string

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

lastModifiedByType

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