AzureSqlDatabaseDatastore Class

  • Reference

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
AbstractDatastore
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

workspace
str
Required

The workspace this datastore belongs to.

name
str
Required

The datastore name.

server_name
str
Required

The SQL server name

database_name
str
Required

The SQL database name

tenant_id
str
default value: None

The Directory ID/Tenant ID of the service principal.

client_id
str
default value: None

The Client ID/Application ID of the service principal.

client_secret
str
default value: None

The secret of the service principal.

resource_url
str, <xref:optional>
default value: None

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
str, <xref:optional>
default value: None

The authority URL used to authenticate the user. Defaults to https://login.microsoftonline.com.

username
str
default value: None

The username of the database user to access the database.

password
str
default value: None

The password of the database user to access the database.

workspace
str
Required

The workspace this datastore belongs to.

name
str
Required

The datastore name.

server_name
str
Required

The SQL server name

database_name
str
Required

The SQL database name

tenant_id
str
Required

The Directory ID/Tenant ID of the service principal.

client_id
str
Required

The Client ID/Application ID of the service principal.

client_secret
str
Required

The secret of the service principal.

resource_url
str, <xref:optional>
Required

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
str, <xref:optional>
Required

The authority URL used to authenticate the user. Defaults to https://login.microsoftonline.com.

username
str
Required

The username of the database user to access the database.

password
str
Required

The password of the database user to access the database.

auth_type
str
default value: None

The authentication type.

service_data_access_auth_identity
str or <xref:_restclient.models.ServiceDataAccessAuthIdentity>
default value: None

Indicates which identity to use to authenticate service data access to customer's storage. Possible values include: 'None', 'WorkspaceSystemAssignedIdentity', 'WorkspaceUserAssignedIdentity'