azure_rm_storageaccount – Управление учетными записями хранилища Azure

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_tier - добавлен в 2.4		Варианты: Hot Cool	Уровень доступа для этой учетной записи хранилища. Требуется, когда kind=BlobStorage.
account_type -		Варианты: Premium_LRS Standard_GRS Standard_LRS StandardSSD_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 строка добавлен в 2.6			URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлен в 2.5		По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево		Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 2.5		Варианты: auto cli credential_file env msi	Управление источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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		Варианты: ignore validate	Управление поведением проверки сертификатов для 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 -		Варианты: Хранилище ← StorageV2 BlobStorage	Тип хранилища.
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 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
	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

Статус

Данному модулю не гарантируется обратная совместимость интерфейса. [preview]
Данный модуль поддерживается сообществом 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.9/modules/azure_rm_storageaccount_module.html