Skip to content

datafactory.v1beta1.linkedServiceAzureDatabricks

"LinkedServiceAzureDatabricks is the Schema for the LinkedServiceAzureDatabrickss API. Manages a Linked Service (connection) between Azure Databricks and Azure Data Factory."

Index

Fields

fn new

new(name)

new returns an instance of LinkedServiceAzureDatabricks

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"LinkedServiceAzureDatabricksSpec defines the desired state of LinkedServiceAzureDatabricks"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

obj spec.forProvider

obj spec.forProvider.newClusterConfig

"Creates new clusters within the linked ADB instance as defined in the new_cluster_config block below."

fn spec.forProvider.newClusterConfig.withClusterVersion

withClusterVersion(clusterVersion)

"Spark version of a the cluster."

fn spec.forProvider.newClusterConfig.withCustomTags

withCustomTags(customTags)

"Tags for the cluster resource."

fn spec.forProvider.newClusterConfig.withCustomTagsMixin

withCustomTagsMixin(customTags)

"Tags for the cluster resource."

Note: This function appends passed data to existing values

fn spec.forProvider.newClusterConfig.withDriverNodeType

withDriverNodeType(driverNodeType)

"Driver node type for the cluster."

fn spec.forProvider.newClusterConfig.withInitScripts

withInitScripts(initScripts)

"User defined initialization scripts for the cluster."

fn spec.forProvider.newClusterConfig.withInitScriptsMixin

withInitScriptsMixin(initScripts)

"User defined initialization scripts for the cluster."

Note: This function appends passed data to existing values

fn spec.forProvider.newClusterConfig.withLogDestination

withLogDestination(logDestination)

"Location to deliver Spark driver, worker, and event logs."

fn spec.forProvider.newClusterConfig.withMaxNumberOfWorkers

withMaxNumberOfWorkers(maxNumberOfWorkers)

"Specifies the maximum number of worker nodes. It should be between 1 and 25000."

fn spec.forProvider.newClusterConfig.withMinNumberOfWorkers

withMinNumberOfWorkers(minNumberOfWorkers)

"Specifies the minimum number of worker nodes. It should be between 1 and 25000. It defaults to 1."

fn spec.forProvider.newClusterConfig.withNodeType

withNodeType(nodeType)

"Node type for the new cluster."

fn spec.forProvider.newClusterConfig.withSparkConfig

withSparkConfig(sparkConfig)

"User-specified Spark configuration variables key-value pairs."

fn spec.forProvider.newClusterConfig.withSparkConfigMixin

withSparkConfigMixin(sparkConfig)

"User-specified Spark configuration variables key-value pairs."

Note: This function appends passed data to existing values

fn spec.forProvider.newClusterConfig.withSparkEnvironmentVariables

withSparkEnvironmentVariables(sparkEnvironmentVariables)

"User-specified Spark environment variables key-value pairs."

fn spec.forProvider.newClusterConfig.withSparkEnvironmentVariablesMixin

withSparkEnvironmentVariablesMixin(sparkEnvironmentVariables)

"User-specified Spark environment variables key-value pairs."

Note: This function appends passed data to existing values

fn spec.forProvider.withAdbDomain

withAdbDomain(adbDomain)

"The domain URL of the databricks instance."

fn spec.forProvider.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"A map of additional properties to associate with the Data Factory Linked Service."

fn spec.forProvider.withAdditionalPropertiesMixin

withAdditionalPropertiesMixin(additionalProperties)

"A map of additional properties to associate with the Data Factory Linked Service."

Note: This function appends passed data to existing values

fn spec.forProvider.withAnnotations

withAnnotations(annotations)

"List of tags that can be used for describing the Data Factory Linked Service."

fn spec.forProvider.withAnnotationsMixin

withAnnotationsMixin(annotations)

"List of tags that can be used for describing the Data Factory Linked Service."

Note: This function appends passed data to existing values

fn spec.forProvider.withDataFactoryId

withDataFactoryId(dataFactoryId)

"The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource."

fn spec.forProvider.withDescription

withDescription(description)

"The description for the Data Factory Linked Service."

fn spec.forProvider.withExistingClusterId

withExistingClusterId(existingClusterId)

"The cluster_id of an existing cluster within the linked ADB instance."

fn spec.forProvider.withInstancePool

withInstancePool(instancePool)

"Leverages an instance pool within the linked ADB instance as defined by instance_pool block below."

fn spec.forProvider.withInstancePoolMixin

withInstancePoolMixin(instancePool)

"Leverages an instance pool within the linked ADB instance as defined by instance_pool block below."

Note: This function appends passed data to existing values

fn spec.forProvider.withIntegrationRuntimeName

withIntegrationRuntimeName(integrationRuntimeName)

"The integration runtime reference to associate with the Data Factory Linked Service."

fn spec.forProvider.withKeyVaultPassword

withKeyVaultPassword(keyVaultPassword)

"Authenticate to ADB via Azure Key Vault Linked Service as defined in the key_vault_password block below."

fn spec.forProvider.withKeyVaultPasswordMixin

withKeyVaultPasswordMixin(keyVaultPassword)

"Authenticate to ADB via Azure Key Vault Linked Service as defined in the key_vault_password block below."

Note: This function appends passed data to existing values

fn spec.forProvider.withMsiWorkSpaceResourceId

withMsiWorkSpaceResourceId(msiWorkSpaceResourceId)

"Authenticate to ADB via managed service identity."

fn spec.forProvider.withNewClusterConfig

withNewClusterConfig(newClusterConfig)

"Creates new clusters within the linked ADB instance as defined in the new_cluster_config block below."

fn spec.forProvider.withNewClusterConfigMixin

withNewClusterConfigMixin(newClusterConfig)

"Creates new clusters within the linked ADB instance as defined in the new_cluster_config block below."

Note: This function appends passed data to existing values

fn spec.forProvider.withParameters

withParameters(parameters)

"A map of parameters to associate with the Data Factory Linked Service."

fn spec.forProvider.withParametersMixin

withParametersMixin(parameters)

"A map of parameters to associate with the Data Factory Linked Service."

Note: This function appends passed data to existing values

obj spec.forProvider.accessTokenSecretRef

"Authenticate to ADB via an access token."

fn spec.forProvider.accessTokenSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.accessTokenSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.accessTokenSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.dataFactoryIdRef

"Reference to a Factory in datafactory to populate dataFactoryId."

fn spec.forProvider.dataFactoryIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.dataFactoryIdRef.policy

"Policies for referencing."

fn spec.forProvider.dataFactoryIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.dataFactoryIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.dataFactoryIdSelector

"Selector for a Factory in datafactory to populate dataFactoryId."

fn spec.forProvider.dataFactoryIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.dataFactoryIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.dataFactoryIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.dataFactoryIdSelector.policy

"Policies for selection."

fn spec.forProvider.dataFactoryIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.dataFactoryIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.instancePool

"Leverages an instance pool within the linked ADB instance as defined by instance_pool block below."

fn spec.forProvider.instancePool.withClusterVersion

withClusterVersion(clusterVersion)

"Spark version of a the cluster."

fn spec.forProvider.instancePool.withInstancePoolId

withInstancePoolId(instancePoolId)

"Identifier of the instance pool within the linked ADB instance."

fn spec.forProvider.instancePool.withMaxNumberOfWorkers

withMaxNumberOfWorkers(maxNumberOfWorkers)

"The max number of worker nodes. Set this value if you want to enable autoscaling between the min_number_of_workers and this value. Omit this value to use a fixed number of workers defined in the min_number_of_workers property."

fn spec.forProvider.instancePool.withMinNumberOfWorkers

withMinNumberOfWorkers(minNumberOfWorkers)

"The minimum number of worker nodes. Defaults to 1."

obj spec.forProvider.keyVaultPassword

"Authenticate to ADB via Azure Key Vault Linked Service as defined in the key_vault_password block below."

fn spec.forProvider.keyVaultPassword.withLinkedServiceName

withLinkedServiceName(linkedServiceName)

"Specifies the name of an existing Key Vault Data Factory Linked Service."

fn spec.forProvider.keyVaultPassword.withSecretName

withSecretName(secretName)

"Specifies the secret name in Azure Key Vault that stores ADB access token."

obj spec.forProvider.msiWorkSpaceResourceIdRef

"Reference to a Workspace in databricks to populate msiWorkSpaceResourceId."

fn spec.forProvider.msiWorkSpaceResourceIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.msiWorkSpaceResourceIdRef.policy

"Policies for referencing."

fn spec.forProvider.msiWorkSpaceResourceIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.msiWorkSpaceResourceIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.msiWorkSpaceResourceIdSelector

"Selector for a Workspace in databricks to populate msiWorkSpaceResourceId."

fn spec.forProvider.msiWorkSpaceResourceIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.msiWorkSpaceResourceIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.msiWorkSpaceResourceIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.msiWorkSpaceResourceIdSelector.policy

"Policies for selection."

fn spec.forProvider.msiWorkSpaceResourceIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.msiWorkSpaceResourceIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."