Модуль azure.azcollection.azure_rm_storageshare — управление файловыми общими ресурсами Azure Storage
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 string | Уровень доступа определяет стоимость, а в некоторых случаях и производительность файлового общего ресурса. Если не указано, используется TransactionOptimized. Варианты:
|
account_name string / обязательный | Имя родительской учетной записи хранилища для файлового общего ресурса. |
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас собственный центр ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании прокси-сервера HTTPS или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | ID клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра авторизации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра авторизации с сайта https://login.microsoft.com/ для проверки центра авторизации. Если задать значение **True**, проверка центра авторизации отключается. Поэтому необходимо убедиться, что настроенный узел центра авторизации является действительным и заслуживающим доверия. Значение задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
enabled_protocols string | Протокол аутентификации, используемый для файлового общего ресурса. Можно указать только при создании общего ресурса. Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
metadata dictionary | Пара «имя — значение», связываемая с контейнером в качестве метаданных. |
name string / обязательный | Имя файлового общего ресурса хранилища, который нужно удалить или создать. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается на токен Azure AD с помощью федеративного удостоверения OIDC. Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только токен в исходном виде. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
quota integer | Максимальный размер файлового общего ресурса в гигабайтах. Должен быть больше 0 и не превышать 5 ТБ (5120). Для больших файловых общих ресурсов максимальный размер составляет 102400. По умолчанию — 102400. |
resource_group string / обязательный | Имя используемой группы ресурсов. |
root_squash string | Это свойство используется только для общего ресурса NFS. Значение по умолчанию — Варианты:
|
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
state string | Состояние файлового общего ресурса хранилища. Используйте «present» для создания или обновления файлового общего ресурса, а «absent» — для его удаления. Варианты:
|
subscription_id string | ID вашей подписки Azure. |
tenant string | ID клиента 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.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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 complex | Сведения о текущем состоянии файлового общего ресурса хранилища. Возвращается: всегда |
|
access_tier string |
Уровень доступа для указанного файлового общего ресурса Возвращается: всегда Пример: |
|
access_tier_change_time string |
Время последнего изменения уровня доступа файлового общего ресурса Возвращается: всегда Пример: |
|
etag string |
Тег Etag ресурса Возвращается: всегда Пример: |
|
id string |
ID ресурса файлового общего ресурса хранилища Возвращается: всегда Пример: |
|
last_modified_time string |
Возвращает дату и время последнего изменения файлового общего ресурса Возвращается: всегда Пример: |
|
metadata dictionary |
Пара «имя — значение», связываемая с файловым общим ресурсом в качестве метаданных Возвращается: всегда Пример: |
|
name string |
Имя файлового общего ресурса Возвращается: всегда Пример: |
|
share_quota integer |
Максимальный размер файлового общего ресурса в гигабайтах Возвращается: всегда Пример: |
|
type string |
Тип ресурса Возвращается: всегда Пример: |
Авторы
- Andrii Bilorus (@ewscat)
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_storageshare_module.html