ScriptsOperations Class

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

Constructor

ScriptsOperations(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

Creates a Kusto database script.

begin_delete

Deletes a Kusto principalAssignment.

begin_update

Updates a database script.

check_name_availability

Checks that the script name is valid and is not already in use.

get

Gets a Kusto cluster database script.

list_by_database

Returns the list of database scripts for given database.

begin_create_or_update

Creates a Kusto database script.

begin_create_or_update(resource_group_name: str, cluster_name: str, database_name: str, script_name: str, parameters: azure.mgmt.kusto.models._models_py3.Script, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.kusto.models._models_py3.Script]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

database_name
str
Required

The name of the database in the Kusto cluster.

script_name
str
Required

The name of the Kusto database script.

parameters
<xref:kusto_management_client.models.Script>
Required

The Kusto Script parameters contains the KQL to run.

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 ARMPolling. 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 Script or the result of cls(response)

Return type

LROPoller[<xref:kusto_management_client.models.Script>]

Exceptions

begin_delete

Deletes a Kusto principalAssignment.

begin_delete(resource_group_name: str, cluster_name: str, database_name: str, script_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

database_name
str
Required

The name of the database in the Kusto cluster.

script_name
str
Required

The name of the Kusto database script.

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 ARMPolling. 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

begin_update

Updates a database script.

begin_update(resource_group_name: str, cluster_name: str, database_name: str, script_name: str, parameters: azure.mgmt.kusto.models._models_py3.Script, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.kusto.models._models_py3.Script]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

database_name
str
Required

The name of the database in the Kusto cluster.

script_name
str
Required

The name of the Kusto database script.

parameters
<xref:kusto_management_client.models.Script>
Required

The Kusto Script parameters contains to the KQL to run.

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 ARMPolling. 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 Script or the result of cls(response)

Return type

LROPoller[<xref:kusto_management_client.models.Script>]

Exceptions

check_name_availability

Checks that the script name is valid and is not already in use.

check_name_availability(resource_group_name: str, cluster_name: str, database_name: str, script_name: azure.mgmt.kusto.models._models_py3.ScriptCheckNameRequest, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.CheckNameResult

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

database_name
str
Required

The name of the database in the Kusto cluster.

script_name
<xref:kusto_management_client.models.ScriptCheckNameRequest>
Required

The name of the script.

cls
callable

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

Returns

CheckNameResult, or the result of cls(response)

Return type

<xref:kusto_management_client.models.CheckNameResult>

Exceptions

get

Gets a Kusto cluster database script.

get(resource_group_name: str, cluster_name: str, database_name: str, script_name: str, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.Script

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

database_name
str
Required

The name of the database in the Kusto cluster.

script_name
str
Required

The name of the Kusto database script.

cls
callable

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

Returns

Script, or the result of cls(response)

Return type

<xref:kusto_management_client.models.Script>

Exceptions

list_by_database

Returns the list of database scripts for given database.

list_by_database(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> Iterable[azure.mgmt.kusto.models._models_py3.ScriptListResult]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

database_name
str
Required

The name of the database in the Kusto cluster.

cls
callable

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

Returns

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

Return type

ItemPaged[<xref:kusto_management_client.models.ScriptListResult>]

Exceptions

Attributes

models

models = <module 'azure.mgmt.kusto.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\kusto\\models\\__init__.py'>