Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_storageshare_info — получение сведений об общей файловой папке Azure Storage

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_storageshare_info.

Добавлено в azure.azcollection 1.8.0

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

Краткое описание

  • Получение фактов об общей файловой папке хранилища.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 2.7
  • На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
  • Все пакеты python, указанные в requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
  • Полные инструкции по установке приведены по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

account_name

строка / обязательный

Имя родительской учетной записи хранилища для общей файловой папки.

ad_user

строка

Имя пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

строка

добавлено в azure.azcollection 0.0.1

URL-адрес центра сертификации Azure AD. Используется для аутентификации по имени пользователя и паролю при наличии собственного центра сертификации ADFS.

api_profile

строка

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; в будущем другие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

строка

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной среды ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет источников следующий: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные будут считаны из переменных среды.

Если задано значение credential_file, профиль будет считан из ~/.azure/credentials.

Если задано значение cli, учетные данные будут получены из профиля Azure CLI. Чтобы указать идентификатор подписки, если их несколько, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет использоваться подписка az cli по умолчанию.

Если задано значение msi, компьютер узла должен быть ресурсом Azure с включенным расширением MSI. Чтобы указать идентификатор подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

строка

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

строка

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

строка

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США: имя среды (определенное в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

логическое значение

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых недоступна конечная точка метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра предполагает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра. При установке значения **True** проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является допустимым и заслуживающим доверия.

Задается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

строка

Родительский аргумент.

log_path

строка

Родительский аргумент.

name

строка

Имя общей файловой папки хранилища.

oidc_token

строка

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается на токен Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

путь

добавлено в azure.azcollection 3.17.0

Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот метод обычно используется на платформах, которые сохраняют токены OIDC в файлах.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

строка

Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

строка

Профиль безопасности из файла ~/.azure/credentials.

resource_group

строка / обязательный

Имя используемой группы ресурсов.

secret

строка

Секрет клиента Azure. Используется для аутентификации с помощью субъекта-службы.

subscription_id

строка

Идентификатор вашей подписки Azure.

tenant

строка

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы.

thumbprint

строка

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется для аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

x509_certificate_path

путь

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат необходимо добавить к закрытому ключу.

Используется для аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или выполнить вход перед запуском задач или плейбука с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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 storage share details
  azure_rm_storageshare_info:
    name: testShare
    resource_group: myResourceGroup
    account_name: testStorageAccount


- name: Get all storage file shares in storage account
  azure_rm_storageshare:
    resource_group: myResourceGroup
    account_name: testStorageAccount

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

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

Ключ

Описание

state

complex

Сведения о текущем состоянии файлового ресурса общего доступа в хранилище

Возвращается: всегда

access_tier

string

Уровень доступа для конкретного файлового ресурса общего доступа

Возвращается: всегда

Пример: "TransactionOptimized"

access_tier_change_time

string

Указывает время последнего изменения уровня доступа файлового ресурса общего доступа

Возвращается: всегда

Пример: "2021-08-23T08:17:35+00:00"

access_tier_status

string

Указывает, ожидается ли переход на другой уровень доступа

Возвращается: всегда

deleted

string

Указывает, был ли удалён ресурс общего доступа

Возвращается: всегда

deleted_time

string

Время удаления, если ресурс общего доступа был удалён

Возвращается: всегда

enabled_protocols

string

Протокол аутентификации, используемый для файлового ресурса общего доступа.

Возвращается: всегда

Пример: "SMB"

etag

string

Тег Etag ресурса

Возвращается: всегда

Пример: "0x8D75E4BA3E275F1"

id

string

Идентификатор ресурса файлового ресурса общего доступа в хранилище

Возвращается: всегда

Пример: "/subscriptions/9e700857-1631-4d8a-aed5-908520ede375/resourceGroups/myResourceGroup/providers/Microsoft.Storage/ storageAccounts/mystorageaccount/fileServices/default/shares/myshare"

last_modified_time

string

Возвращает дату и время последнего изменения файлового ресурса общего доступа

Возвращается: всегда

Пример: "2021-08-23T08:17:35+00:00"

metadata

dictionary

Пара «имя — значение», связанная с файловым ресурсом общего доступа в качестве метаданных

Возвращается: всегда

Пример: {"key1": "value1"}

name

string

Имя файлового ресурса общего доступа

Возвращается: всегда

Пример: "myshare"

remaining_retention_days

string

Оставшееся количество дней хранения ресурса общего доступа, который

Возвращается: всегда

root_squash

string

Это свойство применимо только к ресурсу общего доступа NFS. По умолчанию используется NoRootSquash.

Возвращается: всегда

Пример: "NoRootSquash"

share_quota

integer

Максимальный размер файлового ресурса общего доступа в гигабайтах

Возвращается: всегда

Пример: 102400

share_usage_bytes

integer

Приблизительный размер данных, хранящихся в ресурсе общего доступа. Обратите внимание, что это значение может не учитывать все недавно созданные файлы или файлы, размер которых недавно изменился.

Возвращается: всегда

type

string

Тип ресурса

Возвращается: всегда

Пример: "Microsoft.Storage/storageAccounts/fileServices/shares"

version

string

Версия файлового ресурса общего доступа

Возвращается: всегда

Авторы

  • Andrii Bilorus (@ewscat)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_storageshare_info_module.html

Spec-Zone.ru

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