ConnectionPropertiesV2 Class

Connection property base schema.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AADAuthTypeConnectionProperties, AccessKeyAuthTypeConnectionProperties, AccountKeyAuthTypeConnectionProperties, ApiKeyAuthConnectionProperties, CustomKeysConnectionProperties, ManagedIdentityAuthTypeConnectionProperties, NoneAuthTypeConnectionProperties, OAuth2AuthTypeConnectionProperties, PATAuthTypeConnectionProperties, SASAuthTypeConnectionProperties, ServicePrincipalAuthTypeConnectionProperties, UsernamePasswordAuthTypeConnectionProperties

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

ConnectionPropertiesV2(*, category: str | _models.ConnectionCategory | None = None, error: str | None = None, expiry_time: datetime | None = None, is_shared_to_all: bool | None = None, metadata: dict[str, str] | None = None, pe_requirement: str | _models.ManagedPERequirement | None = None, pe_status: str | _models.ManagedPEStatus | None = None, shared_user_list: list[str] | None = None, target: str | None = None, use_workspace_managed_identity: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
category	str or ConnectionCategory Category of the connection. Known values are: "PythonFeed", "ContainerRegistry", "Git", "S3", "Snowflake", "AzureSqlDb", "AzureSynapseAnalytics", "AzureMySqlDb", "AzurePostgresDb", "ADLSGen2", "Redis", "ApiKey", "AzureOpenAI", "AIServices", "CognitiveSearch", "CognitiveService", "CustomKeys", "AzureBlob", "AzureOneLake", "CosmosDb", "CosmosDbMongoDbApi", "AzureDataExplorer", "AzureMariaDb", "AzureDatabricksDeltaLake", "AzureSqlMi", "AzureTableStorage", "AmazonRdsForOracle", "AmazonRdsForSqlServer", "AmazonRedshift", "Db2", "Drill", "GoogleBigQuery", "Greenplum", "Hbase", "Hive", "Impala", "Informix", "MariaDb", "MicrosoftAccess", "MySql", "Netezza", "Oracle", "Phoenix", "PostgreSql", "Presto", "SapOpenHub", "SapBw", "SapHana", "SapTable", "Spark", "SqlServer", "Sybase", "Teradata", "Vertica", "Pinecone", "Cassandra", "Couchbase", "MongoDbV2", "MongoDbAtlas", "AmazonS3Compatible", "FileServer", "FtpServer", "GoogleCloudStorage", "Hdfs", "OracleCloudStorage", "Sftp", "GenericHttp", "ODataRest", "Odbc", "GenericRest", "AmazonMws", "Concur", "Dynamics", "DynamicsAx", "DynamicsCrm", "GoogleAdWords", "Hubspot", "Jira", "Magento", "Marketo", "Office365", "Eloqua", "Responsys", "OracleServiceCloud", "PayPal", "QuickBooks", "Salesforce", "SalesforceServiceCloud", "SalesforceMarketingCloud", "SapCloudForCustomer", "SapEcc", "ServiceNow", "SharePointOnlineList", "Shopify", "Square", "WebTable", "Xero", "Zoho", "GenericContainerRegistry", "Elasticsearch", "OpenAI", "Serp", "BingLLMSearch", "Serverless", "ManagedOnlineEndpoint", and "AzureStorageAccount". Default value: None
error	str Provides the error message if the connection fails. Default value: None
expiry_time	datetime Default value: None
is_shared_to_all	bool Default value: None
metadata	dict[str, str] Store user metadata for this connection. Default value: None
pe_requirement	str or ManagedPERequirement Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. Known values are: "Required", "NotRequired", and "NotApplicable". Default value: None
pe_status	str or ManagedPEStatus Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. Known values are: "Inactive", "Active", and "NotApplicable". Default value: None
shared_user_list	list[str] Default value: None
target	str The connection URL to be used. Default value: None
use_workspace_managed_identity	bool Default value: None

Variables

Name	Description
auth_type	str or ConnectionAuthType Authentication type of the connection target. Required. Known values are: "PAT", "ManagedIdentity", "UsernamePassword", "None", "SAS", "AccountKey", "ServicePrincipal", "AccessKey", "ApiKey", "CustomKeys", "OAuth2", and "AAD".
category	str or ConnectionCategory Category of the connection. Known values are: "PythonFeed", "ContainerRegistry", "Git", "S3", "Snowflake", "AzureSqlDb", "AzureSynapseAnalytics", "AzureMySqlDb", "AzurePostgresDb", "ADLSGen2", "Redis", "ApiKey", "AzureOpenAI", "AIServices", "CognitiveSearch", "CognitiveService", "CustomKeys", "AzureBlob", "AzureOneLake", "CosmosDb", "CosmosDbMongoDbApi", "AzureDataExplorer", "AzureMariaDb", "AzureDatabricksDeltaLake", "AzureSqlMi", "AzureTableStorage", "AmazonRdsForOracle", "AmazonRdsForSqlServer", "AmazonRedshift", "Db2", "Drill", "GoogleBigQuery", "Greenplum", "Hbase", "Hive", "Impala", "Informix", "MariaDb", "MicrosoftAccess", "MySql", "Netezza", "Oracle", "Phoenix", "PostgreSql", "Presto", "SapOpenHub", "SapBw", "SapHana", "SapTable", "Spark", "SqlServer", "Sybase", "Teradata", "Vertica", "Pinecone", "Cassandra", "Couchbase", "MongoDbV2", "MongoDbAtlas", "AmazonS3Compatible", "FileServer", "FtpServer", "GoogleCloudStorage", "Hdfs", "OracleCloudStorage", "Sftp", "GenericHttp", "ODataRest", "Odbc", "GenericRest", "AmazonMws", "Concur", "Dynamics", "DynamicsAx", "DynamicsCrm", "GoogleAdWords", "Hubspot", "Jira", "Magento", "Marketo", "Office365", "Eloqua", "Responsys", "OracleServiceCloud", "PayPal", "QuickBooks", "Salesforce", "SalesforceServiceCloud", "SalesforceMarketingCloud", "SapCloudForCustomer", "SapEcc", "ServiceNow", "SharePointOnlineList", "Shopify", "Square", "WebTable", "Xero", "Zoho", "GenericContainerRegistry", "Elasticsearch", "OpenAI", "Serp", "BingLLMSearch", "Serverless", "ManagedOnlineEndpoint", and "AzureStorageAccount".
created_by_workspace_arm_id	str
error	str Provides the error message if the connection fails.
expiry_time	datetime
group	str or ConnectionGroup Group based on connection category. Known values are: "Azure", "AzureAI", "Database", "NoSQL", "File", "GenericProtocol", and "ServicesAndApps".
is_shared_to_all	bool
metadata	dict[str, str] Store user metadata for this connection.
pe_requirement	str or ManagedPERequirement Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. Known values are: "Required", "NotRequired", and "NotApplicable".
pe_status	str or ManagedPEStatus Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. Known values are: "Inactive", "Active", and "NotApplicable".
shared_user_list	list[str]
target	str The connection URL to be used.
use_workspace_managed_identity	bool

Feedback

Was this page helpful?