azure / azure.azcollection / 2.3.0 / module / azure_rm_privatelinkservice Managed private link service resource | "added in version" 1.12.0 of azure.azcollection" Authors: xuzhang3 (@xuzhang3), Fred-sun (@Fred-sun)azure.azcollection.azure_rm_privatelinkservice (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, Update or Delete private link service resource.
- name: Create the private link service azure_rm_privatelinkservice: name: linkservice-name resource_group: myResourceGroup enable_proxy_protocol: true fqdns: - 'dns01.com' - 'dns02.com' visibility: subscriptions: - xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - yyyyyy-yyyyy-yyyy-yyyy-yyyyyyyyyyy auto_approval: subscriptions: - xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - yyyyyy-yyyyy-yyyy-yyyy-yyyyyyyyyyy load_balancer_frontend_ip_configurations: - id: load_balancer_frontend_ip_configurations_id ip_configurations: - name: testSubnet properties: primary: false private_ip_allocation_method: 'Dynamic' private_ip_address_version: 'IPv4' subnet: id: subnet_id - name: subnetfredprivate-1 properties: primary: true private_ip_allocation_method: 'Static' private_ip_address_version: 'IPv4' subnet: id: subnet_id tags: key1: value1 key2: value2
- name: delete the private link service azure_rm_privatelinkservice: name: linkservice-name resource_group: myResourceGroup state: absent
name: description: - The name of the private link service. required: true type: str tags: description: - Dictionary of string:string pairs to assign as metadata to the object. - Metadata tags on the object will be updated with any provided values. - To remove tags set append_tags option to false. - Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. - Azure Front Door doesn't support the use of - Azure Automation and Azure CDN only support 15 tags on resources. type: dict fqdns: description: - The list of Fqdn. elements: str type: list state: choices: - present - absent default: present description: - Assert the state of the pirvate link service. - Use I(state=present) to create or update the link service and I(state=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 location: description: - The resource location. 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 visibility: description: - The visibility list of the private link service. suboptions: subscriptions: description: - The list of subscriptions. elements: str type: list type: dict 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 append_tags: default: true description: - Use to control if tags field is canonical or just appends to existing tags. - When canonical, any tags not found in the tags parameter will be removed from the object's metadata. type: bool 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 auto_approval: description: - The auto-approval list of the private link service. suboptions: subscriptions: description: - The list of subscriptions. elements: str type: list type: dict resource_group: description: - The name of the resource group. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str 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 ip_configurations: description: - An array of private link service IP configurations. elements: dict suboptions: name: description: - The name of private link service ip configuration. type: str properties: description: - The property of the private link service IP configurations. suboptions: primary: description: - Whether the ip configuration is primary or not. type: bool private_ip_address_version: choices: - IPv4 - IPv6 description: - Whether the specific IP configuration is IPv4 or IPv6. type: str private_ip_allocation_method: choices: - Static - Dynamic description: - The private IP address allocation method. type: str subnet: description: - The reference to the subnet resource. suboptions: id: description: - The ID of the subnet. type: str type: dict type: dict type: list 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 enable_proxy_protocol: description: - Whether the private link service is enabled for proxy protocol or not. type: bool 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 load_balancer_frontend_ip_configurations: description: - An array of references to the load balancer IP configurations - Cannot have more than one load balancer frontend IP configuration on the private link service. elements: dict suboptions: id: description: - The load balancer frontend IP's ID. type: str type: list
link_service: contains: alias: description: - The alias of the private link service. returned: always sample: linkservice.6a244dd8-8416-40cf-8c04-52b353bdd507.eastus.azure.privatelinkservice type: str auto_approval: description: - The auto-approval list of the private link service. returned: always sample: subscriptions: - xxxx-xxxx - yyyy-yyyyy type: dict enable_proxy_protocol: description: - Whether the private link service is enabled for proxy protocol or not. returned: always sample: false type: bool etag: description: - A unique read-only string that changes whenever the resource is updated. returned: always sample: f7d60f37-ea2b-4091-8546-1327f35468c4 type: str fqdns: description: - The list of Fqdn. returned: always sample: - fqdns1.com - fqdns2.com type: list id: description: - Resource ID of the private link service. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateLinkServices/linkservice type: str ip_configurations: contains: name: description: - The name of the IP configurations returned: always sample: subnetfredprivate-1 type: str properties: contains: primary: description: - Whether the ip configuration is primary or not. returned: always sample: true type: bool private_ip_address_version: description: - Whether the specific IP configuration is IPv4 or IPv6. returned: always sample: IPv4 type: str private_ip_allocation_method: description: - The private IP address allocation method. returned: always sample: Dynamic type: str subnet: description: - The reference to the subnet resource. returned: always sample: id: /subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnamee type: dict description: - The IP configuration properties. returned: always type: complex description: - An array of private link service IP configurations. returned: always type: complex load_balancer_frontend_ip_configurations: description: - An array of references to the load balancer IP configurations. returned: awalys sample: - id: /subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/loadBalancers/testlb/frontendIPConfigurations/front01 type: list location: description: - Resource location. returned: always sample: eastus type: str name: description: - Name of the private link service. returned: always sample: linkservice type: str network_interfaces: description: - An array of references to the network interfaces created for this private link service. returned: always sample: - id: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/testlinkservice.nic.f5 type: list private_endpoint_connections: contains: id: description: - The ID of the private endpoint connection. returned: always sample: /subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/tes type: str private_endpoint: description: - The ID of the private endpoint. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/test002 type: str description: - An array of list about connections to the private endpoint. returned: always type: complex provisioning_state: description: - The provisioning state of the private link service resource. returned: always sample: Succeeded type: str tags: description: - The resource tags. returned: always sample: key1: value1 type: dict type: description: - The resource type. returned: always sample: Microsoft.Network/privateLinkServices type: str visibility: description: - The visibility list of the private link service. returned: always sample: subscriptions: - xxxx-xxxx - yyyy-yyyyy type: dict description: - List of private link service info. returned: always type: complex