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

Определение ресурса Bicep

Тип ресурса dataBoxEdgeDevices/shares можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, добавьте следующий Bicep в шаблон.

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

Значения свойств

dataBoxEdgeDevices/shares

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.
string (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа : dataBoxEdgeDevices
properties Свойства общего ресурса. ShareProperties (обязательно)

Свойства ShareProperties

Имя Описание Значение
accessProtocol Протокол доступа, используемый общей папкой. 'NFS'
"SMB" (обязательно)
azureContainerInfo Сопоставление контейнеров Azure для общей папки. AzureContainerInfo
clientAccessRights Список IP-адресов и соответствующих прав доступа к общей папке (требуется для протокола NFS). ClientAccessRight[]
dataPolicy Политика данных общего ресурса. "Облако"
"Локальный"
description Описание общего ресурса. строка
monitoringStatus Текущее состояние мониторинга общего ресурса. "Отключено"
"Включено" (обязательно)
refreshDetails Сведения о задании обновления в этой общей папке. RefreshDetails
shareStatus Текущее состояние общей папки. 'NeedsAttention'
'ОК'
"Вне сети"
"Неизвестно"
"Обновление" (обязательно)
userAccessRights Сопоставление пользователей и соответствующих прав доступа к общей папке (требуется для протокола SMB). UserAccessRight[]

AzureContainerInfo

Имя Описание Значение
containerName Имя контейнера (в зависимости от указанного формата данных оно представляет имя Файлы Azure/страничного BLOB-объекта/блочного BLOB-объекта). string (обязательно)
dataFormat Формат хранилища, используемый для файла, представленного общим ресурсом. AzureFile
'BlockBlob'
PageBlob (обязательно)
storageAccountCredentialId Идентификатор учетных данных учетной записи хранения, используемых для доступа к хранилищу. string (обязательно)

ClientAccessRight

Имя Описание Значение
accessPermission Тип доступа, разрешенного для клиента. NoAccess
ReadOnly
ReadWrite (обязательно)
клиент IP-адрес клиента. строка (обязательно)

RefreshDetails

Имя Описание Значение
errorManifestFile Указывает относительный путь XML-файла ошибки для последнего задания обновления в этой конкретной общей папке или контейнере, если таковые имеются. Это может быть неудачное задание или успешное задание. строка
inProgressRefreshJobId Если задание обновления в данный момент выполняется в этой общей папке или контейнере, в этом поле указывается идентификатор ресурса ARM этого задания. Поле пусто, если задание не выполняется. строка
lastCompletedRefreshJobTimeInUTC Указывает время завершения последнего задания обновления в этой конкретной общей папке или контейнере, если таковые имеются. Это может быть неудачное задание или успешное задание. строка
lastJob Указывает идентификатор последнего задания обновления в этой конкретной общей папке или контейнере, если таковой есть. Это может быть неудачное задание или успешное задание. строка

UserAccessRight

Имя Описание Значение
accessType Тип доступа, который будет разрешен пользователю. "Изменить"
"Пользовательский"
Read (обязательно)
userId Идентификатор пользователя (уже существующий на устройстве). строка (обязательно)

Определение ресурса шаблона ARM

Тип ресурса dataBoxEdgeDevices/shares можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, добавьте следующий код JSON в шаблон.

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

Значения свойств

dataBoxEdgeDevices/shares

Имя Описание Значение
тип Тип ресурса Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares
версия_API Версия API ресурсов '2021-06-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
строка (обязательно)
properties Свойства общего ресурса. ShareProperties (обязательно)

ShareProperties

Имя Описание Значение
accessProtocol Протокол доступа, используемый в общей папке. "NFS"
SMB (обязательно)
azureContainerInfo Сопоставление контейнеров Azure для общей папки. AzureContainerInfo
clientAccessRights Список IP-адресов и соответствующих прав доступа к общей папке (требуется для протокола NFS). ClientAccessRight[]
dataPolicy Политика данных общей папки. "Облако"
"Локальный"
description Описание общей папки. строка
monitoringStatus Текущее состояние мониторинга общей папки. "Отключено"
"Включено" (обязательно)
refreshDetails Сведения о задании обновления в этой общей папке. RefreshDetails
shareStatus Текущее состояние общей папки. "NeedsAttention"
'ОК'
"Вне сети"
"Неизвестно"
"Обновление" (обязательно)
userAccessRights Сопоставление пользователей и соответствующих прав доступа к общей папке (требуется для протокола SMB). UserAccessRight[]

AzureContainerInfo

Имя Описание Значение
containerName Имя контейнера (в зависимости от указанного формата данных представляет имя Файлы Azure/страничного BLOB-объекта/блочного BLOB-объекта). строка (обязательно)
dataFormat Формат хранилища, используемый для файла, представленного общей папкой. AzureFile
BlockBlob
PageBlob (обязательно)
storageAccountCredentialId Идентификатор учетных данных учетной записи хранения, используемых для доступа к хранилищу. строка (обязательно)

ClientAccessRight

Имя Описание Значение
accessPermission Тип доступа, разрешенного для клиента. NoAccess
ReadOnly
ReadWrite (обязательно)
клиент IP-адрес клиента. строка (обязательно)

RefreshDetails

Имя Описание Значение
errorManifestFile Указывает относительный путь XML-файла ошибки для последнего задания обновления в этой конкретной общей папке или контейнере, если таковые имеются. Это может быть неудачное задание или успешное задание. строка
inProgressRefreshJobId Если задание обновления в данный момент выполняется в этой общей папке или контейнере, в этом поле указывается идентификатор ресурса ARM этого задания. Поле пусто, если задание не выполняется. строка
lastCompletedRefreshJobTimeInUTC Указывает время завершения последнего задания обновления в этой конкретной общей папке или контейнере, если таковые имеются. Это может быть неудачное задание или успешное задание. строка
lastJob Указывает идентификатор последнего задания обновления в этой конкретной общей папке или контейнере, если таковой есть. Это может быть неудачное задание или успешное задание. строка

UserAccessRight

Имя Описание Значение
accessType Тип доступа, который будет разрешен пользователю. "Изменить"
"Пользовательский"
Read (обязательно)
userId Идентификатор пользователя (уже существующий на устройстве). строка (обязательно)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса dataBoxEdgeDevices/shares можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-06-01-preview"
  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"
        }
      ]
    }
  })
}

Значения свойств

dataBoxEdgeDevices/shares

Имя Описание Значение
тип Тип ресурса "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-06-01-preview"
name имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: dataBoxEdgeDevices
properties Свойства общего ресурса. ShareProperties (обязательно)

ShareProperties

Имя Описание Значение
accessProtocol Протокол доступа, используемый в общей папке. "NFS"
"SMB" (обязательно)
azureContainerInfo Сопоставление контейнеров Azure для общей папки. AzureContainerInfo
clientAccessRights Список IP-адресов и соответствующих прав доступа к общей папке (требуется для протокола NFS). ClientAccessRight[]
dataPolicy Политика данных общей папки. "Облако"
"Local"
description Описание общей папки. строка
monitoringStatus Текущее состояние мониторинга общей папки. "Отключено"
"Enabled" (обязательно)
refreshDetails Сведения о задании обновления в этой общей папке. RefreshDetails
shareStatus Текущее состояние общей папки. "NeedsAttention"
"ОК"
"Вне сети"
"Неизвестно"
"Обновление" (обязательно)
userAccessRights Сопоставление пользователей и соответствующих прав доступа к общей папке (требуется для протокола SMB). UserAccessRight[]

AzureContainerInfo

Имя Описание Значение
containerName Имя контейнера (в зависимости от указанного формата данных представляет имя Файлы Azure/страничного BLOB-объекта/блочного BLOB-объекта). строка (обязательно)
dataFormat Формат хранилища, используемый для файла, представленного общей папкой. AzureFile
"BlockBlob"
PageBlob (обязательно)
storageAccountCredentialId Идентификатор учетных данных учетной записи хранения, используемых для доступа к хранилищу. строка (обязательно)

ClientAccessRight

Имя Описание Значение
accessPermission Тип доступа, разрешенного для клиента. "NoAccess"
"ReadOnly"
ReadWrite (обязательно)
клиент IP-адрес клиента. строка (обязательно)

RefreshDetails

Имя Описание Значение
errorManifestFile Указывает относительный путь XML-файла ошибки для последнего задания обновления в этой конкретной общей папке или контейнере, если таковые имеются. Это может быть неудачное задание или успешное задание. строка
inProgressRefreshJobId Если задание обновления в данный момент выполняется в этой общей папке или контейнере, в этом поле указывается идентификатор ресурса ARM этого задания. Поле пусто, если задание не выполняется. строка
lastCompletedRefreshJobTimeInUTC Указывает время завершения последнего задания обновления в этой конкретной общей папке или контейнере, если таковые имеются. Это может быть неудачное задание или успешное задание. строка
lastJob Указывает идентификатор последнего задания обновления в этой конкретной общей папке или контейнере, если таковой есть. Это может быть неудачное задание или успешное задание. строка

UserAccessRight

Имя Описание Значение
accessType Тип доступа, который будет разрешен пользователю. "Изменить"
"Custom"
"Чтение" (обязательно)
userId Идентификатор пользователя (уже существующий на устройстве). строка (обязательно)