1. Packages
  2. Azure Native
  3. API Docs
  4. datafactory
  5. getFactory
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

azure-native.datafactory.getFactory

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

    Gets a factory. Azure REST API version: 2018-06-01.

    Other available API versions: 2017-09-01-preview.

    Using getFactory

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFactory(args: GetFactoryArgs, opts?: InvokeOptions): Promise<GetFactoryResult>
    function getFactoryOutput(args: GetFactoryOutputArgs, opts?: InvokeOptions): Output<GetFactoryResult>
    def get_factory(factory_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetFactoryResult
    def get_factory_output(factory_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetFactoryResult]
    func LookupFactory(ctx *Context, args *LookupFactoryArgs, opts ...InvokeOption) (*LookupFactoryResult, error)
    func LookupFactoryOutput(ctx *Context, args *LookupFactoryOutputArgs, opts ...InvokeOption) LookupFactoryResultOutput

    > Note: This function is named LookupFactory in the Go SDK.

    public static class GetFactory 
    {
        public static Task<GetFactoryResult> InvokeAsync(GetFactoryArgs args, InvokeOptions? opts = null)
        public static Output<GetFactoryResult> Invoke(GetFactoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFactoryResult> getFactory(GetFactoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:datafactory:getFactory
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FactoryName string
    The factory name.
    ResourceGroupName string
    The resource group name.
    FactoryName string
    The factory name.
    ResourceGroupName string
    The resource group name.
    factoryName String
    The factory name.
    resourceGroupName String
    The resource group name.
    factoryName string
    The factory name.
    resourceGroupName string
    The resource group name.
    factory_name str
    The factory name.
    resource_group_name str
    The resource group name.
    factoryName String
    The factory name.
    resourceGroupName String
    The resource group name.

    getFactory Result

    The following output properties are available:

    CreateTime string
    Time the factory was created in ISO8601 format.
    ETag string
    Etag identifies change in the resource.
    Id string
    The resource identifier.
    Name string
    The resource name.
    ProvisioningState string
    Factory provisioning state, example Succeeded.
    Type string
    The resource type.
    Version string
    Version of the factory.
    Encryption Pulumi.AzureNative.DataFactory.Outputs.EncryptionConfigurationResponse
    Properties to enable Customer Managed Key for the factory.
    GlobalParameters Dictionary<string, Pulumi.AzureNative.DataFactory.Outputs.GlobalParameterSpecificationResponse>
    List of parameters for factory.
    Identity Pulumi.AzureNative.DataFactory.Outputs.FactoryIdentityResponse
    Managed service identity of the factory.
    Location string
    The resource location.
    PublicNetworkAccess string
    Whether or not public network access is allowed for the data factory.
    PurviewConfiguration Pulumi.AzureNative.DataFactory.Outputs.PurviewConfigurationResponse
    Purview information of the factory.
    RepoConfiguration Pulumi.AzureNative.DataFactory.Outputs.FactoryGitHubConfigurationResponse | Pulumi.AzureNative.DataFactory.Outputs.FactoryVSTSConfigurationResponse
    Git repo information of the factory.
    Tags Dictionary<string, string>
    The resource tags.
    CreateTime string
    Time the factory was created in ISO8601 format.
    ETag string
    Etag identifies change in the resource.
    Id string
    The resource identifier.
    Name string
    The resource name.
    ProvisioningState string
    Factory provisioning state, example Succeeded.
    Type string
    The resource type.
    Version string
    Version of the factory.
    Encryption EncryptionConfigurationResponse
    Properties to enable Customer Managed Key for the factory.
    GlobalParameters map[string]GlobalParameterSpecificationResponse
    List of parameters for factory.
    Identity FactoryIdentityResponse
    Managed service identity of the factory.
    Location string
    The resource location.
    PublicNetworkAccess string
    Whether or not public network access is allowed for the data factory.
    PurviewConfiguration PurviewConfigurationResponse
    Purview information of the factory.
    RepoConfiguration FactoryGitHubConfigurationResponse | FactoryVSTSConfigurationResponse
    Git repo information of the factory.
    Tags map[string]string
    The resource tags.
    createTime String
    Time the factory was created in ISO8601 format.
    eTag String
    Etag identifies change in the resource.
    id String
    The resource identifier.
    name String
    The resource name.
    provisioningState String
    Factory provisioning state, example Succeeded.
    type String
    The resource type.
    version String
    Version of the factory.
    encryption EncryptionConfigurationResponse
    Properties to enable Customer Managed Key for the factory.
    globalParameters Map<String,GlobalParameterSpecificationResponse>
    List of parameters for factory.
    identity FactoryIdentityResponse
    Managed service identity of the factory.
    location String
    The resource location.
    publicNetworkAccess String
    Whether or not public network access is allowed for the data factory.
    purviewConfiguration PurviewConfigurationResponse
    Purview information of the factory.
    repoConfiguration FactoryGitHubConfigurationResponse | FactoryVSTSConfigurationResponse
    Git repo information of the factory.
    tags Map<String,String>
    The resource tags.
    createTime string
    Time the factory was created in ISO8601 format.
    eTag string
    Etag identifies change in the resource.
    id string
    The resource identifier.
    name string
    The resource name.
    provisioningState string
    Factory provisioning state, example Succeeded.
    type string
    The resource type.
    version string
    Version of the factory.
    encryption EncryptionConfigurationResponse
    Properties to enable Customer Managed Key for the factory.
    globalParameters {[key: string]: GlobalParameterSpecificationResponse}
    List of parameters for factory.
    identity FactoryIdentityResponse
    Managed service identity of the factory.
    location string
    The resource location.
    publicNetworkAccess string
    Whether or not public network access is allowed for the data factory.
    purviewConfiguration PurviewConfigurationResponse
    Purview information of the factory.
    repoConfiguration FactoryGitHubConfigurationResponse | FactoryVSTSConfigurationResponse
    Git repo information of the factory.
    tags {[key: string]: string}
    The resource tags.
    create_time str
    Time the factory was created in ISO8601 format.
    e_tag str
    Etag identifies change in the resource.
    id str
    The resource identifier.
    name str
    The resource name.
    provisioning_state str
    Factory provisioning state, example Succeeded.
    type str
    The resource type.
    version str
    Version of the factory.
    encryption EncryptionConfigurationResponse
    Properties to enable Customer Managed Key for the factory.
    global_parameters Mapping[str, GlobalParameterSpecificationResponse]
    List of parameters for factory.
    identity FactoryIdentityResponse
    Managed service identity of the factory.
    location str
    The resource location.
    public_network_access str
    Whether or not public network access is allowed for the data factory.
    purview_configuration PurviewConfigurationResponse
    Purview information of the factory.
    repo_configuration FactoryGitHubConfigurationResponse | FactoryVSTSConfigurationResponse
    Git repo information of the factory.
    tags Mapping[str, str]
    The resource tags.
    createTime String
    Time the factory was created in ISO8601 format.
    eTag String
    Etag identifies change in the resource.
    id String
    The resource identifier.
    name String
    The resource name.
    provisioningState String
    Factory provisioning state, example Succeeded.
    type String
    The resource type.
    version String
    Version of the factory.
    encryption Property Map
    Properties to enable Customer Managed Key for the factory.
    globalParameters Map<Property Map>
    List of parameters for factory.
    identity Property Map
    Managed service identity of the factory.
    location String
    The resource location.
    publicNetworkAccess String
    Whether or not public network access is allowed for the data factory.
    purviewConfiguration Property Map
    Purview information of the factory.
    repoConfiguration Property Map | Property Map
    Git repo information of the factory.
    tags Map<String>
    The resource tags.

    Supporting Types

    CMKIdentityDefinitionResponse

    UserAssignedIdentity string
    The resource id of the user assigned identity to authenticate to customer's key vault.
    UserAssignedIdentity string
    The resource id of the user assigned identity to authenticate to customer's key vault.
    userAssignedIdentity String
    The resource id of the user assigned identity to authenticate to customer's key vault.
    userAssignedIdentity string
    The resource id of the user assigned identity to authenticate to customer's key vault.
    user_assigned_identity str
    The resource id of the user assigned identity to authenticate to customer's key vault.
    userAssignedIdentity String
    The resource id of the user assigned identity to authenticate to customer's key vault.

    EncryptionConfigurationResponse

    KeyName string
    The name of the key in Azure Key Vault to use as Customer Managed Key.
    VaultBaseUrl string
    The url of the Azure Key Vault used for CMK.
    Identity Pulumi.AzureNative.DataFactory.Inputs.CMKIdentityDefinitionResponse
    User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
    KeyVersion string
    The version of the key used for CMK. If not provided, latest version will be used.
    KeyName string
    The name of the key in Azure Key Vault to use as Customer Managed Key.
    VaultBaseUrl string
    The url of the Azure Key Vault used for CMK.
    Identity CMKIdentityDefinitionResponse
    User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
    KeyVersion string
    The version of the key used for CMK. If not provided, latest version will be used.
    keyName String
    The name of the key in Azure Key Vault to use as Customer Managed Key.
    vaultBaseUrl String
    The url of the Azure Key Vault used for CMK.
    identity CMKIdentityDefinitionResponse
    User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
    keyVersion String
    The version of the key used for CMK. If not provided, latest version will be used.
    keyName string
    The name of the key in Azure Key Vault to use as Customer Managed Key.
    vaultBaseUrl string
    The url of the Azure Key Vault used for CMK.
    identity CMKIdentityDefinitionResponse
    User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
    keyVersion string
    The version of the key used for CMK. If not provided, latest version will be used.
    key_name str
    The name of the key in Azure Key Vault to use as Customer Managed Key.
    vault_base_url str
    The url of the Azure Key Vault used for CMK.
    identity CMKIdentityDefinitionResponse
    User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
    key_version str
    The version of the key used for CMK. If not provided, latest version will be used.
    keyName String
    The name of the key in Azure Key Vault to use as Customer Managed Key.
    vaultBaseUrl String
    The url of the Azure Key Vault used for CMK.
    identity Property Map
    User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
    keyVersion String
    The version of the key used for CMK. If not provided, latest version will be used.

    FactoryGitHubConfigurationResponse

    AccountName string
    Account name.
    CollaborationBranch string
    Collaboration branch.
    RepositoryName string
    Repository name.
    RootFolder string
    Root folder.
    ClientId string
    GitHub bring your own app client id.
    ClientSecret Pulumi.AzureNative.DataFactory.Inputs.GitHubClientSecretResponse
    GitHub bring your own app client secret information.
    DisablePublish bool
    Disable manual publish operation in ADF studio to favor automated publish.
    HostName string
    GitHub Enterprise host name. For example: https://github.mydomain.com
    LastCommitId string
    Last commit id.
    AccountName string
    Account name.
    CollaborationBranch string
    Collaboration branch.
    RepositoryName string
    Repository name.
    RootFolder string
    Root folder.
    ClientId string
    GitHub bring your own app client id.
    ClientSecret GitHubClientSecretResponse
    GitHub bring your own app client secret information.
    DisablePublish bool
    Disable manual publish operation in ADF studio to favor automated publish.
    HostName string
    GitHub Enterprise host name. For example: https://github.mydomain.com
    LastCommitId string
    Last commit id.
    accountName String
    Account name.
    collaborationBranch String
    Collaboration branch.
    repositoryName String
    Repository name.
    rootFolder String
    Root folder.
    clientId String
    GitHub bring your own app client id.
    clientSecret GitHubClientSecretResponse
    GitHub bring your own app client secret information.
    disablePublish Boolean
    Disable manual publish operation in ADF studio to favor automated publish.
    hostName String
    GitHub Enterprise host name. For example: https://github.mydomain.com
    lastCommitId String
    Last commit id.
    accountName string
    Account name.
    collaborationBranch string
    Collaboration branch.
    repositoryName string
    Repository name.
    rootFolder string
    Root folder.
    clientId string
    GitHub bring your own app client id.
    clientSecret GitHubClientSecretResponse
    GitHub bring your own app client secret information.
    disablePublish boolean
    Disable manual publish operation in ADF studio to favor automated publish.
    hostName string
    GitHub Enterprise host name. For example: https://github.mydomain.com
    lastCommitId string
    Last commit id.
    account_name str
    Account name.
    collaboration_branch str
    Collaboration branch.
    repository_name str
    Repository name.
    root_folder str
    Root folder.
    client_id str
    GitHub bring your own app client id.
    client_secret GitHubClientSecretResponse
    GitHub bring your own app client secret information.
    disable_publish bool
    Disable manual publish operation in ADF studio to favor automated publish.
    host_name str
    GitHub Enterprise host name. For example: https://github.mydomain.com
    last_commit_id str
    Last commit id.
    accountName String
    Account name.
    collaborationBranch String
    Collaboration branch.
    repositoryName String
    Repository name.
    rootFolder String
    Root folder.
    clientId String
    GitHub bring your own app client id.
    clientSecret Property Map
    GitHub bring your own app client secret information.
    disablePublish Boolean
    Disable manual publish operation in ADF studio to favor automated publish.
    hostName String
    GitHub Enterprise host name. For example: https://github.mydomain.com
    lastCommitId String
    Last commit id.

    FactoryIdentityResponse

    PrincipalId string
    The principal id of the identity.
    TenantId string
    The client tenant id of the identity.
    Type string
    The identity type.
    UserAssignedIdentities Dictionary<string, object>
    List of user assigned identities for the factory.
    PrincipalId string
    The principal id of the identity.
    TenantId string
    The client tenant id of the identity.
    Type string
    The identity type.
    UserAssignedIdentities map[string]interface{}
    List of user assigned identities for the factory.
    principalId String
    The principal id of the identity.
    tenantId String
    The client tenant id of the identity.
    type String
    The identity type.
    userAssignedIdentities Map<String,Object>
    List of user assigned identities for the factory.
    principalId string
    The principal id of the identity.
    tenantId string
    The client tenant id of the identity.
    type string
    The identity type.
    userAssignedIdentities {[key: string]: any}
    List of user assigned identities for the factory.
    principal_id str
    The principal id of the identity.
    tenant_id str
    The client tenant id of the identity.
    type str
    The identity type.
    user_assigned_identities Mapping[str, Any]
    List of user assigned identities for the factory.
    principalId String
    The principal id of the identity.
    tenantId String
    The client tenant id of the identity.
    type String
    The identity type.
    userAssignedIdentities Map<Any>
    List of user assigned identities for the factory.

    FactoryVSTSConfigurationResponse

    AccountName string
    Account name.
    CollaborationBranch string
    Collaboration branch.
    ProjectName string
    VSTS project name.
    RepositoryName string
    Repository name.
    RootFolder string
    Root folder.
    DisablePublish bool
    Disable manual publish operation in ADF studio to favor automated publish.
    LastCommitId string
    Last commit id.
    TenantId string
    VSTS tenant id.
    AccountName string
    Account name.
    CollaborationBranch string
    Collaboration branch.
    ProjectName string
    VSTS project name.
    RepositoryName string
    Repository name.
    RootFolder string
    Root folder.
    DisablePublish bool
    Disable manual publish operation in ADF studio to favor automated publish.
    LastCommitId string
    Last commit id.
    TenantId string
    VSTS tenant id.
    accountName String
    Account name.
    collaborationBranch String
    Collaboration branch.
    projectName String
    VSTS project name.
    repositoryName String
    Repository name.
    rootFolder String
    Root folder.
    disablePublish Boolean
    Disable manual publish operation in ADF studio to favor automated publish.
    lastCommitId String
    Last commit id.
    tenantId String
    VSTS tenant id.
    accountName string
    Account name.
    collaborationBranch string
    Collaboration branch.
    projectName string
    VSTS project name.
    repositoryName string
    Repository name.
    rootFolder string
    Root folder.
    disablePublish boolean
    Disable manual publish operation in ADF studio to favor automated publish.
    lastCommitId string
    Last commit id.
    tenantId string
    VSTS tenant id.
    account_name str
    Account name.
    collaboration_branch str
    Collaboration branch.
    project_name str
    VSTS project name.
    repository_name str
    Repository name.
    root_folder str
    Root folder.
    disable_publish bool
    Disable manual publish operation in ADF studio to favor automated publish.
    last_commit_id str
    Last commit id.
    tenant_id str
    VSTS tenant id.
    accountName String
    Account name.
    collaborationBranch String
    Collaboration branch.
    projectName String
    VSTS project name.
    repositoryName String
    Repository name.
    rootFolder String
    Root folder.
    disablePublish Boolean
    Disable manual publish operation in ADF studio to favor automated publish.
    lastCommitId String
    Last commit id.
    tenantId String
    VSTS tenant id.

    GitHubClientSecretResponse

    ByoaSecretAkvUrl string
    Bring your own app client secret AKV URL.
    ByoaSecretName string
    Bring your own app client secret name in AKV.
    ByoaSecretAkvUrl string
    Bring your own app client secret AKV URL.
    ByoaSecretName string
    Bring your own app client secret name in AKV.
    byoaSecretAkvUrl String
    Bring your own app client secret AKV URL.
    byoaSecretName String
    Bring your own app client secret name in AKV.
    byoaSecretAkvUrl string
    Bring your own app client secret AKV URL.
    byoaSecretName string
    Bring your own app client secret name in AKV.
    byoa_secret_akv_url str
    Bring your own app client secret AKV URL.
    byoa_secret_name str
    Bring your own app client secret name in AKV.
    byoaSecretAkvUrl String
    Bring your own app client secret AKV URL.
    byoaSecretName String
    Bring your own app client secret name in AKV.

    GlobalParameterSpecificationResponse

    Type string
    Global Parameter type.
    Value object
    Value of parameter.
    Type string
    Global Parameter type.
    Value interface{}
    Value of parameter.
    type String
    Global Parameter type.
    value Object
    Value of parameter.
    type string
    Global Parameter type.
    value any
    Value of parameter.
    type str
    Global Parameter type.
    value Any
    Value of parameter.
    type String
    Global Parameter type.
    value Any
    Value of parameter.

    PurviewConfigurationResponse

    PurviewResourceId string
    Purview resource id.
    PurviewResourceId string
    Purview resource id.
    purviewResourceId String
    Purview resource id.
    purviewResourceId string
    Purview resource id.
    purview_resource_id str
    Purview resource id.
    purviewResourceId String
    Purview resource id.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi