Модуль azure.azcollection.azure_rm_storageaccount_info – Получение фактов о хранилище
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные зависимости. Подробнее см. Требования.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_storageaccount_info.
Добавлена в azure.azcollection 0.1.2
Описание
- Получение фактов для одного хранилища или всех хранилищ в группе ресурсов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, с которого выполняются модули из azure.azcollection.
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес центра сертификации Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный центр сертификации ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Может быть также установлен через переменную среды При установке в При установке в При установке в При установке в При установке в
Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но когда используется прокси-сервер HTTPS или Azure Stack, может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Может быть также установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Показывать результаты только для определённой учётной записи. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group aliases: resource_group_name string | Ограничить результаты группой ресурсов. Требуется при фильтрации по имени. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
show_blob_cors boolean | Показывать параметры CORS для каждого хранилища BLOB, связанного со службой хранения. Запрос всех учетных записей хранения может занять много времени. Варианты:
|
show_connection_string boolean | Показать строку подключения для каждого из конечных точек службы хранения. Для удобства использования, show_connection_string также отобразит ключи доступа для каждого из конечных точек службы хранения. Обратите внимание, что это займёт много времени при списке всех учетных записей хранения по сравнению с запросом по одной. Варианты:
|
show_georeplication_stats boolean | Показывать статистику георепликации для каждой учетной записи хранения. Использование этого параметра для учетной записи, не поддерживающей георепликацию, приведет к задержке получения результатов. Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / elements=string | Ограничить результаты, предоставив список тегов. Формат тегов — ‘ключ’ или ‘ключ:значение’. |
tenant string | Идентификатор Azure-аренды. Используйте при аутентификации с помощью принципала службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток цифровой подписи приватного ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью принципала службы. Требуется, если определено x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к X509 сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединён к приватному ключу. Используйте при аутентификации с помощью принципала службы. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или выполнить вход перед запуском задач или playbook с помощью
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: Get facts for one account
azure_rm_storageaccount_info:
resource_group: myResourceGroup
name: clh0002
- name: Get facts for all accounts in a resource group
azure_rm_storageaccount_info:
resource_group: myResourceGroup
- name: Get facts for all accounts by tags
azure_rm_storageaccount_info:
tags:
- testing
- foo:bar
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
azure_storageaccounts список / элементы=строка | Список словарей учетных записей хранения. Возвращается: всегда Пример: |
storageaccounts сложный | Список словарей учетных записей хранения в формате параметров модуля ресурсов. Возвращается: всегда |
|
access_tier строка |
Уровень доступа для данной учетной записи хранения. Возвращается: всегда Пример: |
|
account_type строка |
Тип учетной записи хранения.
Другие типы учетных записей нельзя изменить на Возвращается: всегда Пример: |
|
allow_blob_public_access булево |
Разрешение или запрет публичного доступа ко всем блокам или контейнерам в учетной записи хранения. Возвращается: всегда Пример: |
|
allow_cross_tenant_replication булево |
Разрешение или запрет репликации объектов из разных областей AAD. Возвращается: всегда Пример: |
|
булево |
Указывает, разрешает ли учетная запись хранения запросы, авторизованные с помощью ключа доступа к учетной записи через общий ключ. Возвращается: всегда Пример: |
|
custom_domain сложный |
Пользовательский домен, назначенный учетной записи хранения. Должен быть словарем с ключами name и use_sub_domain, где name — исходный CNAME. Возвращается: всегда |
|
name строка |
Исходный CNAME. Возвращается: всегда Пример: |
|
use_sub_domain булево |
Использовать домен-поддомен. Возвращается: всегда Пример: |
|
default_to_o_auth_authentication булево |
Флаг булевого типа, указывающий, является ли стандартная авторизация OAuth или нет. По умолчанию для этого свойства значение false. Возвращается: всегда Пример: |
|
enable_nfs_v3 булево |
Протокол NFS 3.0. Возвращается: всегда Пример: |
|
encryption сложный |
Настройки шифрования в учетной записи хранения. Возвращается: всегда |
|
key_source строка |
Источник ключа шифрования (поставщик). Возвращается: всегда Пример: |
|
require_infrastructure_encryption булево |
Булево значение, указывающее, применяет ли служба дополнительный уровень шифрования с помощью управляемых платформой ключей для данных в состоянии покоя. Возвращается: всегда Пример: |
|
services словарь |
Список служб, которые поддерживают шифрование. Возвращается: всегда |
|
blob dictionary |
Функция шифрования службы хранилища больших двоичных объектов. Возвращается: всегда Пример: |
|
file dictionary |
Функция шифрования службы файлового хранилища. Возвращается: всегда Пример: |
|
queue dictionary |
Функция шифрования службы очереди хранения. Возвращается: всегда Пример: |
|
table dictionary |
Функция шифрования службы табличного хранилища. Возвращается: всегда Пример: |
|
failover_in_progress boolean |
Статус, указывающий, что учетная запись хранения в данный момент переключается на вторичное расположение. Возвращается: всегда Пример: |
|
georeplication_stats complex |
Параметры, относящиеся к состоянию георепликации. Это будет null для учетных записей, которые не поддерживают георепликацию. Возвращается: всегда |
|
can_failover boolean |
Свойство, указывающее, поддерживается ли отработка отказа учетной записью. Возвращается: успех Пример: |
|
last_sync_time string |
Записи в основной базе данных до этого времени гарантированно реплицируются во вторичную. Возвращается: успех Пример: |
|
sync_status string |
Свойство, показывающее состояние вторичного региона. Известные значения: «Live», «Bootstrap» и «Unavailable». Возвращается: успех Пример: |
|
https_only boolean |
Разрешает только трафик HTTPS для службы хранения, если установлен в Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
is_hns_enabled boolean |
Иерархическое пространство имен учетной записи включено, если установлено значение true. Возвращается: всегда Пример: |
|
kind string |
Тип хранилища. Возвращается: всегда Пример: |
|
string |
Разрешить большие файловые ресурсы, если установлено значение «Включено». Возвращается: всегда Пример: |
|
location string |
Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. Возвращается: всегда Пример: |
|
minimum_tls_version string |
Минимальная версия TLS, разрешенная для запросов к хранилищу. Возвращается: всегда Пример: |
|
name string |
Имя хранилища, которое нужно обновить или создать. Возвращается: всегда Пример: |
|
network_acls dictionary |
Набор правил брандмауэра и виртуальной сети Возвращается: всегда Пример: |
|
primary_endpoints complex |
URL-адреса для получения публичных объектов blob, file, queue или table. Обратите внимание, что учетные записи Возвращается: всегда |
|
blob complex |
Основная конечная точка blob и строка подключения. Возвращается: всегда |
|
connectionstring string |
Строка подключения к конечной точке blob. Возвращается: всегда Пример: |
|
endpoint string |
Основная конечная точка blob. Возвращается: всегда Пример: |
|
file complex |
Основная конечная точка file и строка подключения. Возвращается: всегда |
|
connectionstring string |
Строка подключения к конечной точке file. Возвращается: всегда Пример: |
|
endpoint string |
Основная конечная точка file. Возвращается: всегда Пример: |
|
key string |
Ключ учетной записи для primary_endpoints Возвращается: всегда Пример: |
|
queue complex |
Основная конечная точка queue и строка подключения. Возвращается: всегда |
|
connectionstring string |
Строка подключения к конечной точке queue. Возвращается: всегда Пример: |
|
endpoint string |
Основная конечная точка queue. Возвращается: всегда Пример: |
|
table complex |
Основная конечная точка table и строка подключения. Возвращается: всегда |
|
connectionstring string |
Строка подключения к конечной точке table. Возвращается: всегда Пример: |
|
endpoint string |
Основная конечная точка table. Возвращается: всегда Пример: |
|
primary_location string |
Местоположение основного центра обработки данных для хранилища. Возвращается: всегда Пример: |
|
provisioning_state string |
Статус учетной записи хранения на момент вызова операции. Возможные значения включают Возвращено: всегда Пример: |
|
public_network_access string |
Доступ к общедоступной сети для учетной записи хранения разрешен или запрещен. Возвращено: всегда Пример: |
|
secondary_endpoints complex |
URL-адреса для извлечения общедоступного объекта blob, file, queue или table из вторичного расположения. Доступно только если SKU name=Standard_RAGRS. Возвращено: всегда |
|
blob complex |
Вторичная конечная точка blob и строка подключения. Возвращено: всегда |
|
connectionstring string |
Строка подключения к конечной точке blob. Возвращено: всегда Пример: |
|
endpoint string |
Вторичная конечная точка blob. Возвращено: всегда Пример: |
|
file complex |
Вторичная конечная точка file и строка подключения. Возвращено: всегда |
|
connectionstring string |
Строка подключения к конечной точке file. Возвращено: всегда Пример: |
|
endpoint string |
Вторичная конечная точка file. Возвращено: всегда Пример: |
|
key string |
Ключ учетной записи для secondary_endpoints Возвращено: успех Пример: |
|
queue complex |
Вторичная конечная точка queue и строка подключения. Возвращено: всегда |
|
connectionstring string |
Строка подключения к конечной точке queue. Возвращено: всегда Пример: |
|
endpoint string |
Вторичная конечная точка queue. Возвращено: всегда Пример: |
|
table complex |
Вторичная конечная точка table и строка подключения. Возвращено: всегда |
|
connectionstring string |
Строка подключения к конечной точке table. Возвращено: всегда Пример: |
|
endpoint string |
Вторичная конечная точка table. Возвращено: всегда Пример: |
|
secondary_location string |
Расположение гео-реплицированного вторичного для учетной записи хранения. Доступно только если account_type=Standard_GRS или account_type=Standard_RAGRS. Возвращено: всегда Пример: |
|
static_website complex added in azure.azcollection 1.13.0 |
Конфигурация статического веб-сайта для учетной записи хранилища. Возвращается: всегда |
|
enabled boolean |
Указывает, используется ли эта учетная запись для размещения статического веб-сайта. Возвращается: всегда Пример: |
|
error_document404_path string |
Абсолютный путь к пользовательской странице 404. Возвращается: всегда Пример: |
|
index_document string |
Используемое по умолчанию имя страницы индекса в каждом каталоге. Возвращается: всегда Пример: |
|
status_of_primary string |
Состояние первичного расположения учетной записи хранилища; либо Возвращается: всегда Пример: |
|
status_of_secondary string |
Состояние вторичного расположения учетной записи хранилища; либо Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_storageaccount_info_module.html