Partilhar via

Microsoft.DataBoxEdge dataBoxEdgeDevices/shares 2022-03-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso dataBoxEdgeDevices/shares pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2022-03-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    accessProtocol: 'string'
    azureContainerInfo: {
      containerName: 'string'
      dataFormat: 'string'
      storageAccountCredentialId: 'string'
    }
    clientAccessRights: [
      {
        accessPermission: 'string'
        client: 'string'
      }
    ]
    dataPolicy: 'string'
    description: 'string'
    monitoringStatus: 'string'
    refreshDetails: {
      errorManifestFile: 'string'
      inProgressRefreshJobId: 'string'
      lastCompletedRefreshJobTimeInUTC: 'string'
      lastJob: 'string'
    }
    shareStatus: 'string'
    userAccessRights: [
      {
        accessType: 'string'
        userId: 'string'
      }
    ]
  }
}

Valores de propriedade

dataBoxEdgeDevices/shares

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: dataBoxEdgeDevices
propriedades As propriedades de partilha. ShareProperties (obrigatório)

ShareProperties

Nome Descrição Valor
accessProtocol Protocolo de acesso a utilizar pela partilha. 'NFS'
"SMB" (obrigatório)
azureContainerInfo Mapeamento de contentores do Azure para a partilha. AzureContainerInfo
clientAccessRights Lista de endereços IP e direitos de acesso correspondentes na partilha (necessário para o protocolo NFS). ClientAccessRight[]
dataPolicy Política de dados da partilha. 'Cloud'
"Local"
descrição Descrição da partilha. string
monitoringStatus Estado de monitorização atual da partilha. "Desativado"
"Ativado" (obrigatório)
refreshDetails Detalhes da tarefa de atualização nesta partilha. RefreshDetails
shareStatus Estado atual da partilha. "NeedsAttention"
'OK'
"Offline"
'Desconhecido'
"Atualizar" (obrigatório)
userAccessRights Mapeamento de utilizadores e direitos de acesso correspondentes na partilha (necessário para o protocolo SMB). UserAccessRight[]

AzureContainerInfo

Nome Descrição Valor
containerName Nome do contentor (com base no formato de dados especificado, representa o nome do blob de Ficheiros do Azure/Página/Blob de blocos). cadeia (obrigatório)
dataFormat Formato de armazenamento utilizado para o ficheiro representado pela partilha. "AzureFile"
"BlockBlob"
"PageBlob" (obrigatório)
storageAccountCredentialId ID da credencial da conta de armazenamento utilizada para aceder ao armazenamento. cadeia (obrigatório)

ClientAccessRight

Nome Descrição Valor
accessPermission Tipo de acesso a ser permitido para o cliente. "NoAccess"
"Só de Leitura"
"ReadWrite" (obrigatório)
client IP do cliente. cadeia (obrigatório)

RefreshDetails

Nome Descrição Valor
errorManifestFile Indica o caminho relativo do xml de erro para a última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou uma tarefa com êxito. string
inProgressRefreshJobId Se estiver atualmente em curso uma tarefa de atualização nesta partilha ou contentor, este campo indica o ID de recurso do ARM dessa tarefa. O campo está vazio se não existir nenhum trabalho em curso. string
lastCompletedRefreshJobTimeInUTC Indica a hora concluída para a última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou uma tarefa com êxito. string
último Trabalho Indica o ID da última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou uma tarefa com êxito. string

UserAccessRight

Nome Descrição Valor
accessType Tipo de acesso a ser permitido para o utilizador. "Alterar"
"Personalizado"
"Ler" (obrigatório)
userId ID de utilizador (já existente no dispositivo). cadeia (obrigatório)

Definição de recurso do modelo arm

O tipo de recurso dataBoxEdgeDevices/shares pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares",
  "apiVersion": "2022-03-01",
  "name": "string",
  "properties": {
    "accessProtocol": "string",
    "azureContainerInfo": {
      "containerName": "string",
      "dataFormat": "string",
      "storageAccountCredentialId": "string"
    },
    "clientAccessRights": [
      {
        "accessPermission": "string",
        "client": "string"
      }
    ],
    "dataPolicy": "string",
    "description": "string",
    "monitoringStatus": "string",
    "refreshDetails": {
      "errorManifestFile": "string",
      "inProgressRefreshJobId": "string",
      "lastCompletedRefreshJobTimeInUTC": "string",
      "lastJob": "string"
    },
    "shareStatus": "string",
    "userAccessRights": [
      {
        "accessType": "string",
        "userId": "string"
      }
    ]
  }
}

Valores de propriedade

dataBoxEdgeDevices/shares

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares"
apiVersion A versão da API de recursos '2022-03-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.		 cadeia (obrigatório)
propriedades As propriedades da partilha. ShareProperties (obrigatório)

ShareProperties

Nome Descrição Valor
accessProtocol Protocolo de acesso a utilizar pela partilha. 'NFS'
"SMB" (obrigatório)
azureContainerInfo Mapeamento de contentores do Azure para a partilha. AzureContainerInfo
clientAccessRights Lista de endereços IP e direitos de acesso correspondentes na partilha (necessário para o protocolo NFS). ClientAccessRight[]
dataPolicy Política de dados da partilha. "Cloud"
"Local"
descrição Descrição da partilha. string
monitoringStatus Estado de monitorização atual da partilha. "Desativado"
"Ativado" (obrigatório)
refreshDetails Detalhes da tarefa de atualização nesta partilha. RefreshDetails
shareStatus Estado atual da partilha. "NeedsAttention"
'OK'
"Offline"
"Desconhecido"
"A atualizar" (obrigatório)
userAccessRights Mapeamento de utilizadores e direitos de acesso correspondentes na partilha (necessário para o protocolo SMB). UserAccessRight[]

AzureContainerInfo

Nome Descrição Valor
containerName Nome do contentor (com base no formato de dados especificado, representa o nome do blob de Ficheiros do Azure/Página/Blob de blocos). cadeia (obrigatório)
dataFormat Formato de armazenamento utilizado para o ficheiro representado pela partilha. "AzureFile"
"BlockBlob"
"PageBlob" (obrigatório)
storageAccountCredentialId ID da credencial da conta de armazenamento utilizada para aceder ao armazenamento. cadeia (obrigatório)

ClientAccessRight

Nome Descrição Valor
accessPermission Tipo de acesso a ser permitido para o cliente. "NoAccess"
'ReadOnly'
"ReadWrite" (obrigatório)
client IP do cliente. cadeia (obrigatório)

RefreshDetails

Nome Descrição Valor
errorManifestFile Indica o caminho relativo do erro xml para a última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou um trabalho com êxito. string
inProgressRefreshJobId Se uma tarefa de atualização estiver atualmente em curso nesta partilha ou contentor, este campo indica o ID de recurso do ARM dessa tarefa. O campo está vazio se não existir nenhuma tarefa em curso. string
lastCompletedRefreshJobTimeInUTC Indica a hora concluída para a última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou um trabalho com êxito. string
lastJob Indica o ID da última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou um trabalho com êxito. string

UserAccessRight

Nome Descrição Valor
accessType Tipo de acesso a ser permitido para o utilizador. "Alterar"
"Personalizado"
"Leitura" (obrigatório)
userId ID de utilizador (já existente no dispositivo). cadeia (obrigatório)

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso dataBoxEdgeDevices/shares pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2022-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      accessProtocol = "string"
      azureContainerInfo = {
        containerName = "string"
        dataFormat = "string"
        storageAccountCredentialId = "string"
      }
      clientAccessRights = [
        {
          accessPermission = "string"
          client = "string"
        }
      ]
      dataPolicy = "string"
      description = "string"
      monitoringStatus = "string"
      refreshDetails = {
        errorManifestFile = "string"
        inProgressRefreshJobId = "string"
        lastCompletedRefreshJobTimeInUTC = "string"
        lastJob = "string"
      }
      shareStatus = "string"
      userAccessRights = [
        {
          accessType = "string"
          userId = "string"
        }
      ]
    }
  })
}

Valores de propriedade

dataBoxEdgeDevices/shares

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2022-03-01"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID para recurso do tipo: dataBoxEdgeDevices
propriedades As propriedades de partilha. ShareProperties (obrigatório)

ShareProperties

Nome Descrição Valor
accessProtocol Protocolo de acesso a utilizar pela partilha. "NFS"
"SMB" (obrigatório)
azureContainerInfo Mapeamento de contentores do Azure para a partilha. AzureContainerInfo
clientAccessRights Lista de endereços IP e direitos de acesso correspondentes na partilha (necessário para o protocolo NFS). ClientAccessRight[]
dataPolicy Política de dados da partilha. "Cloud"
"Local"
descrição Descrição da partilha. string
monitoringStatus Estado de monitorização atual da partilha. "Desativado"
"Ativado" (obrigatório)
refreshDetails Detalhes da tarefa de atualização nesta partilha. RefreshDetails
shareStatus Estado atual da partilha. "NeedsAttention"
"OK"
"Offline"
"Desconhecido"
"A atualizar" (obrigatório)
userAccessRights Mapeamento de utilizadores e direitos de acesso correspondentes na partilha (necessário para o protocolo SMB). UserAccessRight[]

AzureContainerInfo

Nome Descrição Valor
containerName Nome do contentor (com base no formato de dados especificado, representa o nome de Ficheiros do Azure/Blob de páginas/Blob de blocos). cadeia (obrigatório)
dataFormat Formato de armazenamento utilizado para o ficheiro representado pela partilha. "AzureFile"
"BlockBlob"
"PageBlob" (obrigatório)
storageAccountCredentialId ID da credencial da conta de armazenamento utilizada para aceder ao armazenamento. cadeia (obrigatório)

ClientAccessRight

Nome Descrição Valor
accessPermission Tipo de acesso a ser permitido para o cliente. "NoAccess"
"Só de Leitura"
"ReadWrite" (obrigatório)
client IP do cliente. cadeia (obrigatório)

RefreshDetails

Nome Descrição Valor
errorManifestFile Indica o caminho relativo do xml de erro para a última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou uma tarefa com êxito. string
inProgressRefreshJobId Se estiver atualmente em curso uma tarefa de atualização nesta partilha ou contentor, este campo indica o ID de recurso do ARM dessa tarefa. O campo está vazio se não existir nenhum trabalho em curso. string
lastCompletedRefreshJobTimeInUTC Indica a hora concluída para a última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou uma tarefa com êxito. string
último Trabalho Indica o ID da última tarefa de atualização nesta partilha ou contentor específico, se existir. Pode ser uma tarefa falhada ou uma tarefa com êxito. string

UserAccessRight

Nome Descrição Valor
accessType Tipo de acesso a ser permitido para o utilizador. "Alterar"
"Personalizado"
"Ler" (obrigatório)
userId ID de utilizador (já existente no dispositivo). cadeia (obrigatório)