Модуль azure.azcollection.azure_rm_storageaccount – Управление учетными записями Azure Storage
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в книге задач укажите: azure.azcollection.azure_rm_storageaccount.
Добавлена в azure.azcollection 0.1.0
Описание
- Создание, обновление или удаление учетной записи хранилища.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
access_tier строка | Уровень доступа для этой учетной записи хранилища. Требуется при kind=BlobStorage. Варианты:
|
account_type псевдонимы: тип строка | Тип учетной записи хранилища. Требуется при создании учетной записи хранилища.
Другие типы учетных записей не могут быть изменены на Варианты:
|
ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо принципала службы. |
adfs_authority_url строка добавлено в azure.azcollection 0.0.1 | URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
allow_blob_public_access логическое добавлено в azure.azcollection 1.1.0 | Разрешает контейнерам BLOB в учетной записи быть настроенными для анонимного публичного доступа. Если установлено в false, ни один контейнер в этой учетной записи не сможет разрешить анонимный публичный доступ. Если опущено, при создании новой учетной записи по умолчанию будет null, который в настоящее время интерпретируется как True. Существующие учетные записи не будут изменены. Варианты:
|
allow_cross_tenant_replication логическое | Разрешить или запретить репликацию объектов между клиентами AAD. Варианты:
|
логическое | Указывает, разрешает ли учетная запись хранилища запросы, авторизованные с помощью ключа доступа учетной записи через Общий ключ. Если false, все запросы, включая подписи общего доступа, должны быть авторизованы с помощью Azure Active Directory (Azure AD). Значение по умолчанию — null, что эквивалентно true. Варианты:
|
api_profile строка добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для использования при общении с Azure-службами. Значение по умолчанию По умолчанию: |
append_tags логическое | Управление полем тегов: канонический или просто добавляется к существующим тегам. При каноническом значении теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты:
|
auth_source строка добавлено в azure.azcollection 0.0.1 | Управление источником учетных данных для аутентификации. Также может быть задано через переменную среды При значении При значении При значении При значении При значении
Варианты:
|
blob_cors список / элементы=словарь | Определяет правила CORS для службы BLOB. Вы можете включить до пяти элементов CorsRule в запросе. Если элементы blob_cors не включены в список аргументов, ничего по поводу CORS не изменится. Если вы хотите удалить все правила CORS и отключить CORS для службы BLOB, явно задайте blob_cors=[]. |
|
allowed_headers список / элементы=строка / требуется |
Список заголовков, которые разрешено использовать в кросс-доменном запросе. |
|
allowed_methods список / элементы=строка / требуется |
Список HTTP-методов, которые разрешено использовать источнику. |
|
allowed_origins список / элементы=строка / требуется |
Список доменных имен источников, которые будут разрешены через CORS, или «*» для разрешения всех доменов. |
|
exposed_headers список / элементы=строка / обязательно |
Список заголовков ответов, которые нужно отобразить клиентам CORS. |
|
max_age_in_seconds целое число / обязательно |
Количество секунд, которое клиент/браузер должен кэшировать ответ предварительного запроса. |
cert_validation_mode строка добавлено в azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью Служебного принципа или управляемой идентичности (msi). Также может быть задано через переменную среды |
cloud_environment строка добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, По умолчанию: |
custom_domain псевдонимы: custom_dns_domain_suffix словарь | Пользовательский домен, назначенный учетной записи хранилища. Должен быть словарем с ключами name и use_sub_domain, где name — источник CNAME. В настоящее время поддерживается только один пользовательский домен на одну учетную запись хранилища. Для удаления существующего пользовательского домена используйте пустую строку для свойства имени пользовательского домена. Можно добавить в существующую учетную запись хранилища. Будет проигнорировано во время создания учетной записи хранилища. |
default_to_o_auth_authentication логическое значение | Флаг логического типа, указывающий, является ли стандартной аутентификацией OAuth или нет. По умолчанию для этого свойства значение false. Варианты:
|
disable_instance_discovery логическое значение добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляра, так и проверку полномочий. Эта функция предназначена для использования в сценариях, где конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает извлечение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что заданный хост полномочий действителен и заслуживает доверия. Устанавливается через профиль файла аутентификации или переменную среды Варианты:
|
enable_nfs_v3 логическое значение | Протокол NFS 3.0. Варианты:
|
encryption словарь | Настройки шифрования в учетной записи хранилища. |
|
key_source строка |
Источник ключа шифрования (провайдер). Варианты:
|
|
require_infrastructure_encryption логическое значение |
Логическое значение, указывающее, применяет ли служба дополнительный уровень шифрования с помощью управляемых платформой ключей для данных в состоянии покоя. Варианты:
|
|
services словарь |
Список служб, поддерживающих шифрование. |
|
blob словарь |
Функция шифрования службы хранения BLOB. |
|
enabled логическое значение |
Включено ли шифрование типа BLOB. Варианты:
|
|
file словарь |
Функция шифрования службы файлового хранения. |
|
enabled boolean |
Шифрование типа файлов. Выбор:
|
|
queue dictionary |
Функция шифрования службы хранилища очередей. |
|
enabled boolean |
Шифрование типа очередей. Выбор:
|
|
table dictionary |
Функция шифрования службы хранилища таблиц. |
|
enabled boolean |
Шифрование типа таблиц. Выбор:
|
force_delete_nonempty aliases: force boolean | Попытка удаления, если ресурс уже существует и не может быть обновлен. Выбор:
|
https_only boolean | Разрешает трафик только по протоколу HTTPS для службы хранения при установке в Если опущено, создание нового учетной записи будет по умолчанию True, в то время как существующие учетные записи не будут изменены. Выбор:
|
identity dictionary добавлен в azure.azcollection 2.7.0 | Идентификатор для этого ресурса. |
|
type string |
Тип управляемого идентификатора Выбор:
|
|
user_assigned_identity string |
Управляемый идентификатор, назначенный пользователю, связанный с этим ресурсом |
is_hns_enabled boolean | Включено Иерархическое пространство имен, если установлено в значение true. Когда is_hns_enabled=True, kind не может быть Выбор:
|
kind string | Тип хранилища.
Выбор:
|
string | Разрешить большие файловые хранилища, если установлено значение Enabled. Выбор:
|
location string | Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
minimum_tls_version string добавлен в azure.azcollection 1.0.0 | Минимально необходимая версия Transport Layer Security (TLS) для запросов к учетной записи хранилища. Если опущено, при создании новой учетной записи по умолчанию будет null, что в настоящее время интерпретируется как TLS1_0. Существующие учетные записи не будут изменены. Выбор:
|
name string / обязательно | Имя учетной записи хранилища для обновления или создания. |
network_acls dictionary | Управление настройками брандмауэра и виртуальных сетей учетной записи хранилища. |
|
bypass string |
Если default_action=Deny, это управляет тем, какие компоненты Azure по-прежнему могут получать доступ к хранилищу. Список разделен запятыми. Это может быть любая комбинация из примеров Если доступ к компонентам Azure не разрешен, явно установите bypass=””. По умолчанию: |
|
default_action string |
Правило по умолчанию для трафика брандмауэра. Если default_action=Allow, другие настройки не имеют эффекта. Варианты:
|
|
ip_rules list / elements=dictionary |
Список IP-адресов или диапазонов в формате CIDR. |
|
action string |
Единственный логичный action=Allow, так как эта настройка доступна только при default_action=Deny. По умолчанию: |
|
value string |
IP-адрес или диапазон. |
|
virtual_network_rules list / elements=dictionary |
Список подсетей и их действий. |
|
action string |
Единственный логичный action=Allow, так как эта настройка доступна только при default_action=Deny. По умолчанию: |
|
id string |
Полный путь к подсети. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо принципа службы. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
public_network_access string added in azure.azcollection 1.12.0 | Разрешить или запретить доступ к хранилищу по общедоступной сети. Варианты:
|
resource_group aliases: resource_group_name string / обязательно | Имя группы ресурсов для использования. |
secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью принципа службы. |
state string | Состояние хранилища. Используйте
Варианты:
|
static_website dictionary added in azure.azcollection 1.13.0 | Управление конфигурацией статического веб-сайта для хранилища. |
|
enabled boolean |
Указывает, размещает ли эта учетная запись статический веб-сайт. Варианты:
|
|
error_document404_path string |
Абсолютный путь к настраиваемой странице 404. |
|
index_document string |
Имя по умолчанию страницы индекса в каждой директории. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов. |
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: remove account, if it exists
azure_rm_storageaccount:
resource_group: myResourceGroup
name: clh0002
state: absent
- name: create an account
azure_rm_storageaccount:
resource_group: myResourceGroup
name: clh0002
type: Standard_RAGRS
tags:
testing: testing
delete: on-exit
- name: Create an account with kind of FileStorage
azure_rm_storageaccount:
resource_group: myResourceGroup
name: c1h0002
type: Premium_LRS
kind: FileStorage
tags:
testing: testing
- name: Create storage account with I(enable_nfs_v3=false)
azure_rm_storageaccount:
resource_group: myResourceGroup
name: c1h0002
account_type: Premium_LRS
kind: FileStorage
enable_nfs_v3: false
static_website:
enabled: true
- name: configure firewall and virtual networks
azure_rm_storageaccount:
resource_group: myResourceGroup
name: clh0002
type: Standard_RAGRS
network_acls:
bypass: AzureServices,Metrics
default_action: Deny
virtual_network_rules:
- id: /subscriptions/mySubscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet
action: Allow
ip_rules:
- value: 1.2.3.4
action: Allow
- value: 123.234.123.0/24
action: Allow
- name: create an account with blob CORS
azure_rm_storageaccount:
resource_group: myResourceGroup
name: clh002
type: Standard_RAGRS
blob_cors:
- allowed_origins:
- http://www.example.com/
allowed_methods:
- GET
- POST
allowed_headers:
- x-ms-meta-data*
- x-ms-meta-target*
- x-ms-meta-abc
exposed_headers:
- x-ms-meta-*
max_age_in_seconds: 200
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
state сложный | Текущее состояние хранилища. Возвращается: всегда |
|
account_type строка |
Тип хранилища. Возвращается: всегда Пример: |
|
allow_blob_public_access логическое |
Разрешено или запрещено общедоступное обращение ко всем объектам BLOB или контейнерам в хранилище. Возвращается: всегда Пример: |
|
allow_cross_tenant_replication логическое |
Разрешить или запретить репликацию объектов через разные аренды AAD. Возвращается: всегда Пример: |
|
логическое |
Указывает, разрешает ли хранилище запросы, авторизованные с помощью ключа доступа к учетной записи через общий ключ. Возвращается: всегда Пример: |
|
custom_domain сложный |
Пользовательский домен, назначенный хранилищу. Возвращается: всегда |
|
name строка |
Источник CNAME. Возвращается: всегда Пример: |
|
use_sub_domain логическое |
Использовать домен второго уровня. Возвращается: всегда Пример: |
|
default_to_o_auth_authentication логическое |
Флаг, указывающий, является ли стандартной авторизацией OAuth или нет. По умолчанию для этого свойства установлено значение false. Возвращается: всегда Пример: |
|
enable_nfs_v3 логическое |
Протокол NFS 3.0. Возвращается: всегда Пример: |
|
encryption сложный |
Настройки шифрования для хранилища. Возвращается: всегда |
|
key_source строка |
Источник ключа шифрования (поставщик). Возвращается: всегда Пример: |
|
require_infrastructure_encryption логическое |
Логическое значение, указывающее, применяет ли служба дополнительный уровень шифрования с управляемыми платформой ключами для данных в состоянии покоя. Возвращается: всегда Пример: |
|
services словарь |
Список служб, поддерживающих шифрование. Возвращается: всегда |
|
blob словарь |
Функция шифрования службы хранилища BLOB. Возвращается: всегда Пример: |
|
file словарь |
Функция шифрования службы хранилища файлов. Возвращается: всегда Пример: |
|
queue словарь |
Функция шифрования службы очередей. Возвращается: всегда Пример: |
|
table dictionary |
Функция шифрования службы табличного хранилища. Возвращается: всегда Пример: |
|
failover_in_progress boolean |
Статус, указывающий, что учетная запись хранилища в настоящее время переключается во вторичное местоположение. Возвращается: всегда Пример: |
|
https_only boolean |
Разрешает только трафик HTTPS для службы хранения, если установлен в Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
is_hns_enabled boolean |
Включено иерархическое пространство имен учетной записи, если установлено значение true. Возвращается: всегда Пример: |
|
string |
Разрешить большие файловые ресурсы, если установлено значение Включено. Возвращается: всегда Пример: |
|
location string |
Допустимое местоположение Azure. По умолчанию используется местоположение группы ресурсов. Возвращается: всегда Пример: |
|
minimum_tls_version string |
Минимальная версия TLS, разрешенная для запросов к хранилищу. Возвращается: всегда Пример: |
|
name string |
Имя учетной записи хранения для обновления или создания. Возвращается: всегда Пример: |
|
network_acls dictionary |
Набор правил брандмауэра и виртуальной сети Возвращается: всегда Пример: |
|
primary_endpoints dictionary |
URL-адреса для получения общедоступных объектов blob, queue или table из основного местоположения. Возвращается: всегда Пример: |
|
primary_location string |
Местоположение основного центра обработки данных для учетной записи хранения. Возвращается: всегда Пример: |
|
provisioning_state string |
Статус учетной записи хранения. Возможные значения включают Возвращается: всегда Пример: |
|
public_network_access string |
Общедоступный сетевой доступ к учетной записи хранения разрешен или запрещен. Возвращается: всегда Пример: |
|
resource_group string |
Имя группы ресурсов. Возвращается: всегда Пример: |
|
secondary_endpoints dictionary |
URL-адреса для получения общедоступных объектов blob, queue или table из вторичного местоположения. Возвращается: всегда Пример: |
|
secondary_location string |
Расположение вторичного геореплицированного ресурса для учетной записи хранилища. Возвращается: всегда Пример: |
|
static_website complex добавлено в azure.azcollection 1.13.0 |
Настройка статического веб-сайта для учетной записи хранилища. Возвращается: всегда |
|
enabled boolean |
Указывает, используется ли данная учетная запись для размещения статического веб-сайта. Возвращается: всегда Пример: |
|
error_document404_path string |
Полный путь к настраиваемой странице 404. Возвращается: всегда Пример: |
|
index_document string |
Имя по умолчанию страницы индекса в каждом каталоге. Возвращается: всегда Пример: |
|
status_of_primary string |
Состояние первичного расположения учетной записи хранилища; либо Возвращается: всегда Пример: |
|
status_of_secondary string |
Состояние вторичного расположения учетной записи хранилища; либо Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
|
type string |
Тип учетной записи хранилища. Возвращается: всегда Пример: |
Ссылки на сборку
© 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_storageaccount_module.html