Spec-Zone.ru › Ansible 2.11

community.azure.azure_rm_storageaccount_info – Получение фактов о хранилище

Примечание

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

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

Для использования в книге задач укажите: community.azure.azure_rm_storageaccount_info.

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

Обзор

  • Получение фактов для одной учетной записи хранилища или всех учетных записей хранилища в группе ресурсов.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url
строка
добавлено в 0.0.1 azure.azcollection
URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
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 может использоваться для идентификации идентификатора подписки, если их несколько, в противном случае используется стандартная подписка Azure CLI.
При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.
msi было добавлено в Ansible 2.6.
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.
name
строка
Отображать результаты только для определенной учетной записи.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Ограничить результаты группой ресурсов. Требуется при фильтрации по имени.

псевдонимы: resource_group_name
secret
строка
Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала.
show_blob_cors
булево
    Варианты:
  • no
  • yes
Отображать параметры CORS для хранилища blob для каждой blob, связанной с учетной записью хранилища.
Запрос всех учетных записей хранилища займет много времени.
show_connection_string
булево
    Варианты:
  • no
  • yes
Отобразить строку подключения для каждого из точек доступа хранилища.
Для удобства использования 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
  community.azure.azure_rm_storageaccount_info:
    resource_group: myResourceGroup
    name: clh0002

- name: Get facts for all accounts in a resource group
  community.azure.azure_rm_storageaccount_info:
    resource_group: myResourceGroup

- name: Get facts for all accounts by tags
  community.azure.azure_rm_storageaccount_info:
    tags:
      - testing
      - foo:bar

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
azure_storageaccounts
список / элементы=строка
всегда
Список словарей учетных записей хранилища.

Пример:
[{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/myResourceGroups/testing/providers/Microsoft.Storage/storageAccounts/testaccount001', 'location': 'eastus2', 'name': 'testaccount001', 'properties': {'accountType': 'Standard_LRS', 'creationTime': '2016-03-28T02:46:58.290113Z', 'primaryEndpoints': {'blob': 'https://testaccount001.blob.core.windows.net/', 'file': 'https://testaccount001.file.core.windows.net/', 'queue': 'https://testaccount001.queue.core.windows.net/', 'table': 'https://testaccount001.table.core.windows.net/'}, 'primaryLocation': 'eastus2', 'provisioningState': 'Succeeded', 'statusOfPrimary': 'Available'}, 'tags': {}, 'type': 'Microsoft.Storage/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.

Пример:
Succeeded
secondary_endpoints
сложный
всегда
URL-адреса для получения общедоступного объекта blob, queue или table из вторичного расположения.
Доступно только если SKU name=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/
key
строка
успех
Ключ учетной записи для secondary_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
string
always
Строка подключения к конечной точке таблицы.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X
endpoint
string
always
Вторичная конечная точка таблицы.

Пример:
https://testaccount001.table.core.windows.net/
secondary_location
string
always
Расположение гео-реплицированной вторичной копии для учетной записи хранилища.
Доступно только если account_type=Standard_GRS или account_type=Standard_RAGRS.

Пример:
westus
status_of_primary
string
always
Состояние первичного расположения учетной записи хранилища; либо available, либо unavailable.

Пример:
available
status_of_secondary
string
always
Состояние вторичного расположения учетной записи хранилища; либо available, либо unavailable.

Пример:
available
tags
dictionary
always
Теги ресурса.

Пример:
{'tag1': 'abc'}


Авторы

  • 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/community/azure/azure_rm_storageaccount_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API