Addons - List By Role

서비스:: Data Box Edge/Data Box Gateway

API 버전:: 2023-12-01

역할에 구성된 모든 애드온을 나열합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
deviceName	path	True	string	서버의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
roleName	path	True	string	역할의 이름입니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	AddonList	Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes	CloudError	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

RoleListAddOns

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

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

정의

Name	Description
AddonList	Azure Stack Edge 디바이스의 모든 역할 추가 기능 컬렉션입니다.
AddonState	애드온 프로비저닝 상태
AddonType	추가 기능 유형입니다.
ArcAddon	아크 애드온.
AsymmetricEncryptedSecret	비대칭 키 쌍을 사용하여 암호화하기 위한 비밀을 나타냅니다.
Authentication	IoT 장치에 대한 인증 메커니즘.
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
createdByType	리소스를 만든 ID의 형식입니다.
EncryptionAlgorithm	"값"을 암호화하는 데 사용되는 알고리즘입니다.
HostPlatformType	런타임이 호스팅되는 플랫폼입니다.
IoTAddon	IoT 애드온.
IoTDeviceInfo	구성할 IoT 디바이스/IoT Edge 디바이스의 메타데이터입니다.
PlatformType	Arc 애드온에서 지원하는 호스트 OS.
SymmetricKey	인증을 위한 대칭 키입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

AddonList

Object

Azure Stack Edge 디바이스의 모든 역할 추가 기능 컬렉션입니다.

Name	형식	Description
nextLink	string (uri)	항목의 다음 페이지에 대한 링크
value	Addon[]: ArcAddon[] IoTAddon[]	이 페이지의 추가 기능 항목

AddonState

열거형

애드온 프로비저닝 상태

값	Description
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

열거형

추가 기능 유형입니다.

값	Description
IotEdge
ArcForKubernetes

ArcAddon

Object

아크 애드온.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	추가 기능 유형입니다.
name	string	리소스의 이름
properties.hostPlatform	PlatformType	Arc 애드온에서 지원하는 호스트 OS.
properties.hostPlatformType	HostPlatformType	런타임이 호스팅되는 플랫폼입니다.
properties.provisioningState	AddonState	애드온 프로비저닝 상태
properties.resourceGroupName	string	Arc 리소스 그룹 이름
properties.resourceLocation	string	Arc 리소스 위치
properties.resourceName	string	Arc 리소스 이름
properties.subscriptionId	string	Arc 리소스 구독 ID
properties.version	string	Arc 리소스 버전
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Object

비대칭 키 쌍을 사용하여 암호화하기 위한 비밀을 나타냅니다.

Name	형식	Description
encryptionAlgorithm	EncryptionAlgorithm	"값"을 암호화하는 데 사용되는 알고리즘입니다.
encryptionCertThumbprint	string (password)	"값"을 암호화하는 데 사용되는 지문 인증서입니다. 값이 암호화되지 않은 경우 null이 됩니다.
value	string	비밀의 값입니다.

Authentication

Object

IoT 장치에 대한 인증 메커니즘.

Name	형식	Description
symmetricKey	SymmetricKey	인증을 위한 대칭 키입니다.

CloudError

Object

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	오류 세부 정보입니다.

CloudErrorBody

Object

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정적이며 프로그래밍 방식으로 사용할 수 있습니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

열거형

"값"을 암호화하는 데 사용되는 알고리즘입니다.

값	Description
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

열거형

런타임이 호스팅되는 플랫폼입니다.

값	Description
KubernetesCluster
LinuxVM

IoTAddon

Object

IoT 애드온.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	추가 기능 유형입니다.
name	string	리소스의 이름
properties.hostPlatform	PlatformType	IoT 애드온에서 지원하는 호스트 OS.
properties.hostPlatformType	HostPlatformType	런타임이 호스팅되는 플랫폼입니다.
properties.ioTDeviceDetails	IoTDeviceInfo	어플라이언스 연결이 필요한 IoT 디바이스 메타데이터입니다.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	IoT Addon을 구성해야 하는 IoT Edge 디바이스입니다.
properties.provisioningState	AddonState	애드온 프로비저닝 상태
properties.version	string	어플라이언스에서 실행되는 IoT 버전입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Object

구성할 IoT 디바이스/IoT Edge 디바이스의 메타데이터입니다.

Name	형식	Description
authentication	Authentication	암호화된 IoT 디바이스/IoT Edge 디바이스 연결 문자열입니다.
deviceId	string	IoT 디바이스/에지 디바이스의 ID입니다.
ioTHostHub	string	디바이스에 연결된 IoT Hub의 호스트 이름입니다.
ioTHostHubId	string	디바이스에 연결된 IoT Hub의 ID입니다.

PlatformType

열거형

Arc 애드온에서 지원하는 호스트 OS.

값	Description
Windows
Linux

SymmetricKey

Object

인증을 위한 대칭 키입니다.

Name	형식	Description
connectionString	AsymmetricEncryptedSecret	대칭 키를 기반으로 하는 연결 문자열입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

다음을 통해 공유

Addons - List By Role

URI 매개 변수

응답

보안

azure_auth

범위

예제

RoleListAddOns

샘플 요청

샘플 응답

정의

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData