azure / azure.azcollection / 2.3.0 / module / azure_rm_privateendpointconnection Managed private endpoint connection | "added in version" 1.12.0 of azure.azcollection" Authors: xuzhang3 (@xuzhang3), Fred-sun (@Fred-sun)azure.azcollection.azure_rm_privateendpointconnection (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Update or delete the private endpoint connection.
- 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
name: description: - The name of the private end point connection. required: true type: str state: choices: - absent - present default: present description: - Assert the state of the connection. Use C(present) to update an connection and C(absent) to delete it. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection service_name: description: - The name of the private link service. required: true type: str resource_group: description: - The name of the resource group. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str connection_state: description: - A collection of information about the state of the connection between service consumer and provider. suboptions: actions_required: description: - A message indicating if changes on the service provider require any updates on the consumer. type: str description: description: - The reason for approval/rejection of the connection. type: str status: choices: - Approved - Rejected - Removed description: - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. type: str type: dict cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
state: contains: PrivateEndpoint: contains: id: description: - The private endpoint resource ID. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/testlink02 type: str description: - The resource of private end point. returned: always type: complex etag: description: - A unique read-only string that changes whenever the resource is updated. returned: always sample: f7d60f37-ea2b-4091-8546-1327f35468c4 type: str id: description: - Resource ID of the private endpoint connection. returned: always sample: /subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/link.09 type: str link_identifier: description: - The consumer link id. returned: always sample: 536890208 type: str name: description: - Name of the private endpoint connection. returned: always sample: testlink.09 type: str private_link_service_connection_state: contains: actions_required: description: - A message indicating if changes on the service provider require any updates on the consumer. returned: always sample: This is action_required string type: str description: description: - The reason for approval/rejection of the connection. returned: always sample: Auto Approved type: str status: description: - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. returned: always sample: Approved type: str description: - A collection of information about the state of the connection between service consumer and provider. returned: always type: complex provisioning_state: description: - Provisioning state of the resource. returned: always sample: Succeeded type: str type: description: - The resource type. returned: always sample: Microsoft.Network/privateLinkServices/privateEndpointConnections type: str description: - List of private endpoint connection info. returned: always type: complex