You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

azure.azcollection.azure_rm_privateendpointconnection module – Managed private endpoint connection

Note

This module is part of the azure.azcollection collection (version 1.19.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_privateendpointconnection.

New in azure.azcollection 1.12.0

Synopsis 

Update or delete the private endpoint connection.

Requirements 

The below requirements are needed on the host that executes this module.

python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters 

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. Default: `"latest"`
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. Choices: `"ignore"` `"validate"`
client_id string	Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable. Default: `"AzureCloud"`
connection_state dictionary	A collection of information about the state of the connection between service consumer and provider.
actions_required string	A message indicating if changes on the service provider require any updates on the consumer.
description string	The reason for approval/rejection of the connection.
status string	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Choices: `"Approved"` `"Rejected"` `"Removed"`
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	The name of the private end point connection.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	The name of the resource group.
secret string	Azure client secret. Use when authenticating with a Service Principal.
service_name string / required	The name of the private link service.
state string	Assert the state of the connection. Use `present` to update an connection and `absent` to delete it. Choices: `"absent"` `"present"` ← (default)
subscription_id string	Your Azure subscription Id.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

Notes 

Note

For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

Examples 

- name: Update private endpoint connection
  azure_rm_privateendpointconnection_info:
    name: pe-connection-name
    service_name: testserviceName
    resource_group: myRG
    connection_state:
      description: "new_description string"
      actions_required: "Message string"
      status: "Rejected"

- name: Delee private endpoint connection
  azure_rm_privateendpointconnection_info:
    name: pe-connection-name
    service_name: testserviceName
    resource_group: myRG
    state: absent

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
state complex	List of private endpoint connection info. Returned: always
etag string	A unique read-only string that changes whenever the resource is updated. Returned: always Sample: `"f7d60f37-ea2b-4091-8546-1327f35468c4"`
id string	Resource ID of the private endpoint connection. Returned: always Sample: `"/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/link.09"`
link_identifier string	The consumer link id. Returned: always Sample: `"536890208"`
name string	Name of the private endpoint connection. Returned: always Sample: `"testlink.09"`
private_link_service_connection_state complex	A collection of information about the state of the connection between service consumer and provider. Returned: always
actions_required string	A message indicating if changes on the service provider require any updates on the consumer. Returned: always Sample: `"This is action_required string"`
description string	The reason for approval/rejection of the connection. Returned: always Sample: `"Auto Approved"`
status string	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Returned: always Sample: `"Approved"`
PrivateEndpoint complex	The resource of private end point. Returned: always
id string	The private endpoint resource ID. Returned: always Sample: `"/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/testlink02"`
provisioning_state string	Provisioning state of the resource. Returned: always Sample: `"Succeeded"`
type string	The resource type. Returned: always Sample: `"Microsoft.Network/privateLinkServices/privateEndpointConnections"`

Authors

xuzhang3 (@xuzhang3)
Fred-sun (@Fred-sun)

azure.azcollection.azure_rm_privateendpointconnection module – Managed private endpoint connection

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 

Authors

Collection links

azure.azcollection.azure_rm_privateendpointconnection module – Managed private endpoint connection

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 