Shares - Create Or Update

Cria uma nova partilha ou atualiza uma parte existente no dispositivo.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}?api-version=2019-08-01

Parâmetros do URI

Name In Required Type Description
deviceName
path True
  • string

O nome do dispositivo.

name
path True
  • string

O nome da partilha.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

subscriptionId
path True
  • string

O ID da assinatura.

api-version
query True
  • string

A versão API.

Corpo do Pedido

Name Required Type Description
properties.accessProtocol True

Protocolo de acesso a ser usado pela partilha.

properties.monitoringStatus True

Estado atual de monitorização da parte.

properties.shareStatus True

Estado atual da parte.

properties.azureContainerInfo

Mapeamento de contentores Azure para a parte.

properties.clientAccessRights

Lista de endereços IP e direitos de acesso correspondentes sobre a partilha (necessária para o protocolo NFS).

properties.dataPolicy

Política de dados da parte.

properties.description
  • string

Descrição para a parte.

properties.refreshDetails

Detalhes do trabalho de atualização desta parte.

properties.userAccessRights

Mapeamento dos utilizadores e direitos de acesso correspondentes sobre a partilha (requerida para o protocolo SMB).

Respostas

Name Type Description
200 OK

Criou ou atualizou com sucesso a partilha.

202 Accepted

Aceitou o pedido de criação ou atualização da partilha.

Other Status Codes

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador.

Exemplos

SharePut

Sample Request

PUT https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare?api-version=2019-08-01
{
  "properties": {
    "description": "",
    "shareStatus": "Online",
    "monitoringStatus": "Enabled",
    "azureContainerInfo": {
      "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
      "containerName": "testContainerSMB",
      "dataFormat": "BlockBlob"
    },
    "accessProtocol": "SMB",
    "userAccessRights": [
      {
        "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
        "accessType": "Change"
      }
    ],
    "dataPolicy": "Cloud"
  }
}

Sample Response

{
  "properties": {
    "description": "",
    "shareStatus": "Online",
    "monitoringStatus": "Disabled",
    "azureContainerInfo": {
      "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
      "containerName": "testContainerSMB",
      "dataFormat": "BlockBlob"
    },
    "accessProtocol": "SMB",
    "userAccessRights": [
      {
        "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
        "accessType": "Change"
      }
    ],
    "clientAccessRights": [],
    "refreshDetails": {},
    "shareMappings": [],
    "dataPolicy": "Cloud"
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
  "name": "smbshare",
  "type": "dataBoxEdgeDevices/shares"
}

Definições

AzureContainerDataFormat

Formato de armazenamento utilizado para o ficheiro representado pela partilha.

AzureContainerInfo

Mapeamento do contentor Azure do ponto final.

ClientAccessRight

O mapeamento entre um determinado CLIENTE IP e o tipo de cliente de acesso tem na partilha NFS.

ClientPermissionType

Tipo de acesso a ser permitido para o cliente.

CloudError

Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

DataPolicy

Política de dados da parte.

MonitoringStatus

Estado atual de monitorização da parte.

MountPointMap

O ponto de montagem de partilha.

RefreshDetails

Campos para rastrear o trabalho de atualização na parte ou no recipiente.

RoleTypes

Tipo de função.

Share

Representa uma participação no dispositivo Data Box Edge/Gateway.

ShareAccessProtocol

Protocolo de acesso a ser usado pela partilha.

ShareAccessType

Tipo de acesso a ser permitido para o utilizador.

ShareStatus

Estado atual da parte.

UserAccessRight

O mapeamento entre um determinado utilizador e o tipo de acesso na partilha SMB.

AzureContainerDataFormat

Formato de armazenamento utilizado para o ficheiro representado pela partilha.

Name Type Description
AzureFile
  • string
BlockBlob
  • string
PageBlob
  • string

AzureContainerInfo

Mapeamento do contentor Azure do ponto final.

Name Type Description
containerName
  • string

Nome do recipiente (Com base no formato de dados especificado, isto representa o nome de Azure Files/Page blob/Block blob).

dataFormat

Formato de armazenamento utilizado para o ficheiro representado pela partilha.

storageAccountCredentialId
  • string

Identificação da credencial da conta de armazenamento usada para aceder ao armazenamento.

ClientAccessRight

O mapeamento entre um determinado CLIENTE IP e o tipo de cliente de acesso tem na partilha NFS.

Name Type Description
accessPermission

Tipo de acesso a ser permitido para o cliente.

client
  • string

IP do cliente.

ClientPermissionType

Tipo de acesso a ser permitido para o cliente.

Name Type Description
NoAccess
  • string
ReadOnly
  • string
ReadWrite
  • string

CloudError

Uma resposta de erro do serviço.

Name Type Description
error

Os detalhes do erro.

CloudErrorBody

Uma resposta de erro do serviço.

Name Type Description
code
  • string

Um identificador do erro. Os códigos são invariantes e destinam-se a ser consumidos programáticamente.

details

Uma lista de detalhes adicionais sobre o erro.

message
  • string

Uma mensagem que descreve o erro, destinada a ser exibida numa interface de utilizador.

DataPolicy

Política de dados da parte.

Name Type Description
Cloud
  • string
Local
  • string

MonitoringStatus

Estado atual de monitorização da parte.

Name Type Description
Disabled
  • string
Enabled
  • string

MountPointMap

O ponto de montagem de partilha.

Name Type Description
mountPoint
  • string

Ponto de montagem para a parte.

roleId
  • string

ID do papel para o qual a partilha é montada.

roleType

Tipo de função.

shareId
  • string

ID da parte montada para o papel VM.

RefreshDetails

Campos para rastrear o trabalho de atualização na parte ou no recipiente.

Name Type Description
errorManifestFile
  • string

Indica o caminho relativo do erro xml para a última atualização deste tipo de ação ou recipiente em particular, se houver. Isto pode ser um trabalho falhado ou um trabalho bem sucedido.

inProgressRefreshJobId
  • string

Se um trabalho de atualização estiver atualmente em curso nesta parte ou contentor, este campo indica o ID de recursos ARM desse trabalho. O campo está vazio se não houver trabalho em andamento.

lastCompletedRefreshJobTimeInUTC
  • string

Indica o tempo completo para a última atualização desta parte ou recipiente em particular, se houver. Isto pode ser um trabalho falhado ou um trabalho bem sucedido.

lastJob
  • string

Indica a identificação do último trabalho de atualização desta parte ou contentor em particular, se houver. Isto pode ser um trabalho falhado ou um trabalho bem sucedido.

RoleTypes

Tipo de função.

Name Type Description
ASA
  • string
Cognitive
  • string
Functions
  • string
IOT
  • string

Share

Representa uma participação no dispositivo Data Box Edge/Gateway.

Name Type Description
id
  • string

O iD do caminho que identifica o objeto de forma única.

name
  • string

O nome do objeto.

properties.accessProtocol

Protocolo de acesso a ser usado pela partilha.

properties.azureContainerInfo

Mapeamento de contentores Azure para a parte.

properties.clientAccessRights

Lista de endereços IP e direitos de acesso correspondentes sobre a partilha (necessária para o protocolo NFS).

properties.dataPolicy

Política de dados da parte.

properties.description
  • string

Descrição para a parte.

properties.monitoringStatus

Estado atual de monitorização da parte.

properties.refreshDetails

Detalhes do trabalho de atualização desta parte.

properties.shareMappings

Partilhe o ponto de montagem para o papel.

properties.shareStatus

Estado atual da parte.

properties.userAccessRights

Mapeamento dos utilizadores e direitos de acesso correspondentes sobre a partilha (requerida para o protocolo SMB).

type
  • string

O tipo hierárquico do objeto.

ShareAccessProtocol

Protocolo de acesso a ser usado pela partilha.

Name Type Description
NFS
  • string
SMB
  • string

ShareAccessType

Tipo de acesso a ser permitido para o utilizador.

Name Type Description
Change
  • string
Custom
  • string
Read
  • string

ShareStatus

Estado atual da parte.

Name Type Description
NeedsAttention
  • string
OK
  • string
Offline
  • string
Unknown
  • string
Updating
  • string

UserAccessRight

O mapeamento entre um determinado utilizador e o tipo de acesso na partilha SMB.

Name Type Description
accessType

Tipo de acesso a ser permitido para o utilizador.

userId
  • string

ID do utilizador (já existente no dispositivo).