SqlScriptOperations Class

SqlScriptOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

SqlScriptOperations

Constructor

SqlScriptOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

create_or_update_sql_script	Creates or updates a Sql Script.
delete_sql_script	Deletes a Sql Script.
get_sql_script	Gets a sql script.
get_sql_scripts_by_workspace	Lists sql scripts.

create_or_update_sql_script

Creates or updates a Sql Script.

create_or_update_sql_script(sql_script_name: str, properties: 'models.SqlScript', if_match: str | None = None, **kwargs: Any) -> models.SqlScriptResource

Parameters

Name	Description
sql_script_name Required	str The sql script name.
properties Required	SqlScript Properties of sql script.
if_match	str ETag of the SQL script entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SqlScriptResource	SqlScriptResource, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_sql_script

Deletes a Sql Script.

delete_sql_script(sql_script_name: str, **kwargs: Any) -> None

Parameters

Name	Description
sql_script_name Required	str The sql script name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_sql_script

Gets a sql script.

get_sql_script(sql_script_name: str, if_none_match: str | None = None, **kwargs: Any) -> 'models.SqlScriptResource' | None

Parameters

Name	Description
sql_script_name Required	str The sql script name.
if_none_match	str ETag of the sql compute entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SqlScriptResource, None	SqlScriptResource, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_sql_scripts_by_workspace

Lists sql scripts.

get_sql_scripts_by_workspace(**kwargs: Any) -> Iterable['models.SqlScriptsListResponse']

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[SqlScriptsListResponse]	An iterator like instance of either SqlScriptsListResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.synapse.artifacts.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\synapse\\artifacts\\models\\__init__.py'>