datafactory.azure.com/v1api20180601
APIVersion
| Value | Description |
|---|---|
| “2018-06-01” |
Factory
Generator information: - Generated from: /datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
Used by: FactoryList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Factory_Spec Optional |
|
| status | Factory_STATUS Optional |
Factory_Spec
| Property | Description | Type |
|---|---|---|
| additionalProperties | map[string]v1.JSON Optional |
|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| encryption | Properties to enable Customer Managed Key for the factory. | EncryptionConfiguration Optional |
| globalParameters | List of parameters for factory. | map[string]GlobalParameterSpecification Optional |
| identity | Managed service identity of the factory. | FactoryIdentity Optional |
| location | The resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FactoryOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | Whether or not public network access is allowed for the data factory. | FactoryProperties_PublicNetworkAccess Optional |
| purviewConfiguration | Purview information of the factory. | PurviewConfiguration Optional |
| repoConfiguration | Git repo information of the factory. | FactoryRepoConfiguration Optional |
| tags | The resource tags. | map[string]string Optional |
Factory_STATUS
| Property | Description | Type |
|---|---|---|
| additionalProperties | map[string]v1.JSON Optional |
|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createTime | Time the factory was created in ISO8601 format. | string Optional |
| encryption | Properties to enable Customer Managed Key for the factory. | EncryptionConfiguration_STATUS Optional |
| eTag | Etag identifies change in the resource. | string Optional |
| globalParameters | List of parameters for factory. | map[string]GlobalParameterSpecification_STATUS Optional |
| id | The resource identifier. | string Optional |
| identity | Managed service identity of the factory. | FactoryIdentity_STATUS Optional |
| location | The resource location. | string Optional |
| name | The resource name. | string Optional |
| provisioningState | Factory provisioning state, example Succeeded. | string Optional |
| publicNetworkAccess | Whether or not public network access is allowed for the data factory. | FactoryProperties_PublicNetworkAccess_STATUS Optional |
| purviewConfiguration | Purview information of the factory. | PurviewConfiguration_STATUS Optional |
| repoConfiguration | Git repo information of the factory. | FactoryRepoConfiguration_STATUS Optional |
| tags | The resource tags. | map[string]string Optional |
| type | The resource type. | string Optional |
| version | Version of the factory. | string Optional |
FactoryList
Generator information: - Generated from: /datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Factory[] Optional |
Factory_Spec
Used by: Factory.
| Property | Description | Type |
|---|---|---|
| additionalProperties | map[string]v1.JSON Optional |
|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| encryption | Properties to enable Customer Managed Key for the factory. | EncryptionConfiguration Optional |
| globalParameters | List of parameters for factory. | map[string]GlobalParameterSpecification Optional |
| identity | Managed service identity of the factory. | FactoryIdentity Optional |
| location | The resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FactoryOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | Whether or not public network access is allowed for the data factory. | FactoryProperties_PublicNetworkAccess Optional |
| purviewConfiguration | Purview information of the factory. | PurviewConfiguration Optional |
| repoConfiguration | Git repo information of the factory. | FactoryRepoConfiguration Optional |
| tags | The resource tags. | map[string]string Optional |
Factory_STATUS
Factory resource type.
Used by: Factory.
| Property | Description | Type |
|---|---|---|
| additionalProperties | map[string]v1.JSON Optional |
|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createTime | Time the factory was created in ISO8601 format. | string Optional |
| encryption | Properties to enable Customer Managed Key for the factory. | EncryptionConfiguration_STATUS Optional |
| eTag | Etag identifies change in the resource. | string Optional |
| globalParameters | List of parameters for factory. | map[string]GlobalParameterSpecification_STATUS Optional |
| id | The resource identifier. | string Optional |
| identity | Managed service identity of the factory. | FactoryIdentity_STATUS Optional |
| location | The resource location. | string Optional |
| name | The resource name. | string Optional |
| provisioningState | Factory provisioning state, example Succeeded. | string Optional |
| publicNetworkAccess | Whether or not public network access is allowed for the data factory. | FactoryProperties_PublicNetworkAccess_STATUS Optional |
| purviewConfiguration | Purview information of the factory. | PurviewConfiguration_STATUS Optional |
| repoConfiguration | Git repo information of the factory. | FactoryRepoConfiguration_STATUS Optional |
| tags | The resource tags. | map[string]string Optional |
| type | The resource type. | string Optional |
| version | Version of the factory. | string Optional |
EncryptionConfiguration
Definition of CMK for the factory.
Used by: Factory_Spec.
| Property | Description | Type |
|---|---|---|
| identity | User assigned identity to use to authenticate to customer’s key vault. If not provided Managed Service Identity will be used. | CMKIdentityDefinition Optional |
| keyName | The name of the key in Azure Key Vault to use as Customer Managed Key. | string Required |
| keyVersion | The version of the key used for CMK. If not provided, latest version will be used. | string Optional |
| vaultBaseUrl | The url of the Azure Key Vault used for CMK. | string Required |
EncryptionConfiguration_STATUS
Definition of CMK for the factory.
Used by: Factory_STATUS.
| Property | Description | Type |
|---|---|---|
| identity | User assigned identity to use to authenticate to customer’s key vault. If not provided Managed Service Identity will be used. | CMKIdentityDefinition_STATUS Optional |
| keyName | The name of the key in Azure Key Vault to use as Customer Managed Key. | string Optional |
| keyVersion | The version of the key used for CMK. If not provided, latest version will be used. | string Optional |
| vaultBaseUrl | The url of the Azure Key Vault used for CMK. | string Optional |
FactoryIdentity
Identity properties of the factory resource.
Used by: Factory_Spec.
| Property | Description | Type |
|---|---|---|
| type | The identity type. | FactoryIdentity_Type Required |
| userAssignedIdentities | List of user assigned identities for the factory. | UserAssignedIdentityDetails[] Optional |
FactoryIdentity_STATUS
Identity properties of the factory resource.
Used by: Factory_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal id of the identity. | string Optional |
| tenantId | The client tenant id of the identity. | string Optional |
| type | The identity type. | FactoryIdentity_Type_STATUS Optional |
| userAssignedIdentities | List of user assigned identities for the factory. | map[string]v1.JSON Optional |
FactoryOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Factory_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
FactoryProperties_PublicNetworkAccess
Used by: Factory_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
FactoryProperties_PublicNetworkAccess_STATUS
Used by: Factory_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
FactoryRepoConfiguration
Used by: Factory_Spec.
| Property | Description | Type |
|---|---|---|
| factoryGitHubConfiguration | Mutually exclusive with all other properties | FactoryGitHubConfiguration Optional |
| factoryVSTSConfiguration | Mutually exclusive with all other properties | FactoryVSTSConfiguration Optional |
FactoryRepoConfiguration_STATUS
Used by: Factory_STATUS.
| Property | Description | Type |
|---|---|---|
| factoryGitHubConfiguration | Mutually exclusive with all other properties | FactoryGitHubConfiguration_STATUS Optional |
| factoryVSTSConfiguration | Mutually exclusive with all other properties | FactoryVSTSConfiguration_STATUS Optional |
GlobalParameterSpecification
Definition of a single parameter for an entity.
Used by: Factory_Spec.
| Property | Description | Type |
|---|---|---|
| type | Global Parameter type. | GlobalParameterSpecification_Type Required |
| value | Value of parameter. | map[string]v1.JSON Required |
GlobalParameterSpecification_STATUS
Definition of a single parameter for an entity.
Used by: Factory_STATUS.
| Property | Description | Type |
|---|---|---|
| type | Global Parameter type. | GlobalParameterSpecification_Type_STATUS Optional |
| value | Value of parameter. | map[string]v1.JSON Optional |
PurviewConfiguration
Purview configuration.
Used by: Factory_Spec.
| Property | Description | Type |
|---|---|---|
| purviewResourceReference | Purview resource id. | genruntime.ResourceReference Optional |
PurviewConfiguration_STATUS
Purview configuration.
Used by: Factory_STATUS.
| Property | Description | Type |
|---|---|---|
| purviewResourceId | Purview resource id. | string Optional |
CMKIdentityDefinition
Managed Identity used for CMK.
Used by: EncryptionConfiguration.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentityReference | The resource id of the user assigned identity to authenticate to customer’s key vault. | genruntime.ResourceReference Optional |
CMKIdentityDefinition_STATUS
Managed Identity used for CMK.
Used by: EncryptionConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentity | The resource id of the user assigned identity to authenticate to customer’s key vault. | string Optional |
FactoryGitHubConfiguration
Used by: FactoryRepoConfiguration.
| Property | Description | Type |
|---|---|---|
| accountName | Account name. | string Required |
| clientId | GitHub bring your own app client id. | string Optional |
| clientSecret | GitHub bring your own app client secret information. | GitHubClientSecret Optional |
| collaborationBranch | Collaboration branch. | string Required |
| disablePublish | Disable manual publish operation in ADF studio to favor automated publish. | bool Optional |
| hostName | GitHub Enterprise host name. For example: https://github.mydomain.com |
string Optional |
| lastCommitId | Last commit id. | string Optional |
| repositoryName | Repository name. | string Required |
| rootFolder | Root folder. | string Required |
| type | Type of repo configuration. | FactoryGitHubConfiguration_Type Required |
FactoryGitHubConfiguration_STATUS
Used by: FactoryRepoConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| accountName | Account name. | string Optional |
| clientId | GitHub bring your own app client id. | string Optional |
| clientSecret | GitHub bring your own app client secret information. | GitHubClientSecret_STATUS Optional |
| collaborationBranch | Collaboration branch. | string Optional |
| disablePublish | Disable manual publish operation in ADF studio to favor automated publish. | bool Optional |
| hostName | GitHub Enterprise host name. For example: https://github.mydomain.com |
string Optional |
| lastCommitId | Last commit id. | string Optional |
| repositoryName | Repository name. | string Optional |
| rootFolder | Root folder. | string Optional |
| type | Type of repo configuration. | FactoryGitHubConfiguration_Type_STATUS Optional |
FactoryIdentity_Type
Used by: FactoryIdentity.
| Value | Description |
|---|---|
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
FactoryIdentity_Type_STATUS
Used by: FactoryIdentity_STATUS.
| Value | Description |
|---|---|
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
FactoryVSTSConfiguration
Used by: FactoryRepoConfiguration.
| Property | Description | Type |
|---|---|---|
| accountName | Account name. | string Required |
| collaborationBranch | Collaboration branch. | string Required |
| disablePublish | Disable manual publish operation in ADF studio to favor automated publish. | bool Optional |
| lastCommitId | Last commit id. | string Optional |
| projectName | VSTS project name. | string Required |
| repositoryName | Repository name. | string Required |
| rootFolder | Root folder. | string Required |
| tenantId | VSTS tenant id. | string Optional |
| type | Type of repo configuration. | FactoryVSTSConfiguration_Type Required |
FactoryVSTSConfiguration_STATUS
Used by: FactoryRepoConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| accountName | Account name. | string Optional |
| collaborationBranch | Collaboration branch. | string Optional |
| disablePublish | Disable manual publish operation in ADF studio to favor automated publish. | bool Optional |
| lastCommitId | Last commit id. | string Optional |
| projectName | VSTS project name. | string Optional |
| repositoryName | Repository name. | string Optional |
| rootFolder | Root folder. | string Optional |
| tenantId | VSTS tenant id. | string Optional |
| type | Type of repo configuration. | FactoryVSTSConfiguration_Type_STATUS Optional |
GlobalParameterSpecification_Type
Used by: GlobalParameterSpecification.
| Value | Description |
|---|---|
| “Array” | |
| “Bool” | |
| “Float” | |
| “Int” | |
| “Object” | |
| “String” |
GlobalParameterSpecification_Type_STATUS
Used by: GlobalParameterSpecification_STATUS.
| Value | Description |
|---|---|
| “Array” | |
| “Bool” | |
| “Float” | |
| “Int” | |
| “Object” | |
| “String” |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: FactoryIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
FactoryGitHubConfiguration_Type
Used by: FactoryGitHubConfiguration.
| Value | Description |
|---|---|
| “FactoryGitHubConfiguration” |
FactoryGitHubConfiguration_Type_STATUS
Used by: FactoryGitHubConfiguration_STATUS.
| Value | Description |
|---|---|
| “FactoryGitHubConfiguration” |
FactoryVSTSConfiguration_Type
Used by: FactoryVSTSConfiguration.
| Value | Description |
|---|---|
| “FactoryVSTSConfiguration” |
FactoryVSTSConfiguration_Type_STATUS
Used by: FactoryVSTSConfiguration_STATUS.
| Value | Description |
|---|---|
| “FactoryVSTSConfiguration” |
GitHubClientSecret
Client secret information for factory’s bring your own app repository configuration.
Used by: FactoryGitHubConfiguration.
| Property | Description | Type |
|---|---|---|
| byoaSecretAkvUrl | Bring your own app client secret AKV URL. | string Optional |
| byoaSecretName | Bring your own app client secret name in AKV. | string Optional |
GitHubClientSecret_STATUS
Client secret information for factory’s bring your own app repository configuration.
Used by: FactoryGitHubConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| byoaSecretAkvUrl | Bring your own app client secret AKV URL. | string Optional |
| byoaSecretName | Bring your own app client secret name in AKV. | string Optional |