exec.azurerm.containerregistry.run

Azure Resource Manager (ARM) Container Registry Run Execution Module

New in version 3.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.containerregistry.run.cancel(hub, ctx, run_id, registry_name, resource_group, **kwargs)

New in version 3.0.0.

Cancel an existing run.

Parameters:
  • run_id – The run ID.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.

CLI Example:

azurerm.containerregistry.run.cancel id testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.run.get(hub, ctx, run_id, registry_name, resource_group, log_link=False, **kwargs)

New in version 3.0.0.

Gets the detailed information for a given run.

Parameters:
  • run_id – The run ID.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.
  • log_link – If True, gets a link to download the run logs.

CLI Example:

azurerm.containerregistry.run.get id testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.run.list_(hub, ctx, registry_name, resource_group, list_filter=None, limit=None, **kwargs)

New in version 3.0.0.

Lists all the runs for the specified container registry.

Parameters:
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.
  • list_filter – The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is ‘contains’. All logical operators except ‘Not’, ‘Has’, ‘All’ are allowed.
  • limit – Limits the maximum number of runs to return.

CLI Example:

azurerm.containerregistry.run.list testrepo testgroup
idem_azurerm.exec.azurerm.containerregistry.run.update(hub, ctx, run_id, registry_name, resource_group, is_archive_enabled=None, **kwargs)

New in version 3.0.0.

Patch the run properties.

Parameters:
  • run_id – The run ID.
  • registry_name – The name of the container registry.
  • resource_group – The name of the resource group to which the container registry belongs.
  • is_archive_enabled – The value that indicates whether archiving is enabled or not.

CLI Example:

azurerm.containerregistry.run.update id testrepo testgroup is_archive_enabled=False