Partager via


Microsoft.DataBoxEdge dataBoxEdgeDevices/shares 2021-02-01-preview

Définition de ressource Bicep

Le type de ressource dataBoxEdgeDevices/partages peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-02-01-preview' = {
  parent: resourceSymbolicName
  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'
      }
    ]
  }
}

Valeurs de propriété

AzureContainerInfo

Nom Description Valeur
containerName Nom du conteneur (basé sur le format de données spécifié, il représente le nom de l’objet blob Azure Files/Page/Objet blob de blocs). chaîne (obligatoire)
dataFormat Format de stockage utilisé pour le fichier représenté par le partage. 'AzureFile'
'BlockBlob'
'PageBlob' (obligatoire)
storageAccountCredentialId ID des informations d’identification du compte de stockage utilisées pour accéder au stockage. chaîne (obligatoire)

ClientAccessRight

Nom Description Valeur
accessPermission Type d’accès autorisé pour le client. 'NoAccess'
'ReadOnly'
'ReadWrite' (obligatoire)
client ADRESSE IP du client. chaîne (obligatoire)

Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.
Nom symbolique de la ressource de type : dataBoxEdgeDevices
Propriétés Propriétés de partage. ShareProperties (obligatoire)

RefreshDetails

Nom Description Valeur
errorManifestFile Indique le chemin relatif du code XML d’erreur pour le dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde
inProgressRefreshJobId Si un travail d’actualisation est actuellement en cours sur ce partage ou ce conteneur, ce champ indique l’ID de ressource ARM de ce travail. Le champ est vide si aucun travail n’est en cours. corde
lastCompletedRefreshJobTimeInUTC Indique l’heure de fin du dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde
lastJob Indique l’ID du dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde

ShareProperties

Nom Description Valeur
accessProtocol Protocole d’accès à utiliser par le partage. 'NFS'
'SMB' (obligatoire)
azureContainerInfo Mappage de conteneur Azure pour le partage. AzureContainerInfo
clientAccessRights Liste des adresses IP et droits d’accès correspondants sur le partage (requis pour le protocole NFS). ClientAccessRight[]
dataPolicy Stratégie de données du partage. 'Cloud'
'Local'
description Description du partage. corde
monitoringStatus État de surveillance actuel du partage. 'Désactivé'
'Enabled' (obligatoire)
refreshDetails Détails du travail d’actualisation sur ce partage. RefreshDetails
shareStatus État actuel du partage. 'NeedsAttention'
'Hors connexion'
'OK'
'Inconnu'
'Mise à jour' (obligatoire)
userAccessRights Mappage des utilisateurs et des droits d’accès correspondants sur le partage (requis pour le protocole SMB). UserAccessRight[]

UserAccessRight

Nom Description Valeur
accessType Type d’accès autorisé pour l’utilisateur. 'Modifier'
'Custom'
'Read' (obligatoire)
userId ID utilisateur (déjà existant dans l’appareil). chaîne (obligatoire)

Définition de ressource de modèle ARM

Le type de ressource dataBoxEdgeDevices/partages peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares",
  "apiVersion": "2021-02-01-preview",
  "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"
      }
    ]
  }
}

Valeurs de propriété

AzureContainerInfo

Nom Description Valeur
containerName Nom du conteneur (basé sur le format de données spécifié, il représente le nom de l’objet blob Azure Files/Page/Objet blob de blocs). chaîne (obligatoire)
dataFormat Format de stockage utilisé pour le fichier représenté par le partage. 'AzureFile'
'BlockBlob'
'PageBlob' (obligatoire)
storageAccountCredentialId ID des informations d’identification du compte de stockage utilisées pour accéder au stockage. chaîne (obligatoire)

ClientAccessRight

Nom Description Valeur
accessPermission Type d’accès autorisé pour le client. 'NoAccess'
'ReadOnly'
'ReadWrite' (obligatoire)
client ADRESSE IP du client. chaîne (obligatoire)

Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares

Nom Description Valeur
apiVersion Version de l’API '2021-02-01-preview'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de partage. ShareProperties (obligatoire)
type Type de ressource 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares'

RefreshDetails

Nom Description Valeur
errorManifestFile Indique le chemin relatif du code XML d’erreur pour le dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde
inProgressRefreshJobId Si un travail d’actualisation est actuellement en cours sur ce partage ou ce conteneur, ce champ indique l’ID de ressource ARM de ce travail. Le champ est vide si aucun travail n’est en cours. corde
lastCompletedRefreshJobTimeInUTC Indique l’heure de fin du dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde
lastJob Indique l’ID du dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde

ShareProperties

Nom Description Valeur
accessProtocol Protocole d’accès à utiliser par le partage. 'NFS'
'SMB' (obligatoire)
azureContainerInfo Mappage de conteneur Azure pour le partage. AzureContainerInfo
clientAccessRights Liste des adresses IP et droits d’accès correspondants sur le partage (requis pour le protocole NFS). ClientAccessRight[]
dataPolicy Stratégie de données du partage. 'Cloud'
'Local'
description Description du partage. corde
monitoringStatus État de surveillance actuel du partage. 'Désactivé'
'Enabled' (obligatoire)
refreshDetails Détails du travail d’actualisation sur ce partage. RefreshDetails
shareStatus État actuel du partage. 'NeedsAttention'
'Hors connexion'
'OK'
'Inconnu'
'Mise à jour' (obligatoire)
userAccessRights Mappage des utilisateurs et des droits d’accès correspondants sur le partage (requis pour le protocole SMB). UserAccessRight[]

UserAccessRight

Nom Description Valeur
accessType Type d’accès autorisé pour l’utilisateur. 'Modifier'
'Custom'
'Read' (obligatoire)
userId ID utilisateur (déjà existant dans l’appareil). chaîne (obligatoire)

Exemples d’utilisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource dataBoxEdgeDevices/partages peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-02-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
        }
      ]
    }
  }
}

Valeurs de propriété

AzureContainerInfo

Nom Description Valeur
containerName Nom du conteneur (basé sur le format de données spécifié, il représente le nom de l’objet blob Azure Files/Page/Objet blob de blocs). chaîne (obligatoire)
dataFormat Format de stockage utilisé pour le fichier représenté par le partage. 'AzureFile'
'BlockBlob'
'PageBlob' (obligatoire)
storageAccountCredentialId ID des informations d’identification du compte de stockage utilisées pour accéder au stockage. chaîne (obligatoire)

ClientAccessRight

Nom Description Valeur
accessPermission Type d’accès autorisé pour le client. 'NoAccess'
'ReadOnly'
'ReadWrite' (obligatoire)
client ADRESSE IP du client. chaîne (obligatoire)

Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : dataBoxEdgeDevices
Propriétés Propriétés de partage. ShareProperties (obligatoire)
type Type de ressource « Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-02-01-preview »

RefreshDetails

Nom Description Valeur
errorManifestFile Indique le chemin relatif du code XML d’erreur pour le dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde
inProgressRefreshJobId Si un travail d’actualisation est actuellement en cours sur ce partage ou ce conteneur, ce champ indique l’ID de ressource ARM de ce travail. Le champ est vide si aucun travail n’est en cours. corde
lastCompletedRefreshJobTimeInUTC Indique l’heure de fin du dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde
lastJob Indique l’ID du dernier travail d’actualisation sur ce partage ou conteneur particulier, le cas échéant. Il peut s’agir d’un travail ayant échoué ou d’un travail réussi. corde

ShareProperties

Nom Description Valeur
accessProtocol Protocole d’accès à utiliser par le partage. 'NFS'
'SMB' (obligatoire)
azureContainerInfo Mappage de conteneur Azure pour le partage. AzureContainerInfo
clientAccessRights Liste des adresses IP et droits d’accès correspondants sur le partage (requis pour le protocole NFS). ClientAccessRight[]
dataPolicy Stratégie de données du partage. 'Cloud'
'Local'
description Description du partage. corde
monitoringStatus État de surveillance actuel du partage. 'Désactivé'
'Enabled' (obligatoire)
refreshDetails Détails du travail d’actualisation sur ce partage. RefreshDetails
shareStatus État actuel du partage. 'NeedsAttention'
'Hors connexion'
'OK'
'Inconnu'
'Mise à jour' (obligatoire)
userAccessRights Mappage des utilisateurs et des droits d’accès correspondants sur le partage (requis pour le protocole SMB). UserAccessRight[]

UserAccessRight

Nom Description Valeur
accessType Type d’accès autorisé pour l’utilisateur. 'Modifier'
'Custom'
'Read' (obligatoire)
userId ID utilisateur (déjà existant dans l’appareil). chaîne (obligatoire)