DeploymentScriptsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:deployment_scripts> attribute.
- Inheritance
-
builtins.objectDeploymentScriptsOperations
Constructor
DeploymentScriptsOperations(*args, **kwargs)
Methods
begin_create |
Creates a deployment script. |
delete |
Deletes a deployment script. When operation completes, status code 200 returned without content. |
get |
Gets a deployment script with a given name. |
get_logs |
Gets deployment script logs for a given deployment script name. |
get_logs_default |
Gets deployment script logs for a given deployment script name. |
list_by_resource_group |
Lists deployments scripts. |
list_by_subscription |
Lists all deployment scripts for a given subscription. |
update |
Updates deployment script tags with specified values. |
begin_create
Creates a deployment script.
begin_create(resource_group_name: str, script_name: str, deployment_script: _models.DeploymentScript, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentScript]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
script_name
Required
|
Name of the deployment script. Required. |
deployment_script
Required
|
Deployment script supplied to the operation. Is either a DeploymentScript type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either DeploymentScript or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete
Deletes a deployment script. When operation completes, status code 200 returned without content.
delete(resource_group_name: str, script_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
script_name
Required
|
Name of the deployment script. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets a deployment script with a given name.
get(resource_group_name: str, script_name: str, **kwargs: Any) -> DeploymentScript
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
script_name
Required
|
Name of the deployment script. Required. |
Returns
Type | Description |
---|---|
DeploymentScript or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_logs
Gets deployment script logs for a given deployment script name.
get_logs(resource_group_name: str, script_name: str, **kwargs: Any) -> ScriptLogsList
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
script_name
Required
|
Name of the deployment script. Required. |
Returns
Type | Description |
---|---|
ScriptLogsList or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_logs_default
Gets deployment script logs for a given deployment script name.
get_logs_default(resource_group_name: str, script_name: str, tail: int | None = None, **kwargs: Any) -> ScriptLog
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
script_name
Required
|
Name of the deployment script. Required. |
tail
Required
|
The number of lines to show from the tail of the deployment script log. Valid value is a positive number up to 1000. If 'tail' is not provided, all available logs are shown up to container instance log capacity of 4mb. Default value is None. |
Returns
Type | Description |
---|---|
ScriptLog or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_resource_group
Lists deployments scripts.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[DeploymentScript]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either DeploymentScript or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_subscription
Lists all deployment scripts for a given subscription.
list_by_subscription(**kwargs: Any) -> Iterable[DeploymentScript]
Returns
Type | Description |
---|---|
An iterator like instance of either DeploymentScript or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update
Updates deployment script tags with specified values.
update(resource_group_name: str, script_name: str, deployment_script: _models.DeploymentScriptUpdateParameter | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentScript
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
script_name
Required
|
Name of the deployment script. Required. |
deployment_script
Required
|
Deployment script resource with the tags to be updated. Is either a DeploymentScriptUpdateParameter type or a IO[bytes] type. Default value is None. |
Returns
Type | Description |
---|---|
DeploymentScript or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.resource.deploymentscripts.v2019_10_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\deploymentscripts\\v2019_10_01_preview\\models\\__init__.py'>
Azure SDK for Python