azure.mgmt.imagebuilder.operations module

class azure.mgmt.imagebuilder.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ImageBuilderClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.imagebuilder.models._models_py3.Operation][source]

Lists available operations for the Microsoft.VirtualMachineImages provider.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Operation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.imagebuilder.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-imagebuilder/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/imagebuilder/models/__init__.py'>
class azure.mgmt.imagebuilder.operations.VirtualMachineImageTemplatesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ImageBuilderClient’s virtual_machine_image_templates attribute.

begin_cancel(resource_group_name: str, image_template_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Cancel the long running image build based on the image template.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, image_template_name: str, parameters: _models.ImageTemplate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImageTemplate][source]
begin_create_or_update(resource_group_name: str, image_template_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImageTemplate]

Create or update a virtual machine image template.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

  • parameters (ImageTemplate or IO) – Parameters supplied to the CreateImageTemplate operation. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ImageTemplate or the result of cls(response)

Return type

LROPoller[ImageTemplate]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, image_template_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Delete a virtual machine image template.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_run(resource_group_name: str, image_template_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Create artifacts from a existing image template.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, image_template_name: str, parameters: _models.ImageTemplateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImageTemplate][source]
begin_update(resource_group_name: str, image_template_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImageTemplate]

Update the tags for this Virtual Machine Image Template.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

  • parameters (ImageTemplateUpdateParameters or IO) – Additional parameters for Image Template update. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ImageTemplate or the result of cls(response)

Return type

LROPoller[ImageTemplate]

Raises

HttpResponseError –

get(resource_group_name: str, image_template_name: str, **kwargs: Any) → azure.mgmt.imagebuilder.models._models_py3.ImageTemplate[source]

Get information about a virtual machine image template.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ImageTemplate or the result of cls(response)

Return type

ImageTemplate

Raises

HttpResponseError –

get_run_output(resource_group_name: str, image_template_name: str, run_output_name: str, **kwargs: Any) → azure.mgmt.imagebuilder.models._models_py3.RunOutput[source]

Get the specified run output for the specified image template resource.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

  • run_output_name (str) – The name of the run output. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RunOutput or the result of cls(response)

Return type

RunOutput

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.imagebuilder.models._models_py3.ImageTemplate][source]

Gets information about the VM image templates associated with the subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ImageTemplate]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.imagebuilder.models._models_py3.ImageTemplate][source]

Gets information about the VM image templates associated with the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ImageTemplate]

Raises

HttpResponseError –

list_run_outputs(resource_group_name: str, image_template_name: str, **kwargs: Any) → Iterable[azure.mgmt.imagebuilder.models._models_py3.RunOutput][source]

List all run outputs for the specified Image Template resource.

Parameters

  • resource_group_name (str) – The name of the resource group. Required.

  • image_template_name (str) – The name of the image Template. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[RunOutput]

Raises

HttpResponseError –

models = <module 'azure.mgmt.imagebuilder.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-imagebuilder/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/imagebuilder/models/__init__.py'>