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 | Значение по умолчанию: null | URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS. |
| api_profile - добавлено в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags boolean |
| Управление тем, является ли поле тегов каноническим или оно просто добавляет к существующим тегам. Если каноническое, все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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. |
| 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. В настоящее время поддерживается только один пользовательский домен на одну учетную запись хранения. Для удаления существующего пользовательского домена используйте пустую строку для свойства имени пользовательского домена. Можно добавить к существующей учетной записи хранения. Будет проигнорировано при создании учетной записи хранения. | |
| force boolean |
| Попытка удаления, если ресурс уже существует и не может быть обновлён. |
| 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 - | Ваш идентификатор подписки Azure. | |
| tags - | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |
| tenant - | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с Azure можно передать параметры, установить переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью служебного принципала или пользователя 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 в среде.
Примеры
- name: remove account, if it exists
azure_rm_storageaccount:
resource_group: Testing
name: clh0002
state: absent
- name: create an account
azure_rm_storageaccount:
resource_group: Testing
name: clh0002
type: Standard_RAGRS
tags:
testing: testing
delete: on-exit
Значения возврата
Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| state словарь | всегда | Текущее состояние хранилища данных. Пример: {'account_type': 'Standard_RAGRS', 'custom_domain': None, 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/testing/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. [сертифицировано]
Авторы
- 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.7/modules/azure_rm_storageaccount_module.html