Модуль azure.azcollection.azure_rm_privateendpoint_info — получение сведений о частных конечных точках

ad_user

string

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

adfs_authority_url

string

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

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

api_profile

string

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

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

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

auth_source

string

добавлено в 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

string

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

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

Варианты:

• "ignore"
• "validate"

client_id

string

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

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

cloud_environment

string

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

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

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

disable_instance_discovery

boolean

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

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

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

Варианты:

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

log_mode

string

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

log_path

string

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

name

string

Имя частной конечной точки.

oidc_token

string

добавлено в 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

path

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

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

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

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

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

password

string

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

profile

string

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

resource_group

string

Имя группы ресурсов; ограничивает результаты указанной группой ресурсов.

secret

string

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

subscription_id

string

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

tags

list / элементы=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, используемому для создания субъекта-службы.

Сертификат должен быть добавлен в файл после закрытого ключа.

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

state

complex

Список словарей частных конечных точек в том же формате, что и параметр модуля azure.azcollection.azure_rm_privateendpoint.

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

application_security_groups

complex

Группа безопасности приложений в группе ресурсов.

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

id

string

Идентификатор группы безопасности приложений.

Возвращается: при использовании

Пример: "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/applicationSecurityGroups/app01"

custom_dns_configs

complex

Массив пользовательских конфигураций DNS.

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

fqdn

string

FQDN, разрешающийся в IP-адрес частной конечной точки.

Возвращается: при использовании

Пример: "postgresqlsrvprivate02.postgres.database.azure.com"

ip_addresses

complex

Список частных IP-адресов частной конечной точки.

Возвращается: при использовании

Пример: ["10.1.0.9"]

custom_network_interface_name

string

Пользовательское имя сетевого интерфейса, подключенного к частной конечной точке.

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

Пример: "nic01"

etag

string

Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.

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

Пример: "W/\"20803842-7d51-46b2-a790-ded8971b4d8a"

id

string

Идентификатор ресурса частной конечной точки.

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

Пример: "/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/ped01"

ip_configurations

complex

Список конфигураций IP частной конечной точки.

Используется для сопоставления с конечными точками службы First Party.

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

group_id

string

Идентификатор группы, полученный от удаленного ресурса, к которому должна подключаться эта частная конечная точка.

Возвращается: при использовании

Пример: "postgresqlServer"

member_name

string

Имя участника группы, полученное от удаленного ресурса, к которому должна подключаться эта частная конечная точка.

Возвращается: при использовании

Пример: "postgresqlServer"

name

string

Имя ресурса, уникальное в пределах группы ресурсов.

Возвращается: при использовании

Пример: "ipc01"

private_ip_address

string

Частный IP-адрес, полученный из подсети частной конечной точки.

Возвращается: при использовании

Пример: "10.1.0.9"

location

string

Допустимое расположение Azure.

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

Пример: "eastus"

manual_private_link_service_connections

complex

Идентификатор ресурса частной конечной точки, к которой нужно подключиться.

Возвращается: при использовании

connection_state

complex

Сведения о состоянии подключения конечной точки

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

actions_required

string

Сообщение о том, требуют ли изменения поставщика службы обновлений на стороне потребителя.

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

Пример: "This is action_required string"

description

string

Причина одобрения или отклонения подключения.

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

Пример: "Auto Approved"

status

string

Указывает, одобрено, отклонено или удалено ли подключение владельцем службы.

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

Пример: "Approved"

id

string

Идентификатор ресурса частной конечной точки, к которой нужно подключиться.

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

Пример: "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/privateEndpoints/ped01/privateLinkServiceConnections/ped01"

name

string

Имя подключения частной конечной точки.

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

Пример: "ped_name01"

name

string

Имя частной конечной точки.

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

Пример: "ped01"

network_interfaces

list / elements=string

Список идентификаторов сетевых интерфейсов.

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

Пример: ["/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/fredprivateendpoint002.nic"]

private_link_service_connections

complex

Идентификатор ресурса частной конечной точки, к которой нужно подключиться.

Возвращается: при использовании

connection_state

complex

Сведения о состоянии подключения конечной точки

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

actions_required

string

Сообщение о том, требуют ли изменения поставщика службы обновлений на стороне потребителя.

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

Пример: "This is action_required string"

description

string

Причина одобрения или отклонения подключения.

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

Пример: "Auto Approved"

status

string

Указывает, одобрено, отклонено или удалено ли подключение владельцем службы.

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

Пример: "Approved"

group_ids

list / elements=string

Список идентификаторов групп, связанных с частной конечной точкой

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

Пример: ["postgresqlServer"]

id

string

Идентификатор ресурса частной конечной точки, к которой нужно подключиться.

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

Пример: "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/privateEndpoints/ped01/privateLinkServiceConnections/ped02"

name

string

Имя подключения частной конечной точки.

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

Пример: "ped_name02"

provisioning_state

string

Состояние подготовки ресурса.

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

Пример: "Succeeded"

subnets_id

string

Подсети, связанные с виртуальной сетью.

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

Пример: "/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/fredtestRG-vnet/subnets/default"

tags

dictionary

Теги, назначенные ресурсу. Словарь пар «строка:строка».

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

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

type

string

Тип ресурса.

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

Пример: "Microsoft.Network/privateEndpoints"