Try SpotterGet data factory facts
| "added in version" 0.1.12 of azure.azcollection"
Authors: Fred-sun (@Fred-sun), xuzhang3 (@xuzhang3)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get facts for a specific data factory.
- name: Get data factory by name
azure_rm_datafactory_info:
resource_group: "{{ resource_group }}"
name: "{{ name }}"
- name: Get data factory by resource group
azure_rm_datafactory_info:
resource_group: "{{ resource_group }}"
- name: Get data factory in relate subscription
azure_rm_datafactory_info:
tags:
- key1
name:
description:
- The factory name.
type: str
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
elements: str
type: list
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
if_none_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
resource_group:
description:
- Limit results by resource group. Required when using name parameter.
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
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
datafactory:
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