BuildStepsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ContainerRegistryManagementClient's
<xref:build_steps> attribute.
- Inheritance
-
builtins.objectBuildStepsOperations
Constructor
BuildStepsOperations(*args, **kwargs)
Methods
begin_create |
Creates a build step for a build task. |
begin_delete |
Deletes a build step from the build task. |
begin_update |
Updates a build step in a build task. |
get |
Gets the build step for a build task. |
list |
List all the build steps for a given build task. |
list_build_arguments |
List the build arguments for a step including the secret arguments. |
begin_create
Creates a build step for a build task.
async begin_create(resource_group_name: str, registry_name: str, build_task_name: str, step_name: str, build_step_create_parameters: _models.BuildStep, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BuildStep]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
build_task_name
Required
|
The name of the container registry build task. Required. |
step_name
Required
|
The name of a build step for a container registry build task. Required. |
build_step_create_parameters
Required
|
The parameters for creating a build step. Is either a BuildStep type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either BuildStep or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Deletes a build step from the build task.
async begin_delete(resource_group_name: str, registry_name: str, build_task_name: str, step_name: str, **kwargs: Any) -> AsyncLROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
build_task_name
Required
|
The name of the container registry build task. Required. |
step_name
Required
|
The name of a build step for a container registry build task. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_update
Updates a build step in a build task.
async begin_update(resource_group_name: str, registry_name: str, build_task_name: str, step_name: str, build_step_update_parameters: _models.BuildStepUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BuildStep]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
build_task_name
Required
|
The name of the container registry build task. Required. |
step_name
Required
|
The name of a build step for a container registry build task. Required. |
build_step_update_parameters
Required
|
The parameters for updating a build step. Is either a BuildStepUpdateParameters type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either BuildStep or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets the build step for a build task.
async get(resource_group_name: str, registry_name: str, build_task_name: str, step_name: str, **kwargs: Any) -> BuildStep
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
build_task_name
Required
|
The name of the container registry build task. Required. |
step_name
Required
|
The name of a build step for a container registry build task. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
BuildStep or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
List all the build steps for a given build task.
list(resource_group_name: str, registry_name: str, build_task_name: str, **kwargs: Any) -> AsyncIterable[BuildStep]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
build_task_name
Required
|
The name of the container registry build task. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either BuildStep or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_build_arguments
List the build arguments for a step including the secret arguments.
list_build_arguments(resource_group_name: str, registry_name: str, build_task_name: str, step_name: str, **kwargs: Any) -> AsyncIterable[BuildArgument]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
build_task_name
Required
|
The name of the container registry build task. Required. |
step_name
Required
|
The name of a build step for a container registry build task. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either BuildArgument or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.containerregistry.v2018_02_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2018_02_01_preview\\models\\__init__.py'>
Azure SDK for Python