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

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

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update_sql_script

Creates or updates a Sql Script.

begin_delete_sql_script

Deletes a Sql Script.

begin_rename_sql_script

Renames a sqlScript.

get_sql_script

Gets a sql script.

get_sql_scripts_by_workspace

Lists sql scripts.

begin_create_or_update_sql_script

Creates or updates a Sql Script.

begin_create_or_update_sql_script(sql_script_name, sql_script, if_match=None, **kwargs)

Parameters

sql_script_name
str
Required

The sql script name.

sql_script
SqlScriptResource
Required

Sql Script resource definition.

if_match
str
default value: None

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.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlScriptResource or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete_sql_script

Deletes a Sql Script.

begin_delete_sql_script(sql_script_name, **kwargs)

Parameters

sql_script_name
str
Required

The sql script name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_rename_sql_script

Renames a sqlScript.

begin_rename_sql_script(sql_script_name, new_name=None, **kwargs)

Parameters

sql_script_name
str
Required

The sql script name.

new_name
str
default value: None

New name of the artifact.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get_sql_script

Gets a sql script.

get_sql_script(sql_script_name, if_none_match=None, **kwargs)

Parameters

sql_script_name
str
Required

The sql script name.

if_none_match
str
default value: None

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.

cls
callable

A custom type or function that will be passed the direct response

Returns

SqlScriptResource, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get_sql_scripts_by_workspace

Lists sql scripts.

get_sql_scripts_by_workspace(**kwargs)

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlScriptsListResponse or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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