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

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_storageaccount.

Введено в версии 0.1.0: из azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
access_tier строка				Варианты: Hot Cool	Уровень доступа к хранилищу. Требуется при kind=BlobStorage.
account_type строка				Варианты: Premium_LRS Standard_GRS Standard_LRS Standard_RAGRS Standard_ZRS Premium_ZRS	Тип учетной записи хранилища. Требуется при создании учетной записи хранилища. `Standard_ZRS` и `Premium_LRS` учетные записи не могут быть изменены на другие типы учетных записей. Другие типы учетных записей не могут быть изменены на `Standard_ZRS` или `Premium_LRS`. псевдонимы: тип
ad_user строка					Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным сервисом.
adfs_authority_url строка добавлено в 0.0.1 azure.azcollection					URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
allow_blob_public_access логическое добавлено в 1.1.0 azure.azcollection				Варианты: нет да	Разрешает контейнерам BLOB в учетной записи быть доступными для анонимного общего доступа. Если установлено значение false, никакие контейнеры в этой учетной записи не смогут разрешить анонимный общий доступ. Значение по умолчанию — `True`.
api_profile строка добавлено в 0.0.1 azure.azcollection				Значение по умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое				Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом поле тегов все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 azure.azcollection				Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (значение по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных среды. При значении `credential_file`, профиль будет считан из `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько; иначе используется подписка az cli по умолчанию. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; иначе выбирается первая подписка. `msi` добавлено в Ansible 2.6.
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 строка добавлено в 0.0.1 azure.azcollection				Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-узлов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано в профиле файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка					Идентификатор клиента Azure. Используется при аутентификации с помощью главного сервиса.
cloud_environment строка добавлено в 0.0.1 azure.azcollection				Значение по умолчанию: "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 логическое				Варианты: нет да	Разрешает только HTTPS-трафик для службы хранилища при значении `true`. Разрешает обновление свойства учетной записи хранилища при значении `False`. Значение по умолчанию — `False`.
kind строка				Варианты: Хранилище ← StorageV2 BlobStorage BlockBlobStorage FileStorage	Тип хранилища. `FileStorage` и (BlockBlobStorage) используются только при account_type=Premium_LRS.
location строка					Действительное расположение Azure. По умолчанию — расположение группы ресурсов.
minimum_tls_version строка добавлено в 1.0.0 azure.azcollection				Варианты: TLS1_0 TLS1_1 TLS1_2	Минимальная требуемая версия Transport Layer Security (TLS) для запросов к учетной записи хранилища. Значение по умолчанию — `TLS1_0`.
name строка					Имя учетной записи хранилища для обновления или создания.
network_acls словарь					Управляет настройками брандмауэра и виртуальных сетей учетной записи хранилища.
	bypass строка			Значение по умолчанию: "AzureServices"	При default_action=Deny это управляет тем, какие компоненты Azure все еще могут обращаться к учетной записи хранилища. Список разделен запятыми. Может быть любой комбинацией примеров `AzureServices`, `Logging`, `Metrics`. Если разрешено обращение ни от какого Azure-компонента, явно задайте bypass="".
		ip_rules строка			Список IP-адресов или диапазонов в формате CIDR.
			action строка	Значение по умолчанию: "Allow"	Единственное логическое действие action=Allow, так как эта настройка доступна только при default_action=Deny.
			value строка		IP-адрес или диапазон.
		virtual_network_rules строка			Список подсетей и их действий.

		action string	Default: "Allow"	Единственное логическое значение action=Allow, так как это свойство доступно только когда default_action=Deny.
		id string		Полный путь к подсети.
	default_action string		Choices: Allow ← Deny	Правило по умолчанию для трафика брандмауэра. Если default_action=Allow, другие настройки не имеют эффекта.
password string				Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile string				Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / required				Имя ресурсной группы для использования. алиасы: resource_group_name
secret string				Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала.
state string			Choices: absent present ←	Состояние учетной записи хранилища. Используйте `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 kind of FileStorage
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: c1h0002
    type: Premium_LRS
    kind: FileStorage
    tags:
      testing: testing

- 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 complex			всегда	Текущее состояние учетной записи хранилища.
	account_type string		всегда	Тип учетной записи хранилища. Пример: Standard_RAGRS
	custom_domain complex		всегда	Пользовательский домен, назначенный учетной записи хранилища.
		name string	всегда	Источник CNAME. Пример: testaccount
		use_sub_domain boolean	всегда	Использовать домен уровня домена. Пример: True
	id string		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/clh0003
	location string		всегда	Допустимое расположение Azure. По умолчанию используется расположение ресурсной группы. Пример: eastus2
	name string		всегда	Имя учетной записи хранилища для обновления или создания. Пример: clh0003
	network_acls dictionary		всегда	Набор правил брандмауэра и виртуальной сети Пример: {'bypass': 'AzureServices', 'default_action': 'Deny', 'ip_rules': [{'action': 'Allow', 'value': '1.2.3.4'}, {'action': 'Allow', 'value': '123.234.123.0/24'}], 'virtual_network_rules': [{'action': 'Allow', 'id': '/subscriptions/mySubscriptionId/resourceGroups/myResourceGroup/ providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet'}]}
	primary_endpoints dictionary		всегда	URL-адреса для получения общедоступных объектов blob, queue или table из основного расположения. Пример: {'blob': 'https://clh0003.blob.core.windows.net/', 'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/'}
	primary_location string		всегда	Расположение основного центра обработки данных для учетной записи хранилища. Пример: eastus2
	provisioning_state string		всегда	Статус учетной записи хранилища. Возможные значения включают `Creating`, `ResolvingDNS`, `Succeeded`. Пример: Succeeded
	resource_group string		всегда	Имя ресурсной группы. Пример: Testing
	secondary_endpoints dictionary		всегда	URL-адреса для получения общедоступных объектов blob, queue или table из вторичного расположения. Пример: {'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 string		всегда	Расположение гео-реплицированного вторичного центра обработки данных для учетной записи хранилища. Пример: centralus
	status_of_primary string		всегда	Статус основного расположения учетной записи хранилища; либо `available` или `unavailable`. Пример: available
	status_of_secondary string		всегда	Статус вторичного расположения учетной записи хранилища; либо `available` или `unavailable`. Пример: available
	tags dictionary		всегда	Теги ресурса. Пример: {'tags1': 'value1'}
	type string		всегда	Тип учетной записи хранилища. Пример: Microsoft.Storage/storageAccounts

Авторы

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.10/collections/azure/azcollection/azure_rm_storageaccount_module.html