Spec-Zone.ru › Ansible

azure.azcollection.azure_rm_storageshare модуль — Управление общим доступом к файлам хранилища Azure

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: azure.azcollection.azure_rm_storageshare.

Введено в azure.azcollection 1.8.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Создание, обновление или удаление общего доступа к файлам хранилища в существующем хранилище.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через Galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

access_tier

строка

Уровень доступа определяет цену и в некоторых случаях также производительность файлового общего ресурса. TransactionOptimized, если не задано.

Варианты:

  • "TransactionOptimized"
  • "Hot"
  • "Cool"
  • "Premium"

account_name

строка / обязательно

Имя родительской учетной записи хранилища для файлового общего ресурса хранилища.

ad_user

строка

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.

adfs_authority_url

строка

добавлен в azure.azcollection 0.0.1

URL-адрес службы Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.

api_profile

строка

добавлен в azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию latest, подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

Значение по умолчанию: "latest"

auth_source

строка

добавлен в azure.azcollection 0.0.1

Управляет источником учетных данных для аутентификации.

Также может быть задано через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE

При значении auto (по умолчанию) приоритет: параметры модуля -> env -> credential_file -> cli

При значении env, учетные данные будут считываться из переменных среды.

При значении credential_file, будет считываться профиль из ~/.azure/credentials

При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может быть использована для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli.

При значении msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.

msi был добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

quota

integer

Максимальный размер файлового хранилища в гигабайтах. Должен быть больше 0 и меньше или равен 5 ТБ (5120). Для больших файловых хранилищ максимальный размер составляет 102400. По умолчанию 102400

resource_group

string / обязательно

Имя группы ресурсов для использования.

root_squash

string

Свойство только для NFS-хранилища.

По умолчанию NoRootSquash.

Варианты:

  • "NoRootSquash"
  • "RootSquash"
  • "AllSquash"

secret

string

Секретный ключ Azure клиента. Используется при аутентификации со служебным принципалом.

state

string

Состояние файлового хранилища. Используйте ‘present’ для создания или обновления файлового хранилища и ‘absent’ для удаления хранилища.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

string

Ваш идентификатор подписки Azure.

tenant

string

Идентификатор Azure-аренды. Используется при аутентификации со служебным принципалом.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации со служебным принципалом.

Требуется, если определен x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к X509-сертификату, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используется при аутентификации со служебным принципалом.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед выполнением задач или книги задач с помощью az login.
  • Аутентификация также возможна с помощью служебного принципала или пользователя Active Directory.
  • Для аутентификации через служебного принципала передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы данные учетных данных могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход в Azure CLI

Как аутентифицироваться с помощью команды az login.

Примеры

---
- name: Create storage share
  azure_rm_storageshare:
    name: testShare
    resource_group: myResourceGroup
    account_name: testStorageAccount
    state: present
    access_tier: Cool
    quota: 2048
    metadata:
      key1: value1
      key2: value2

- name: Create share with enalbed protocols
  azure_rm_storageshare:
    name: "{{ share_name }}"
    resource_group: "{{ resource_group }}"
    account_name: "{{ storage_account }}"
    access_tier: "{{ access_tier }}"
    root_squash: RootSquash
    enabled_protocols: NFS

- name: Delete storage share
  azure_rm_storageshare:
    name: testShare
    resource_group: myResourceGroup
    account_name: testStorageAccount
    state: absent

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ

Описание

state

сложный

Информация о текущем состоянии хранилища файлов.

Возвращается: всегда

access_tier

строка

Уровень доступа для конкретного хранилища файлов

Возвращается: всегда

Пример: "TransactionOptimized"

access_tier_change_time

строка

Указывает последнее время изменения уровня доступа к хранилищу файлов

Возвращается: всегда

Пример: "2021-08-23T08:17:35+00:00"

etag

строка

Etag ресурса

Возвращается: всегда

Пример: "0x8D75E4BA3E275F1"

id

строка

Идентификатор ресурса хранилища файлов

Возвращается: всегда

Пример: "/subscriptions/9e700857-1631-4d8a-aed5-908520ede375/resourceGroups/myResourceGroup/providers/Microsoft.Storage/ storageAccounts/mystorageaccount/fileServices/default/shares/myshare"

last_modified_time

строка

Возвращает дату и время последнего изменения хранилища файлов

Возвращается: всегда

Пример: "2021-08-23T08:17:35+00:00"

metadata

словарь

Пара имя-значение для ассоциации с хранилищем файлов в качестве метаданных

Возвращается: всегда

Пример: {"key1": "value1"}

name

строка

Имя хранилища файлов

Возвращается: всегда

Пример: "myshare"

share_quota

целое число

Максимальный размер хранилища файлов в гигабайтах

Возвращается: всегда

Пример: 102400

type

строка

Тип ресурса

Возвращается: всегда

Пример: "Microsoft.Storage/storageAccounts/fileServices/shares"

Авторы

  • Andrii Bilorus (@ewscat)

Ссылки на коллекцию

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_storageshare_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API