Поделиться через


Microsoft.DataBoxEdge dataBoxEdgeDevices/shares 2021-02-01

Определение ресурсов Bicep

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

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

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

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

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

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

AzureContainerInfo

Имя Описание Ценность
имяКонтейнера Имя контейнера (в зависимости от указанного формата данных это имя файла Azure, страничного большого двоичного объекта или блочного большого двоичного объекта). строка (обязательно)
формат данных Формат хранилища, используемый для файла, представленного общим ресурсом. AzureFile
BlockBlob
PageBlob (обязательно)
storageAccountCredentialId Идентификатор учетных данных учетной записи хранения, используемых для доступа к хранилищу. строка (обязательно)

ClientAccessRight

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

Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares

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

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

RefreshDetails

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

ShareProperties

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

UserAccessRight

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

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

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

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

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

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

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

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

AzureContainerInfo

Имя Описание Ценность
имяКонтейнера Имя контейнера (в зависимости от указанного формата данных это имя файла Azure, страничного большого двоичного объекта или блочного большого двоичного объекта). строка (обязательно)
формат данных Формат хранилища, используемый для файла, представленного общим ресурсом. AzureFile
BlockBlob
PageBlob (обязательно)
storageAccountCredentialId Идентификатор учетных данных учетной записи хранения, используемых для доступа к хранилищу. строка (обязательно)

ClientAccessRight

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

Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares

Имя Описание Ценность
apiVersion Версия API '2021-02-01'
имя Имя ресурса строка (обязательно)
свойства Свойства общего ресурса. ShareProperties (обязательно)
тип Тип ресурса "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares"

RefreshDetails

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

ShareProperties

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

UserAccessRight

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

Примеры использования

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

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

  • групп ресурсов

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

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

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

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

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

AzureContainerInfo

Имя Описание Ценность
имяКонтейнера Имя контейнера (в зависимости от указанного формата данных это имя файла Azure, страничного большого двоичного объекта или блочного большого двоичного объекта). строка (обязательно)
формат данных Формат хранилища, используемый для файла, представленного общим ресурсом. AzureFile
BlockBlob
PageBlob (обязательно)
storageAccountCredentialId Идентификатор учетных данных учетной записи хранения, используемых для доступа к хранилищу. строка (обязательно)

ClientAccessRight

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

Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares

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

RefreshDetails

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

ShareProperties

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

UserAccessRight

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