Addons - List By Role

Serviço:: Data Box Edge/Data Box Gateway

Versão da API:: 2023-12-01

Lista todos os complementos configurados na função.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
deviceName	path	True	string	O nome do dispositivo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
roleName	path	True	string	O nome da função.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	AddonList	A operação do Azure foi concluída com êxito.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

RoleListAddOns

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
      }
    }
  ]
}

Definições

Nome	Description
AddonList	Coleção de todo o complemento de função no dispositivo Azure Stack Edge.
AddonState	Estado de provisionamento de complementos
AddonType	Tipo de complemento.
ArcAddon	Complemento Arc.
AsymmetricEncryptedSecret	Representam os segredos destinados à criptografia com par de chaves assimétricas.
Authentication	Mecanismo de autenticação para dispositivos IoT.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
createdByType	O tipo de identidade que criou o recurso.
EncryptionAlgorithm	O algoritmo usado para criptografar "Valor".
HostPlatformType	Plataforma em que o runtime está hospedado.
IoTAddon	Complemento IoT.
IoTDeviceInfo	Metadados do dispositivo IoT/dispositivo IoT Edge a serem configurados.
PlatformType	Sistema operacional host suportado pelo complemento Arc.
SymmetricKey	Chave simétrica para autenticação.
systemData	Metadados relativos à criação e última modificação do recurso.

AddonList

Objeto

Coleção de todo o complemento de função no dispositivo Azure Stack Edge.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Addon[]: ArcAddon[] IoTAddon[]	Os itens do Addon nesta página

AddonState

Enumeração

Estado de provisionamento de complementos

Valor	Description
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Enumeração

Tipo de complemento.

Valor	Description
IotEdge
ArcForKubernetes

ArcAddon

Objeto

Complemento Arc.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Tipo de complemento.
name	string	O nome do recurso
properties.hostPlatform	PlatformType	Sistema operacional host suportado pelo complemento Arc.
properties.hostPlatformType	HostPlatformType	Plataforma em que o runtime está hospedado.
properties.provisioningState	AddonState	Estado de provisionamento de complementos
properties.resourceGroupName	string	Nome do grupo de recursos do Arc
properties.resourceLocation	string	Localização do recurso arc
properties.resourceName	string	Nome do recurso Arc
properties.subscriptionId	string	ID da assinatura de recurso do Arc
properties.version	string	Versão do recurso do Arc
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Objeto

Representam os segredos destinados à criptografia com par de chaves assimétricas.

Nome	Tipo	Description
encryptionAlgorithm	EncryptionAlgorithm	O algoritmo usado para criptografar "Valor".
encryptionCertThumbprint	string (password)	Certificado de impressão digital usado para criptografar "Valor". Se o valor não for criptografado, ele será nulo.
value	string	O valor do segredo.

Authentication

Objeto

Mecanismo de autenticação para dispositivos IoT.

Nome	Tipo	Description
symmetricKey	SymmetricKey	Chave simétrica para autenticação.

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Os detalhes do erro.

CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Enumeração

O algoritmo usado para criptografar "Valor".

Valor	Description
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Enumeração

Plataforma em que o runtime está hospedado.

Valor	Description
KubernetesCluster
LinuxVM

IoTAddon

Objeto

Complemento IoT.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Tipo de complemento.
name	string	O nome do recurso
properties.hostPlatform	PlatformType	Sistema operacional host compatível com o complemento IoT.
properties.hostPlatformType	HostPlatformType	Plataforma em que o runtime está hospedado.
properties.ioTDeviceDetails	IoTDeviceInfo	Metadados do dispositivo IoT aos quais o dispositivo precisa ser conectado.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	Dispositivo de borda IoT para o qual o Addon IoT precisa ser configurado.
properties.provisioningState	AddonState	Estado de provisionamento de complementos
properties.version	string	Versão da IoT em execução no dispositivo.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Objeto

Metadados do dispositivo IoT/dispositivo IoT Edge a serem configurados.

Nome	Tipo	Description
authentication	Authentication	Cadeia de conexão de dispositivo IoT/IoT edge criptografada.
deviceId	string	ID do dispositivo IoT/dispositivo de borda.
ioTHostHub	string	Nome do host para o hub IoT associado ao dispositivo.
ioTHostHubId	string	ID do hub IoT associado ao dispositivo.

PlatformType

Enumeração

Sistema operacional host suportado pelo complemento Arc.

Valor	Description
Windows
Linux

SymmetricKey

Objeto

Chave simétrica para autenticação.

Nome	Tipo	Description
connectionString	AsymmetricEncryptedSecret	Cadeia de conexão com base na chave simétrica.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Addons - List By Role

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

RoleListAddOns

Solicitação de exemplo

Resposta de exemplo

Definições

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData