ScriptsOperations Class
ScriptsOperations async 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.objectScriptsOperations
Constructor
ScriptsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
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.
async 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._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.Script]Parameters
- parameters
- <xref:kusto_management_client.models.Script>
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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either Script or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a Kusto principalAssignment.
async begin_delete(resource_group_name: str, cluster_name: str, database_name: str, script_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Updates a database script.
async 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._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.Script]Parameters
- parameters
- <xref:kusto_management_client.models.Script>
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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either Script or the result of cls(response)
Return type
Exceptions
check_name_availability
Checks that the script name is valid and is not already in use.
async 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.CheckNameResultParameters
- script_name
- <xref:kusto_management_client.models.ScriptCheckNameRequest>
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
Exceptions
get
Gets a Kusto cluster database script.
async get(resource_group_name: str, cluster_name: str, database_name: str, script_name: str, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.ScriptParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Script, or the result of cls(response)
Return type
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) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.ScriptListResult]Parameters
- 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
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'>Feedback
Submit and view feedback for