azure / azure.azcollection / 2.3.0 / module / azure_rm_datafactory Managed data factory | "added in version" 0.1.12 of azure.azcollection" Authors: Fred-sun (@Fred-sun), xuzhang3 (@xuzhang3)azure.azcollection.azure_rm_datafactory (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 data factory.
- name: Create the data factory azure_rm_datafactory: resource_group: "{{ resource_group }}" name: "{{ name }}" repo_configuration: type: FactoryGitHubConfiguration account_name: Fred-sun collaboration_branch: testbranch root_folder: "./" repository_name: vault
name: description: - The factory name. 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 state: choices: - absent - present default: present description: - Assert the state of the Public IP. Use C(present) to create or update a and C(absent) to delete. 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 if_match: description: - ETag of the factory entity. - Should only be specified for get. - If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. type: str location: description: - Valid Azure location. Defaults to location of the resource group. 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 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 resource_group: description: - Limit results by resource group. Required when using name parameter. 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 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 repo_configuration: description: - The data factory repo configration. suboptions: account_name: description: - Account name. required: true type: str collaboration_branch: description: - Collaboration branch. required: true type: str project_name: description: - VSTS project name. - Required when I(type=FactoryVSTSConfiguration). type: str repository_name: description: - Repository name. required: true type: str root_folder: description: - Root folder. required: true type: str type: choices: - FactoryGitHubConfiguration - FactoryVSTSConfiguration description: - Type of repo configuration. required: true type: str type: dict 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 public_network_access: choices: - Enabled - Disabled description: - Whether or not public network access is allowed for the data factory. type: str 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: create_time: description: - Time the factory was created in ISO8601 format. returned: always sample: '2022-04-26T08:24:41.391164+00:00' type: str e_tag: description: - Etag identifies change in the resource. returned: always sample: 3000fa80-0000-0100-0000-6267ac490000 type: str id: description: - The data facotry ID. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.DataFactory/factories/testpro type: str identity: contains: principal_id: description: - The principal id of the identity. returned: always sample: '***********' type: str tenant_id: description: - The client tenant id of the identity. returned: always sample: '***********' type: str description: - Managed service identity of the factory. returned: always type: str location: description: - The resource location. returned: always sample: eastus type: str name: description: - The resource name. returned: always sample: testfactory type: str provisioning_state: description: - Factory provisioning state, example Succeeded. returned: always sample: Succeeded type: str public_network_access: description: - Whether or not public network access is allowed for the data factory. returned: always sample: Enabled type: str repo_configuration: contains: ccount_name: description: - Account name. returned: always sample: fredaccount type: str collaboration_branch: description: - Collaboration branch. returned: always sample: branch type: str repository_name: description: - Repository name. returned: always sample: vault type: str root_folder: description: - Root folder. returned: always sample: /home/ type: str type: description: - Type of repo configuration. returned: always sample: FactoryGitHubConfiguration type: str description: - Git repo information of the factory. returned: always type: str tags: description: - List the data factory tags. returned: always sample: key1: value1 type: str type: description: - The resource type. returned: always sample: Microsoft.DataFactory/factories type: str description: - Current state fo the data factory. returned: always type: complex