Spec-Zone.ru › Ansible 2.5

azure_rm_storageaccount - Управление учетными записями Azure Storage.

Новая версия 2.1.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Обзор

  • Создание, обновление или удаление учетной записи хранилища.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_tier
(добавлено в 2.4)
    Варианты:
  • Hot
  • Cool
Значение по умолчанию:
Storage
Уровень доступа для этой учетной записи хранилища. Требуется для учетной записи хранилища типа 'BlobStorage'.
account_type
    Варианты:
  • Premium_LRS
  • Standard_GRS
  • Standard_LRS
  • Standard_RAGRS
  • Standard_ZRS
Значение по умолчанию:
None
Тип учетной записи хранилища. Требуется при создании учетной записи хранилища. ПРИМЕЧАНИЕ: учетные записи Standard_ZRS и Premium_LRS не могут быть изменены на другие типы учетных записей, и другие типы учетных записей не могут быть изменены на Standard_ZRS или Premium_LRS.

псевдонимы: type
ad_user Значение по умолчанию:
None
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала.
api_profile
(добавлено в 2.5)
    Варианты:
  • latest ←
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags Значение по умолчанию:
yes
Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
(добавлено в 2.5)
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
Управляет источником учетных данных для аутентификации.
auto будет следовать стандартному приоритету модульных параметров -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.
При установке cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.
Также может быть установлено через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE.
cert_validation_mode
(добавлено в 2.5)
    Варианты:
  • validate
  • ignore
Значение по умолчанию:
None
Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION.
client_id Значение по умолчанию:
None
Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment
(добавлено в 2.4)
Значение по умолчанию:
AzureCloud
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT.
custom_domain Значение по умолчанию:
None
Пользовательский домен, назначенный учетной записи хранилища. Должен быть словарем с ключами 'name' и 'use_sub_domain', где 'name' — источник CNAME. В настоящее время поддерживается только один пользовательский домен на одну учетную запись хранилища. Для очистки существующего пользовательского домена используйте пустую строку для свойства имени пользовательского домена.
Может быть добавлен к существующей учетной записи хранилища. Будет проигнорирован при создании учетной записи хранилища.
kind
(добавлено в 2.2)
    Варианты:
  • Storage ←
  • BlobStorage
Тип хранилища.
location Значение по умолчанию:
местоположение группы ресурсов
Действительное местоположение Azure. По умолчанию равно местоположению группы ресурсов.
name Значение по умолчанию:
None
Имя учетной записи хранилища для обновления или создания.
password Значение по умолчанию:
None
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
profile Значение по умолчанию:
None
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
требуется
Имя группы ресурсов для использования.

псевдонимы: resource_group_name
secret Значение по умолчанию:
None
Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала.
state
    Варианты:
  • absent
  • present ←
Утвердите состояние учетной записи хранилища. Используйте 'present' для создания или обновления учетной записи хранилища и 'absent' для удаления учетной записи.
subscription_id Значение по умолчанию:
None
Идентификатор вашей подписки Azure.
tags Значение по умолчанию:
None
Словарь пар строка:строка, которые нужно назначить в качестве метаданных объекту. Теги метаданных объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant Значение по умолчанию:
None
Идентификатор клиента 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
dict
всегда
Текущее состояние учетной записи хранилища.

Пример:
{'secondary_location': 'centralus', 'account_type': 'Standard_RAGRS', 'custom_domain': None, 'resource_group': 'Testing', 'tags': None, 'primary_location': 'eastus2', 'secondary_endpoints': {'queue': 'https://clh0003-secondary.queue.core.windows.net/', 'table': 'https://clh0003-secondary.table.core.windows.net/', 'blob': 'https://clh0003-secondary.blob.core.windows.net/'}, 'provisioning_state': 'Succeeded', 'primary_endpoints': {'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/', 'blob': 'https://clh0003.blob.core.windows.net/'}, 'location': 'eastus2', 'status_of_primary': 'Available', 'status_of_secondary': 'Available', 'type': 'Microsoft.Storage/storageAccounts', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/testing/providers/Microsoft.Storage/storageAccounts/clh0003', 'name': 'clh0003'}


Статус

Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

  • 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.5/modules/azure_rm_storageaccount_module.html

Spec-Zone.ru

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