azure_rm_storageaccount_info – Получение фактов о хранилище
Новая версия 2.9.
Описание
- Получение фактов об одной учетной записи хранилища или всех учетных записях хранилища в группе ресурсов.
Псевдонимы: azure_rm_storageaccount_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 для BLOB для каждой учетной записи хранилища, связанной с учетной записью хранилища. Запрос всех учетных записей хранилища займет много времени. |
| show_connection_string логический добавлен в 2.8 |
| Показать строку подключения для каждого из конечных точек хранилища. Для удобства использования show_connection_string также покажет ключи доступа для каждой из конечных точек хранилища.Обратите внимание, что это займет много времени при перечислении всех учетных записей хранилища, а не запросе одной. |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags - | Ограничить результаты, предоставив список тегов. Формат тегов 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор клиента 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: 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 строка | всегда | Уровень доступа для этой учетной записи хранилища. Пример: Hot | |||
| account_type строка | всегда | Тип учетной записи хранилища. Standard_ZRS и Premium_LRS учетные записи не могут быть изменены на другие типы учетных записей.Другие типы учетных записей не могут быть изменены на Standard_ZRS или Premium_LRS. Пример: Standard_ZRS | |||
| 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 строка | всегда | Тип хранилища. Пример: Хранилище | |||
| location строка | всегда | Допустимое расположение Azure. По умолчанию — расположение группы ресурсов. Пример: eastus | |||
| name строка | всегда | Имя учетной записи хранилища для обновления или создания. Пример: testaccount001 | |||
| primary_endpoints сложный | всегда | URL-адреса для получения общедоступного объекта blob, queue или table. Обратите внимание, что учетные записи 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/ | |||
| key строка | всегда | Ключ учетной записи для primary_endpoints Пример: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |||
| 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. Пример: Успешно | |||
| secondary_endpoints сложный | всегда | URL-адреса для получения общедоступного объекта blob, queue или table из вторичного расположения. Доступно только при SKU name=Standard_RAGRS. | |||
| blob сложный | всегда | Вторичная конечная точка blob и строка подключения. | |||
| Строка подключения строка | всегда | Строка подключения к конечной точке хранилища BLOB. Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X | |||
| Конечная точка строка | всегда | Вторичная конечная точка хранилища BLOB. Пример: https://testaccount001.blob.core.windows.net/ | |||
| Ключ - | Ключ учетной записи для вторичных конечных точек. Пример: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||||
| Очередь сложный тип | всегда | Вторичная конечная точка и строка подключения к очереди. | |||
| Строка подключения строка | всегда | Строка подключения к конечной точке очереди. Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X | |||
| Конечная точка строка | всегда | Вторичная конечная точка очереди. Пример: https://testaccount001.queue.core.windows.net/ | |||
| Таблица сложный тип | всегда | Вторичная конечная точка и строка подключения к таблице. | |||
| Строка подключения строка | всегда | Строка подключения к конечной точке таблицы. Пример: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X | |||
| Конечная точка строка | всегда | Вторичная конечная точка таблицы. Пример: https://testaccount001.table.core.windows.net/ | |||
| Вторичное расположение строка | всегда | Расположение гео-реплицированной вторичной копии для учетной записи хранилища. Доступно только если account_type=Standard_GRS или account_type=Standard_RAGRS. Пример: westus | |||
| Состояние первичного расположения строка | всегда | Состояние первичного расположения учетной записи хранилища; либо available либо unavailable. Пример: доступно | |||
| Состояние вторичного расположения строка | всегда | Состояние вторичного расположения учетной записи хранилища; либо available либо unavailable. Пример: доступно | |||
| Теги словарь | всегда | Теги ресурса. Пример: {'tag1': 'abc'} | |||
Состояние
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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_info_module.html
