azure_rm_storageaccount – Управление учетными записями хранения Azure
Новая версия с 2.1.
Описание
- Создание, обновление или удаление учетной записи хранения.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_tier - добавлен в 2.4 |
| Уровень доступа к хранилищу. Требуется для хранилища типа 'BlobStorage'. | |
| account_type - |
| Тип хранилища. Требуется при создании хранилища. ПРИМЕЧАНИЕ: типы хранилищ Standard_ZRS и Premium_LRS не могут быть изменены на другие типы, и другие типы не могут быть изменены на Standard_ZRS или Premium_LRS. псевдонимы: type | |
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала. | ||
| adfs_authority_url строка добавлен в 2.6 | URL-адрес авторитета Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS. | ||
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags булево |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. | |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная окружения ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto при отсутствии переменной.auto будет следовать умолчанию приоритетов параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials. При значении cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задано через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. msi был добавлен в Ansible 2.6. | |
| blob_cors список добавлен в 2.8 | Указывает правила 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 строка добавлен в 2.5 |
| Управляет поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно задать через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| cloud_environment строка добавлен в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки конечного доступа для обнаружения метаданных (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. | |
| custom_domain - | Домен пользователя, назначенный хранилищу. Должен быть словарем с ключами 'name' и 'use_sub_domain', где 'name' - исходный CNAME. В данный момент поддерживается только один пользовательский домен на хранилище. Для очистки существующего пользовательского домена используйте пустую строку для свойства имени пользовательского домена. Можно добавить к существующему хранилищу. Будет проигнорировано при создании хранилища. псевдонимы: custom_dns_domain_suffix | ||
| force_delete_nonempty булево |
| Попытка удаления, если ресурс уже существует и не может быть обновлен псевдонимы: force | |
| https_only булево добавлен в 2.8 |
| Разрешает только трафик https в службу хранения, если установлено в значение true. | |
| kind - добавлен в 2.2 |
| Тип хранилища. | |
| location - | Действительное расположение Azure. По умолчанию - расположение группы ресурсов. | ||
| name - | Имя хранилища для обновления или создания. | ||
| password - | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group - / обязательно | Имя группы ресурсов для использования. псевдонимы: resource_group_name | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| state - |
| Утверждение состояния хранилища. Используйте present для создания или обновления хранилища и absent для удаления хранилища. | |
| subscription_id string | Ваш идентификатор подписки Azure. | ||
| tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false. | ||
| tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала. | ||
Примечания
Примечание
- Для аутентификации с 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 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': 'Standard_RAGRS', 'custom_domain': None, 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/clh0003', 'location': 'eastus2', 'name': 'clh0003', 'primary_endpoints': {'blob': 'https://clh0003.blob.core.windows.net/', 'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/'}, 'primary_location': 'eastus2', 'provisioning_state': 'Succeeded', 'resource_group': 'Testing', 'secondary_endpoints': {'blob': 'https://clh0003-secondary.blob.core.windows.net/', 'queue': 'https://clh0003-secondary.queue.core.windows.net/', 'table': 'https://clh0003-secondary.table.core.windows.net/'}, 'secondary_location': 'centralus', 'status_of_primary': 'Available', 'status_of_secondary': 'Available', 'tags': None, 'type': 'Microsoft.Storage/storageAccounts'} |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_storageaccount_module.html
