datafactory.azure.com/v1api20180601

Package v1api20180601 contains API Schema definitions for the datafactory v1api20180601 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2018-06-01"

CMKIdentityDefinition

(Appears on:EncryptionConfiguration)

Managed Identity used for CMK.

Field	Description
`userAssignedIdentityReference` genruntime.ResourceReference	UserAssignedIdentityReference: The resource id of the user assigned identity to authenticate to customer’s key vault.

CMKIdentityDefinition_STATUS

(Appears on:EncryptionConfiguration_STATUS)

Managed Identity used for CMK.

Field	Description
`userAssignedIdentity` string	UserAssignedIdentity: The resource id of the user assigned identity to authenticate to customer’s key vault.

EncryptionConfiguration

(Appears on:Factory_Spec)

Definition of CMK for the factory.

Field	Description
`identity` CMKIdentityDefinition	Identity: User assigned identity to use to authenticate to customer’s key vault. If not provided Managed Service Identity will be used.
`keyName` string	KeyName: The name of the key in Azure Key Vault to use as Customer Managed Key.
`keyVersion` string	KeyVersion: The version of the key used for CMK. If not provided, latest version will be used.
`vaultBaseUrl` string	VaultBaseUrl: The url of the Azure Key Vault used for CMK.

EncryptionConfiguration_STATUS

(Appears on:Factory_STATUS)

Definition of CMK for the factory.

Field	Description
`identity` CMKIdentityDefinition_STATUS	Identity: User assigned identity to use to authenticate to customer’s key vault. If not provided Managed Service Identity will be used.
`keyName` string	KeyName: The name of the key in Azure Key Vault to use as Customer Managed Key.
`keyVersion` string	KeyVersion: The version of the key used for CMK. If not provided, latest version will be used.
`vaultBaseUrl` string	VaultBaseUrl: The url of the Azure Key Vault used for CMK.

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}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Factory_Spec

`additionalProperties` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
`azureName` string	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.
`encryption` EncryptionConfiguration	Encryption: Properties to enable Customer Managed Key for the factory.
`globalParameters` map[string]./api/datafactory/v1api20180601.GlobalParameterSpecification	GlobalParameters: List of parameters for factory.
`identity` FactoryIdentity	Identity: Managed service identity of the factory.
`location` string	Location: The resource location.
`operatorSpec` FactoryOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`publicNetworkAccess` FactoryProperties_PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for the data factory.
`purviewConfiguration` PurviewConfiguration	PurviewConfiguration: Purview information of the factory.
`repoConfiguration` FactoryRepoConfiguration	RepoConfiguration: Git repo information of the factory.
`tags` map[string]string	Tags: The resource tags.

status
Factory_STATUS

FactoryGitHubConfiguration

(Appears on:FactoryRepoConfiguration)

Field	Description
`accountName` string	AccountName: Account name.
`clientId` string	ClientId: GitHub bring your own app client id.
`clientSecret` GitHubClientSecret	ClientSecret: GitHub bring your own app client secret information.
`collaborationBranch` string	CollaborationBranch: Collaboration branch.
`disablePublish` bool	DisablePublish: Disable manual publish operation in ADF studio to favor automated publish.
`hostName` string	HostName: GitHub Enterprise host name. For example: `https://github.mydomain.com`
`lastCommitId` string	LastCommitId: Last commit id.
`repositoryName` string	RepositoryName: Repository name.
`rootFolder` string	RootFolder: Root folder.
`type` FactoryGitHubConfiguration_Type	Type: Type of repo configuration.

FactoryGitHubConfiguration_STATUS

(Appears on:FactoryRepoConfiguration_STATUS)

Field	Description
`accountName` string	AccountName: Account name.
`clientId` string	ClientId: GitHub bring your own app client id.
`clientSecret` GitHubClientSecret_STATUS	ClientSecret: GitHub bring your own app client secret information.
`collaborationBranch` string	CollaborationBranch: Collaboration branch.
`disablePublish` bool	DisablePublish: Disable manual publish operation in ADF studio to favor automated publish.
`hostName` string	HostName: GitHub Enterprise host name. For example: `https://github.mydomain.com`
`lastCommitId` string	LastCommitId: Last commit id.
`repositoryName` string	RepositoryName: Repository name.
`rootFolder` string	RootFolder: Root folder.
`type` FactoryGitHubConfiguration_Type_STATUS	Type: Type of repo configuration.

FactoryGitHubConfiguration_Type (`string` alias)

(Appears on:FactoryGitHubConfiguration)

Value	Description
"FactoryGitHubConfiguration"

FactoryGitHubConfiguration_Type_STATUS (`string` alias)

(Appears on:FactoryGitHubConfiguration_STATUS)

Value	Description
"FactoryGitHubConfiguration"

FactoryIdentity

(Appears on:Factory_Spec)

Identity properties of the factory resource.

Field	Description
`type` FactoryIdentity_Type	Type: The identity type.
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: List of user assigned identities for the factory.

FactoryIdentity_STATUS

(Appears on:Factory_STATUS)

Identity properties of the factory resource.

Field	Description
`principalId` string	PrincipalId: The principal id of the identity.
`tenantId` string	TenantId: The client tenant id of the identity.
`type` FactoryIdentity_Type_STATUS	Type: The identity type.
`userAssignedIdentities` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	UserAssignedIdentities: List of user assigned identities for the factory.

FactoryIdentity_Type (`string` alias)

(Appears on:FactoryIdentity)

Value	Description
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"

FactoryIdentity_Type_STATUS (`string` alias)

(Appears on:FactoryIdentity_STATUS)

Value	Description
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"

FactoryOperatorSpec

(Appears on:Factory_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

FactoryProperties_PublicNetworkAccess (`string` alias)

(Appears on:Factory_Spec)

Value	Description
"Disabled"
"Enabled"

FactoryProperties_PublicNetworkAccess_STATUS (`string` alias)

(Appears on:Factory_STATUS)

Value	Description
"Disabled"
"Enabled"

FactoryRepoConfiguration

(Appears on:Factory_Spec)

Field	Description
`factoryGitHubConfiguration` FactoryGitHubConfiguration	FactoryGitHub: Mutually exclusive with all other properties
`factoryVSTSConfiguration` FactoryVSTSConfiguration	FactoryVSTS: Mutually exclusive with all other properties

FactoryRepoConfiguration_STATUS

(Appears on:Factory_STATUS)

Field	Description
`factoryGitHubConfiguration` FactoryGitHubConfiguration_STATUS	FactoryGitHub: Mutually exclusive with all other properties
`factoryVSTSConfiguration` FactoryVSTSConfiguration_STATUS	FactoryVSTS: Mutually exclusive with all other properties

FactoryVSTSConfiguration

(Appears on:FactoryRepoConfiguration)

Field	Description
`accountName` string	AccountName: Account name.
`collaborationBranch` string	CollaborationBranch: Collaboration branch.
`disablePublish` bool	DisablePublish: Disable manual publish operation in ADF studio to favor automated publish.
`lastCommitId` string	LastCommitId: Last commit id.
`projectName` string	ProjectName: VSTS project name.
`repositoryName` string	RepositoryName: Repository name.
`rootFolder` string	RootFolder: Root folder.
`tenantId` string	TenantId: VSTS tenant id.
`type` FactoryVSTSConfiguration_Type	Type: Type of repo configuration.

FactoryVSTSConfiguration_STATUS

(Appears on:FactoryRepoConfiguration_STATUS)

Field	Description
`accountName` string	AccountName: Account name.
`collaborationBranch` string	CollaborationBranch: Collaboration branch.
`disablePublish` bool	DisablePublish: Disable manual publish operation in ADF studio to favor automated publish.
`lastCommitId` string	LastCommitId: Last commit id.
`projectName` string	ProjectName: VSTS project name.
`repositoryName` string	RepositoryName: Repository name.
`rootFolder` string	RootFolder: Root folder.
`tenantId` string	TenantId: VSTS tenant id.
`type` FactoryVSTSConfiguration_Type_STATUS	Type: Type of repo configuration.

FactoryVSTSConfiguration_Type (`string` alias)

(Appears on:FactoryVSTSConfiguration)

Value	Description
"FactoryVSTSConfiguration"

FactoryVSTSConfiguration_Type_STATUS (`string` alias)

(Appears on:FactoryVSTSConfiguration_STATUS)

Value	Description
"FactoryVSTSConfiguration"

Factory_STATUS

(Appears on:Factory)

Factory resource type.

Field	Description
`additionalProperties` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`createTime` string	CreateTime: Time the factory was created in ISO8601 format.
`eTag` string	ETag: Etag identifies change in the resource.
`encryption` EncryptionConfiguration_STATUS	Encryption: Properties to enable Customer Managed Key for the factory.
`globalParameters` map[string]./api/datafactory/v1api20180601.GlobalParameterSpecification_STATUS	GlobalParameters: List of parameters for factory.
`id` string	Id: The resource identifier.
`identity` FactoryIdentity_STATUS	Identity: Managed service identity of the factory.
`location` string	Location: The resource location.
`name` string	Name: The resource name.
`provisioningState` string	ProvisioningState: Factory provisioning state, example Succeeded.
`publicNetworkAccess` FactoryProperties_PublicNetworkAccess_STATUS	PublicNetworkAccess: Whether or not public network access is allowed for the data factory.
`purviewConfiguration` PurviewConfiguration_STATUS	PurviewConfiguration: Purview information of the factory.
`repoConfiguration` FactoryRepoConfiguration_STATUS	RepoConfiguration: Git repo information of the factory.
`tags` map[string]string	Tags: The resource tags.
`type` string	Type: The resource type.
`version` string	Version: Version of the factory.

Factory_Spec

(Appears on:Factory)

Field	Description
`additionalProperties` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
`azureName` string	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.
`encryption` EncryptionConfiguration	Encryption: Properties to enable Customer Managed Key for the factory.
`globalParameters` map[string]./api/datafactory/v1api20180601.GlobalParameterSpecification	GlobalParameters: List of parameters for factory.
`identity` FactoryIdentity	Identity: Managed service identity of the factory.
`location` string	Location: The resource location.
`operatorSpec` FactoryOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`publicNetworkAccess` FactoryProperties_PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for the data factory.
`purviewConfiguration` PurviewConfiguration	PurviewConfiguration: Purview information of the factory.
`repoConfiguration` FactoryRepoConfiguration	RepoConfiguration: Git repo information of the factory.
`tags` map[string]string	Tags: The resource tags.

GitHubClientSecret

(Appears on:FactoryGitHubConfiguration)

Client secret information for factory’s bring your own app repository configuration.

Field	Description
`byoaSecretAkvUrl` string	ByoaSecretAkvUrl: Bring your own app client secret AKV URL.
`byoaSecretName` string	ByoaSecretName: Bring your own app client secret name in AKV.

GitHubClientSecret_STATUS

(Appears on:FactoryGitHubConfiguration_STATUS)

Client secret information for factory’s bring your own app repository configuration.

Field	Description
`byoaSecretAkvUrl` string	ByoaSecretAkvUrl: Bring your own app client secret AKV URL.
`byoaSecretName` string	ByoaSecretName: Bring your own app client secret name in AKV.

GlobalParameterSpecification

(Appears on:Factory_Spec)

Definition of a single parameter for an entity.

Field	Description
`type` GlobalParameterSpecification_Type	Type: Global Parameter type.
`value` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Value: Value of parameter.

GlobalParameterSpecification_STATUS

(Appears on:Factory_STATUS)

Definition of a single parameter for an entity.

Field	Description
`type` GlobalParameterSpecification_Type_STATUS	Type: Global Parameter type.
`value` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Value: Value of parameter.

GlobalParameterSpecification_Type (`string` alias)

(Appears on:GlobalParameterSpecification)

Value	Description
"Array"
"Bool"
"Float"
"Int"
"Object"
"String"

GlobalParameterSpecification_Type_STATUS (`string` alias)

(Appears on:GlobalParameterSpecification_STATUS)

Value	Description
"Array"
"Bool"
"Float"
"Int"
"Object"
"String"

PurviewConfiguration

(Appears on:Factory_Spec)

Purview configuration.

Field	Description
`purviewResourceReference` genruntime.ResourceReference	PurviewResourceReference: Purview resource id.

PurviewConfiguration_STATUS

(Appears on:Factory_STATUS)

Purview configuration.

Field	Description
`purviewResourceId` string	PurviewResourceId: Purview resource id.

UserAssignedIdentityDetails

(Appears on:FactoryIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

datafactory.azure.com/v1api20180601