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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

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

Для использования в playbook, укажите: azure.azcollection.azure_rm_storageaccount.

Введено в версии 0.1.0: of 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`. Псевдонимы: type
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				Варианты: no yes	Разрешает контейнерам blob в учетной записи быть настроенными на анонимный публичный доступ. Если установлено в значение false, ни один контейнер в этой учетной записи не сможет разрешить анонимный публичный доступ. Значение по умолчанию — `True`.
api_profile строка добавлен в 0.0.1 azure.azcollection				Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое				Варианты: no да ←	Используйте для управления, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Когда каноническое, любые теги, которых нет в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 azure.azcollection				Варианты: auto ← 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 логическое				Варианты: нет ← yes	Попытаться удалить, если ресурс уже существует и не может быть обновлён. Псевдонимы: force
https_only логическое				Варианты: no yes	Разрешает только HTTPS-трафик в службу хранилища, когда установлено в `true`. Разрешает обновление свойства учетной записи хранилища при установке в `False`. Значение по умолчанию — `False`.
kind строка				Варианты: Storage ← 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_storageaccount_module.html