azure_rm_storageaccount_facts – Получение фактов о хранилище
Новая версия 2.1.
Обзор
- Получение фактов об одном хранилище или всех хранилищах в группе ресурсов.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. |
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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. |
| cert_validation_mode строка добавлено в 2.5 |
| Управляет поведением проверки сертификатов для 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. |
| name - | Показывать результаты только для определённой учётной записи. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - | Ограничить результаты группой ресурсов. Необходимо при фильтрации по имени. алиасы: resource_group_name | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |
| show_blob_cors логическое добавлено в 2.8 |
| Отображать настройки CORS для блоков каждого из хранилищ. Обратите внимание, что это займёт много времени, когда вы хотите получить все хранилища, а не только одно. |
| show_connection_string логическое добавлено в 2.8 |
| Отображать строку подключения для каждого из точек входа хранилища. Обратите внимание, что это займёт много времени, когда вы хотите получить все хранилища, а не только одно. |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags - | Ограничить результаты, указав список тегов. Формат тегов 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с 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_facts:
resource_group: myResourceGroup
name: clh0002
- name: Get facts for all accounts in a resource group
azure_rm_storageaccount_facts:
resource_group: myResourceGroup
- name: Get facts for all accounts by tags
azure_rm_storageaccount_facts:
tags:
- testing
- foo:bar
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| azure_storageaccounts список | всегда | Список словарей учетных записей хранилища. | |||
| storageaccounts сложный | всегда | Список словарей учетных записей хранилища в формате параметров модуля ресурсов. | |||
| access_tier - | Уровень доступа для этой учетной записи хранилища. Пример: Hot | ||||
| account_type - | Тип учетной записи хранилища. ПРИМЕЧАНИЕ: учетные записи Standard_ZRS и Premium_LRS не могут быть изменены на другие типы учетных записей. Другие типы учетных записей не могут быть изменены на Standard_ZRS или Premium_LRS. Пример: Standard_ZRS | ||||
| blob_cors список | Blob CORS для объекта blob. | ||||
| custom_domain сложный | Пользовательский домен, назначенный учетной записи хранилища. Должен быть словарем с ключами 'name' и 'use_sub_domain', где 'name' — источник CNAME. | ||||
| name - | Источник CNAME. Пример: testaccount | ||||
| use_sub_domain - | Использовать домен-поддомен. Пример: True | ||||
| https_only - | Разрешает трафик только по HTTPS в хранилище, если установлено в значение true. | ||||
| id - | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/t estaccount001 | ||||
| kind - | Тип хранилища. Пример: Storage | ||||
| location - | Допустимое расположение Azure. По умолчанию — расположение группы ресурсов. Пример: eastus | ||||
| name - | Имя учетной записи хранилища для обновления или создания. Пример: testaccount001 | ||||
| primary_endpoints сложный | Получает URL-адреса, используемые для получения объекта blob, очереди или таблицы общего доступа. Обратите внимание, что учетные записи Standard_ZRS и Premium_LRS возвращают только конечную точку blob. | ||||
| blob сложный | Получает первичную конечную точку blob и строку подключения. | ||||
| connectionstring - | Строка подключения к конечной точке blob Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X | ||||
| endpoint - | Получает первичную конечную точку blob. Пример: https://testaccount001.blob.core.windows.net/ | ||||
| queue сложный | Получает первичную конечную точку очереди и строку подключения. | ||||
| connectionstring - | Строка подключения к конечной точке очереди Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X | ||||
| endpoint - | Получает первичную конечную точку очереди. Пример: https://testaccount001.queue.core.windows.net/ | ||||
| table сложный | Получает первичную конечную точку таблицы и строку подключения. | ||||
| connectionstring - | Строка подключения к конечной точке таблицы Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X | ||||
| endpoint - | Получает первичную конечную точку таблицы. Пример: https://testaccount001.table.core.windows.net/ | ||||
| primary_location - | Получает расположение первичного центра обработки данных для учетной записи хранилища. Пример: eastus | ||||
| provisioning_state - | Получает состояние учетной записи хранилища на момент вызова операции. Возможные значения включают 'Creating', 'ResolvingDNS', 'Succeeded'. Пример: Succeeded | ||||
| secondary_endpoints сложный | Получает URL-адреса, используемые для получения объекта blob, очереди или таблицы общего доступа из вторичного расположения. Доступно только если имя SKU — Standard_RAGRS. | ||||
| blob сложный | Получает вторичную конечную точку blob и строку подключения. | ||||
| connectionstring - | Строка подключения к конечной точке blob Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X | ||||
| endpoint - | Получает вторичную конечную точку blob. Пример: https://testaccount001.blob.core.windows.net/ | ||||
| queue сложный | Получает вторичную конечную точку очереди и строку подключения. | ||||
| connectionstring - | Строка подключения к очереди конечной точки Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X | ||||
| endpoint - | Получает вторичную конечную точку очереди. Пример: https://testaccount001.queue.core.windows.net/ | ||||
| table complex | Получает вторичную конечную точку таблицы и строку подключения. | ||||
| connectionstring - | Строка подключения к конечной точке таблицы Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X | ||||
| endpoint - | Получает вторичную конечную точку таблицы. Пример: https://testaccount001.table.core.windows.net/ | ||||
| secondary_location - | Получает расположение гео-реплицированного вторичного источника для учетной записи хранилища. Доступно только в случае, если accountType — Standard_GRS или Standard_RAGRS. Пример: westus | ||||
| status_of_primary - | Получает статус, указывающий, доступно ли основное расположение учетной записи хранилища или нет. Пример: доступно | ||||
| status_of_secondary - | Получает статус, указывающий, доступно ли вторичное расположение учетной записи хранилища или нет. Пример: доступно | ||||
| tags dictionary | Теги ресурса. Пример: {'tag1': 'abc'} | ||||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/azure_rm_storageaccount_facts_module.html
