AzureSqlDatabaseDatastore Class
Represents a datastore that saves connection information to Azure SQL Database.
You should not work with this class directly. To create a datastore that saves connection information to Azure SQL Database, use the register_azure_sql_database method of the Datastore class.
Note: When using a datastore to access data, you must have permission to access the data, which depends on the credentials registered with the datastore.
Initialize a new Azure SQL Database Datastore.
- Inheritance
-
AzureSqlDatabaseDatastore
Constructor
AzureSqlDatabaseDatastore(workspace, name, server_name, database_name, tenant_id=None, client_id=None, client_secret=None, resource_url=None, authority_url=None, username=None, password=None, auth_type=None, service_data_access_auth_identity=None)
Parameters
Name | Description |
---|---|
workspace
Required
|
The workspace this datastore belongs to. |
name
Required
|
The datastore name. |
server_name
Required
|
The SQL server name |
database_name
Required
|
The SQL database name |
tenant_id
|
The Directory ID/Tenant ID of the service principal. default value: None
|
client_id
|
The Client ID/Application ID of the service principal. default value: None
|
client_secret
|
The secret of the service principal. default value: None
|
resource_url
|
str, <xref:optional>
The resource URL, which determines what operations will be performed on the SQL database store. If None, defaults to https://database.windows.net/. default value: None
|
authority_url
|
str, <xref:optional>
The authority URL used to authenticate the user. Defaults to https://login.microsoftonline.com. default value: None
|
username
|
The username of the database user to access the database. default value: None
|
password
|
The password of the database user to access the database. default value: None
|
workspace
Required
|
The workspace this datastore belongs to. |
name
Required
|
The datastore name. |
server_name
Required
|
The SQL server name |
database_name
Required
|
The SQL database name |
tenant_id
Required
|
The Directory ID/Tenant ID of the service principal. |
client_id
Required
|
The Client ID/Application ID of the service principal. |
client_secret
Required
|
The secret of the service principal. |
resource_url
Required
|
str, <xref:optional>
The resource URL, which determines what operations will be performed on the SQL database store. If None, defaults to https://database.windows.net/. |
authority_url
Required
|
str, <xref:optional>
The authority URL used to authenticate the user. Defaults to https://login.microsoftonline.com. |
username
Required
|
The username of the database user to access the database. |
password
Required
|
The password of the database user to access the database. |
auth_type
|
The authentication type. default value: None
|
service_data_access_auth_identity
|
str or
<xref:_restclient.models.ServiceDataAccessAuthIdentity>
Indicates which identity to use to authenticate service data access to customer's storage. Possible values include: 'None', 'WorkspaceSystemAssignedIdentity', 'WorkspaceUserAssignedIdentity' default value: None
|
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for