azure.mgmt.containerregistry.v2018_02_01_preview.models module

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Action(value)[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.Actor(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The agent that initiated the event. For most situations, this could be from the authorization context of the request.

Parameters

name (str) – The subject or username associated with the request context that generated the event.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BaseImageDependency(*, type=None, registry: str = None, repository: str = None, tag: str = None, digest: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties that describe a base image dependency.

Parameters
  • type (str or BaseImageDependencyType) – The type of the base image dependency. Possible values include: ‘BuildTime’, ‘RunTime’

  • registry (str) – The registry login server.

  • repository (str) – The repository name.

  • tag (str) – The tag name.

  • digest (str) – The sha256-based digest of the image manifest.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BaseImageDependencyType(value)[source]

Bases: str, enum.Enum

An enumeration.

build_time = 'BuildTime'
run_time = 'RunTime'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.BaseImageTriggerType(value)[source]

Bases: str, enum.Enum

An enumeration.

all = 'All'
none = 'None'
runtime = 'Runtime'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.Build(*, build_id: str = None, status=None, last_updated_time=None, build_type=None, create_time=None, start_time=None, finish_time=None, output_images=None, build_task: str = None, image_update_trigger=None, git_commit_trigger=None, is_archive_enabled: bool = False, platform=None, provisioning_state=None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.ProxyResource

Build resource properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

Parameters
  • build_id (str) – The unique identifier for the build.

  • status (str or BuildStatus) – The current status of the build. Possible values include: ‘Queued’, ‘Started’, ‘Running’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Error’, ‘Timeout’

  • last_updated_time (datetime) – The last updated time for the build.

  • build_type (str or BuildType) – The type of build. Possible values include: ‘AutoBuild’, ‘QuickBuild’

  • create_time (datetime) – The time the build was created.

  • start_time (datetime) – The time the build started.

  • finish_time (datetime) – The time the build finished.

  • output_images (list[ImageDescriptor]) – The list of all images that were generated from the build.

  • build_task (str) – The build task with which the build was started.

  • image_update_trigger (ImageUpdateTrigger) – The image update trigger that caused the build.

  • git_commit_trigger (GitCommitTrigger) – The git commit trigger that caused the build.

  • is_archive_enabled (bool) – The value that indicates whether archiving is enabled or not. Default value: False .

  • platform (PlatformProperties) – The platform properties against which the build will happen.

  • provisioning_state (str or ProvisioningState) – The provisioning state of a build. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Canceled’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildArgument(*, name: str, value: str, is_secret: bool = False, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of a build argument.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

type (str) – Required. The type of the argument. Default value: “DockerBuildArgument” .

Parameters
  • name (str) – Required. The name of the argument.

  • value (str) – Required. The value of the argument.

  • is_secret (bool) – Flag to indicate whether the argument represents a secret and want to be removed from build logs. Default value: False .

type = 'DockerBuildArgument'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildArgumentPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BuildArgument object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildFilter(*, build_id: str = None, build_type=None, status=None, create_time=None, finish_time=None, output_image_manifests: str = None, is_archive_enabled: bool = None, build_task_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties that are enabled for Odata querying.

Parameters
  • build_id (str) – The unique identifier for the build.

  • build_type (str or BuildType) – The type of build. Possible values include: ‘AutoBuild’, ‘QuickBuild’

  • status (str or BuildStatus) – The current status of the build. Possible values include: ‘Queued’, ‘Started’, ‘Running’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Error’, ‘Timeout’

  • create_time (datetime) – The create time for a build.

  • finish_time (datetime) – The time the build finished.

  • output_image_manifests (str) – The list of comma-separated image manifests that were generated from the build.

  • is_archive_enabled (bool) – The value that indicates whether archiving is enabled or not.

  • build_task_name (str) – The name of the build task that the build corresponds to.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildGetLogResult(*, log_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The result of get log link operation.

Parameters

log_link (str) – The link to logs for a azure container registry build.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Build object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildStatus(value)[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
error = 'Error'
failed = 'Failed'
queued = 'Queued'
running = 'Running'
started = 'Started'
succeeded = 'Succeeded'
timeout = 'Timeout'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildStep(*, properties=None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.ProxyResource

Build step resource properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

Parameters

properties (BuildStepProperties) – The properties of a build step.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildStepPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BuildStep object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildStepProperties(**kwargs)[source]

Bases: msrest.serialization.Model

Base properties for any build step.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DockerBuildStep

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

provisioning_state (str or ProvisioningState) – The provisioning state of the build step. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Canceled’

Parameters

type (str) – Required. Constant filled by server.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildStepPropertiesUpdateParameters(**kwargs)[source]

Bases: msrest.serialization.Model

The properties for updating a build step.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DockerBuildStepUpdateParameters

All required parameters must be populated in order to send to Azure.

Parameters

type (str) – Required. Constant filled by server.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildStepUpdateParameters(*, properties=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters for updating a build step.

Parameters
class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildTask(*, location: str, alias: str, source_repository, platform, tags=None, status=None, timeout: int = 3600, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.Resource

The build task that has the resource properties and all build items. The build task will have all information to schedule a build against it.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the build task. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Canceled’

  • creation_date (datetime) – The creation date of build task.

Parameters
  • location (str) – Required. The location of the resource. This cannot be changed after the resource is created.

  • tags (dict[str, str]) – The tags of the resource.

  • alias (str) – Required. The alternative updatable name for a build task.

  • status (str or BuildTaskStatus) – The current status of build task. Possible values include: ‘Disabled’, ‘Enabled’

  • source_repository (SourceRepositoryProperties) – Required. The properties that describes the source(code) for the build task.

  • platform (PlatformProperties) – Required. The platform properties against which the build has to happen.

  • timeout (int) – Build timeout in seconds. Default value: 3600 .

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildTaskBuildRequest(*, build_task_name: str, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.QueueBuildRequest

The queue build parameters based on a build task.

All required parameters must be populated in order to send to Azure.

Parameters
  • type (str) – Required. Constant filled by server.

  • build_task_name (str) – Required. The name of build task against which build has to be queued.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildTaskFilter(*, alias: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The filter that can be used for listing build tasks.

Parameters

alias (str) – The alternative name for build task.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildTaskPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BuildTask object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildTaskStatus(value)[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildTaskUpdateParameters(*, alias: str = None, status=None, platform=None, timeout: int = None, source_repository=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters for updating a build task.

Parameters
  • alias (str) – The alternative updatable name for a build task.

  • status (str or BuildTaskStatus) – The current status of build task. Possible values include: ‘Disabled’, ‘Enabled’

  • platform (PlatformProperties) – The platform properties against which the build has to happen.

  • timeout (int) – Build timeout in seconds.

  • source_repository (SourceRepositoryUpdateParameters) – The properties that describes the source(code) for the build task.

  • tags (dict[str, str]) – The ARM resource tags.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildType(value)[source]

Bases: str, enum.Enum

An enumeration.

auto_build = 'AutoBuild'
quick_build = 'QuickBuild'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.BuildUpdateParameters(*, is_archive_enabled: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

The set of build properties that can be updated.

Parameters

is_archive_enabled (bool) – The value that indicates whether archiving is enabled or not.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.CallbackConfig(*, service_uri: str, custom_headers=None, **kwargs)[source]

Bases: msrest.serialization.Model

The configuration of service URI and custom headers for the webhook.

All required parameters must be populated in order to send to Azure.

Parameters
  • service_uri (str) – Required. The service URI for the webhook to post notifications.

  • custom_headers (dict[str, str]) – Custom headers that will be added to the webhook notifications.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.DefaultAction(value)[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
deny = 'Deny'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.DockerBuildStep(*, branch: str = None, image_names=None, is_push_enabled: bool = True, no_cache: bool = False, docker_file_path: str = None, context_path: str = None, build_arguments=None, base_image_trigger=None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.BuildStepProperties

The Docker build step.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • provisioning_state (str or ProvisioningState) – The provisioning state of the build step. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Canceled’

  • base_image_dependencies (list[BaseImageDependency]) – List of base image dependencies for a step.

Parameters
  • type (str) – Required. Constant filled by server.

  • branch (str) – The repository branch name.

  • image_names (list[str]) – The fully qualified image names including the repository and tag.

  • is_push_enabled (bool) – The value of this property indicates whether the image built should be pushed to the registry or not. Default value: True .

  • no_cache (bool) – The value of this property indicates whether the image cache is enabled or not. Default value: False .

  • docker_file_path (str) – The Docker file path relative to the source control root.

  • context_path (str) – The relative context path for a docker build in the source.

  • build_arguments (list[BuildArgument]) – The custom arguments for building this build step.

  • base_image_trigger (str or BaseImageTriggerType) – The type of the auto trigger for base image dependency updates. Possible values include: ‘All’, ‘Runtime’, ‘None’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.DockerBuildStepUpdateParameters(*, branch: str = None, image_names=None, is_push_enabled: bool = None, no_cache: bool = None, docker_file_path: str = None, context_path: str = None, build_arguments=None, base_image_trigger=None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.BuildStepPropertiesUpdateParameters

The properties for updating a docker build step.

All required parameters must be populated in order to send to Azure.

Parameters
  • type (str) – Required. Constant filled by server.

  • branch (str) – The repository branch name.

  • image_names (list[str]) – The fully qualified image names including the repository and tag.

  • is_push_enabled (bool) – The value of this property indicates whether the image built should be pushed to the registry or not.

  • no_cache (bool) – The value of this property indicates whether the image cache is enabled or not.

  • docker_file_path (str) – The Docker file path relative to the source control root.

  • context_path (str) – The relative context path for a docker build in the source.

  • build_arguments (list[BuildArgument]) – The custom arguments for building this build step.

  • base_image_trigger (str or BaseImageTriggerType) – The type of the auto trigger for base image dependency updates. Possible values include: ‘All’, ‘Runtime’, ‘None’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Event(*, id: str = None, event_request_message=None, event_response_message=None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.EventInfo

The event for a webhook.

Parameters
  • id (str) – The event ID.

  • event_request_message (EventRequestMessage) – The event request message sent to the service URI.

  • event_response_message (EventResponseMessage) – The event response message received from the service URI.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.EventContent(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]

Bases: msrest.serialization.Model

The content of the event request message.

Parameters
  • id (str) – The event ID.

  • timestamp (datetime) – The time at which the event occurred.

  • action (str) – The action that encompasses the provided event.

  • target (Target) – The target of the event.

  • request (Request) – The request that generated the event.

  • actor (Actor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.

  • source (Source) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.EventInfo(*, id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The basic information of an event.

Parameters

id (str) – The event ID.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.EventPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Event object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.EventRequestMessage(*, content=None, headers=None, method: str = None, request_uri: str = None, version: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The event request message sent to the service URI.

Parameters
  • content (EventContent) – The content of the event request message.

  • headers (dict[str, str]) – The headers of the event request message.

  • method (str) – The HTTP method used to send the event request message.

  • request_uri (str) – The URI used to send the event request message.

  • version (str) – The HTTP message version.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.EventResponseMessage(*, content: str = None, headers=None, reason_phrase: str = None, status_code: str = None, version: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The event response message received from the service URI.

Parameters
  • content (str) – The content of the event response message.

  • headers (dict[str, str]) – The headers of the event response message.

  • reason_phrase (str) – The reason phrase of the event response message.

  • status_code (str) – The status code of the event response message.

  • version (str) – The HTTP message version.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.GitCommitTrigger(*, id: str = None, commit_id: str = None, repository_url: str = None, branch_name: str = None, provider_type: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The git commit trigger that caused a build.

Parameters
  • id (str) – The unique ID of the trigger.

  • commit_id (str) – The unique ID that identifies a commit.

  • repository_url (str) – The repository URL.

  • branch_name (str) – The branch name in the repository.

  • provider_type (str) – The source control provider type.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.IPRule(*, ip_address_or_range: str, action='Allow', **kwargs)[source]

Bases: msrest.serialization.Model

IP rule with specific IP or IP range in CIDR format.

All required parameters must be populated in order to send to Azure.

Parameters
  • action (str or Action) – The action of IP ACL rule. Possible values include: ‘Allow’. Default value: “Allow” .

  • ip_address_or_range (str) – Required. Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.ImageDescriptor(*, registry: str = None, repository: str = None, tag: str = None, digest: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties for a registry image.

Parameters
  • registry (str) – The registry login server.

  • repository (str) – The repository name.

  • tag (str) – The tag name.

  • digest (str) – The sha256-based digest of the image manifest.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.ImageUpdateTrigger(*, id: str = None, timestamp=None, images=None, **kwargs)[source]

Bases: msrest.serialization.Model

The image update trigger that caused a build.

Parameters
  • id (str) – The unique ID of the trigger.

  • timestamp (datetime) – The timestamp when the image update happened.

  • images (list[ImageDescriptor]) – The list of image updates that caused the build.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.ImportImageParameters(*, source, target_tags=None, untagged_target_repositories=None, mode='NoForce', **kwargs)[source]

Bases: msrest.serialization.Model

ImportImageParameters.

All required parameters must be populated in order to send to Azure.

Parameters
  • source (ImportSource) – Required. The source of the image.

  • target_tags (list[str]) – List of strings of the form repo[:tag]. When tag is omitted the source will be used (or ‘latest’ if source tag is also omitted).

  • untagged_target_repositories (list[str]) – List of strings of repository names to do a manifest only copy. No tag will be created.

  • mode (str or ImportMode) – When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins. Possible values include: ‘NoForce’, ‘Force’. Default value: “NoForce” .

class azure.mgmt.containerregistry.v2018_02_01_preview.models.ImportMode(value)[source]

Bases: str, enum.Enum

An enumeration.

force = 'Force'
no_force = 'NoForce'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.ImportSource(*, source_image: str, resource_id: str = None, registry_uri: str = None, credentials=None, **kwargs)[source]

Bases: msrest.serialization.Model

ImportSource.

All required parameters must be populated in order to send to Azure.

Parameters
  • resource_id (str) – The resource identifier of the source Azure Container Registry.

  • registry_uri (str) – The address of the source registry (e.g. ‘mcr.microsoft.com’).

  • credentials (ImportSourceCredentials) – Credentials used when importing from a registry uri.

  • source_image (str) – Required. Repository name of the source image. Specify an image by repository (‘hello-world’). This will use the ‘latest’ tag. Specify an image by tag (‘hello-world:latest’). Specify an image by sha256-based manifest digest (‘hello-world@sha256:abc123’).

class azure.mgmt.containerregistry.v2018_02_01_preview.models.ImportSourceCredentials(*, password: str, username: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

ImportSourceCredentials.

All required parameters must be populated in order to send to Azure.

Parameters
  • username (str) – The username to authenticate with the source registry.

  • password (str) – Required. The password used to authenticate with the source registry.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.NetworkRuleSet(*, default_action='Allow', virtual_network_rules=None, ip_rules=None, **kwargs)[source]

Bases: msrest.serialization.Model

The network rule set for a container registry.

All required parameters must be populated in order to send to Azure.

Parameters
  • default_action (str or DefaultAction) – Required. The default action of allow or deny when no other rules match. Possible values include: ‘Allow’, ‘Deny’. Default value: “Allow” .

  • virtual_network_rules (list[VirtualNetworkRule]) – The virtual network rules.

  • ip_rules (list[IPRule]) – The IP ACL rules.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.OperationDefinition(*, origin: str = None, name: str = None, display=None, service_specification=None, **kwargs)[source]

Bases: msrest.serialization.Model

The definition of a container registry operation.

Parameters
  • origin (str) – The origin information of the container registry operation.

  • name (str) – Operation name: {provider}/{resource}/{operation}.

  • display (OperationDisplayDefinition) – The display information for the container registry operation.

  • service_specification (OperationServiceSpecificationDefinition) – The definition of Azure Monitoring service.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.OperationDefinitionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of OperationDefinition object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.OperationDisplayDefinition(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The display information for a container registry operation.

Parameters
  • provider (str) – The resource provider name: Microsoft.ContainerRegistry.

  • resource (str) – The resource on which the operation is performed.

  • operation (str) – The operation that users can perform.

  • description (str) – The description for the operation.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.OperationMetricSpecificationDefinition(*, name: str = None, display_name: str = None, display_description: str = None, unit: str = None, aggregation_type: str = None, internal_metric_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The definition of Azure Monitoring metric.

Parameters
  • name (str) – Metric name.

  • display_name (str) – Metric display name.

  • display_description (str) – Metric description.

  • unit (str) – Metric unit.

  • aggregation_type (str) – Metric aggregation type.

  • internal_metric_name (str) – Internal metric name.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.OperationServiceSpecificationDefinition(*, metric_specifications=None, **kwargs)[source]

Bases: msrest.serialization.Model

The definition of Azure Monitoring metrics list.

Parameters

metric_specifications (list[OperationMetricSpecificationDefinition]) – A list of Azure Monitoring metrics definition.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.OsType(value)[source]

Bases: str, enum.Enum

An enumeration.

linux = 'Linux'
windows = 'Windows'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.PasswordName(value)[source]

Bases: str, enum.Enum

An enumeration.

password = 'password'
password2 = 'password2'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.PlatformProperties(*, os_type, cpu: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

The platform properties against which the build has to happen.

All required parameters must be populated in order to send to Azure.

Parameters
  • os_type (str or OsType) – Required. The operating system type required for the build. Possible values include: ‘Windows’, ‘Linux’

  • cpu (int) – The CPU configuration in terms of number of cores required for the build.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.PolicyStatus(value)[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'disabled'
enabled = 'enabled'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.ProvisioningState(value)[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.ProxyResource(**kwargs)[source]

Bases: msrest.serialization.Model

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.QuarantinePolicy(*, status=None, **kwargs)[source]

Bases: msrest.serialization.Model

An object that represents quarantine policy for a container registry.

Parameters

status (str or PolicyStatus) – The value that indicates whether the policy is enabled or not. Possible values include: ‘enabled’, ‘disabled’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.QueueBuildRequest(**kwargs)[source]

Bases: msrest.serialization.Model

The queue build request parameters.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BuildTaskBuildRequest, QuickBuildRequest

All required parameters must be populated in order to send to Azure.

Parameters

type (str) – Required. Constant filled by server.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.QuickBuildRequest(*, source_location: str, platform, docker_file_path: str, image_names=None, build_arguments=None, is_push_enabled: bool = True, no_cache: bool = False, timeout: int = 3600, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.QueueBuildRequest

The queue build request parameters for a quick build.

All required parameters must be populated in order to send to Azure.

Parameters
  • type (str) – Required. Constant filled by server.

  • image_names (list[str]) – The fully qualified image names including the repository and tag.

  • source_location (str) – Required. The URL(absolute or relative) of the source that needs to be built. For Docker build, it can be an URL to a tar or github repository as supported by Docker. If it is relative URL, the relative path should be obtained from calling getSourceUploadUrl API.

  • build_arguments (list[BuildArgument]) – The collection of build arguments to be used.

  • is_push_enabled (bool) – The value of this property indicates whether the image built should be pushed to the registry or not. Default value: True .

  • no_cache (bool) – The value of this property indicates whether the image cache is enabled or not. Default value: False .

  • timeout (int) – Build timeout in seconds. Default value: 3600 .

  • platform (PlatformProperties) – Required. The platform properties against which the build will happen.

  • docker_file_path (str) – Required. The Docker file path relative to the source location.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegenerateCredentialParameters(*, name, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters used to regenerate the login credential.

All required parameters must be populated in order to send to Azure.

Parameters

name (str or PasswordName) – Required. Specifies name of the password which should be regenerated – password or password2. Possible values include: ‘password’, ‘password2’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Registry(*, location: str, sku, tags=None, admin_user_enabled: bool = False, storage_account=None, network_rule_set=None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.Resource

An object that represents a container registry.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • login_server (str) – The URL that can be used to log into the container registry.

  • creation_date (datetime) – The creation date of the container registry in ISO8601 format.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the container registry at the time the operation was called. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Canceled’

  • status (Status) – The status of the container registry at the time the operation was called.

Parameters
  • location (str) – Required. The location of the resource. This cannot be changed after the resource is created.

  • tags (dict[str, str]) – The tags of the resource.

  • sku (Sku) – Required. The SKU of the container registry.

  • admin_user_enabled (bool) – The value that indicates whether the admin user is enabled. Default value: False .

  • storage_account (StorageAccountProperties) – The properties of the storage account for the container registry. Only applicable to Classic SKU.

  • network_rule_set (NetworkRuleSet) – The network rule set for a container registry.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryListCredentialsResult(*, username: str = None, passwords=None, **kwargs)[source]

Bases: msrest.serialization.Model

The response from the ListCredentials operation.

Parameters
  • username (str) – The username for a container registry.

  • passwords (list[RegistryPassword]) – The list of passwords for a container registry.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryNameCheckRequest(*, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

A request to check whether a container registry name is available.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

name (str) – Required. The name of the container registry.

Variables

type (str) – Required. The resource type of the container registry. This field must be set to ‘Microsoft.ContainerRegistry/registries’. Default value: “Microsoft.ContainerRegistry/registries” .

type = 'Microsoft.ContainerRegistry/registries'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryNameStatus(*, name_available: bool = None, reason: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The result of a request to check the availability of a container registry name.

Parameters
  • name_available (bool) – The value that indicates whether the name is available.

  • reason (str) – If any, the reason that the name is not available.

  • message (str) – If any, the error message that provides more detail for the reason that the name is not available.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Registry object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryPassword(*, name=None, value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The login password for the container registry.

Parameters
  • name (str or PasswordName) – The password name. Possible values include: ‘password’, ‘password2’

  • value (str) – The password value.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryPolicies(*, quarantine_policy=None, trust_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

An object that represents policies for a container registry.

Parameters
  • quarantine_policy (QuarantinePolicy) – An object that represents quarantine policy for a container registry.

  • trust_policy (TrustPolicy) – An object that represents content trust policy for a container registry.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryUpdateParameters(*, tags=None, sku=None, admin_user_enabled: bool = None, storage_account=None, network_rule_set=None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters for updating a container registry.

Parameters
  • tags (dict[str, str]) – The tags for the container registry.

  • sku (Sku) – The SKU of the container registry.

  • admin_user_enabled (bool) – The value that indicates whether the admin user is enabled.

  • storage_account (StorageAccountProperties) – The parameters of a storage account for the container registry. Only applicable to Classic SKU. If specified, the storage account must be in the same physical location as the container registry.

  • network_rule_set (NetworkRuleSet) – The network rule set for a container registry.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryUsage(*, name: str = None, limit: int = None, current_value: int = None, unit=None, **kwargs)[source]

Bases: msrest.serialization.Model

The quota usage for a container registry.

Parameters
  • name (str) – The name of the usage.

  • limit (long) – The limit of the usage.

  • current_value (long) – The current value of the usage.

  • unit (str or RegistryUsageUnit) – The unit of measurement. Possible values include: ‘Count’, ‘Bytes’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryUsageListResult(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The result of a request to get container registry quota usages.

Parameters

value (list[RegistryUsage]) – The list of container registry quota usages.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.RegistryUsageUnit(value)[source]

Bases: str, enum.Enum

An enumeration.

bytes = 'Bytes'
count = 'Count'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.Replication(*, location: str, tags=None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.Resource

An object that represents a replication for a container registry.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the replication at the time the operation was called. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Canceled’

  • status (Status) – The status of the replication at the time the operation was called.

Parameters
  • location (str) – Required. The location of the resource. This cannot be changed after the resource is created.

  • tags (dict[str, str]) – The tags of the resource.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.ReplicationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Replication object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.ReplicationUpdateParameters(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters for updating a replication.

Parameters

tags (dict[str, str]) – The tags for the replication.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Request(*, id: str = None, addr: str = None, host: str = None, method: str = None, useragent: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The request that generated the event.

Parameters
  • id (str) – The ID of the request that initiated the event.

  • addr (str) – The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.

  • host (str) – The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.

  • method (str) – The request method that generated the event.

  • useragent (str) – The user agent header of the request.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Resource(*, location: str, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

An Azure resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

Parameters
  • location (str) – Required. The location of the resource. This cannot be changed after the resource is created.

  • tags (dict[str, str]) – The tags of the resource.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Sku(*, name, **kwargs)[source]

Bases: msrest.serialization.Model

The SKU of a container registry.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

name (str or SkuName) – Required. The SKU name of the container registry. Required for registry creation. Possible values include: ‘Classic’, ‘Basic’, ‘Standard’, ‘Premium’

Variables

tier (str or SkuTier) – The SKU tier based on the SKU name. Possible values include: ‘Classic’, ‘Basic’, ‘Standard’, ‘Premium’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.SkuName(value)[source]

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'
classic = 'Classic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.SkuTier(value)[source]

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'
classic = 'Classic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.Source(*, addr: str = None, instance_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.

Parameters
  • addr (str) – The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port.

  • instance_id (str) – The running instance of an application. Changes after each restart.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.SourceControlAuthInfo(*, token: str, token_type=None, refresh_token: str = None, scope: str = None, expires_in: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

The authorization properties for accessing the source code repository.

All required parameters must be populated in order to send to Azure.

Parameters
  • token_type (str or TokenType) – The type of Auth token. Possible values include: ‘PAT’, ‘OAuth’

  • token (str) – Required. The access token used to access the source control provider.

  • refresh_token (str) – The refresh token used to refresh the access token.

  • scope (str) – The scope of the access token.

  • expires_in (int) – Time in seconds that the token remains valid

class azure.mgmt.containerregistry.v2018_02_01_preview.models.SourceControlType(value)[source]

Bases: str, enum.Enum

An enumeration.

github = 'Github'
visual_studio_team_service = 'VisualStudioTeamService'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.SourceRepositoryProperties(*, source_control_type, repository_url: str, is_commit_trigger_enabled: bool = False, source_control_auth_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties of the source code repository.

All required parameters must be populated in order to send to Azure.

Parameters
  • source_control_type (str or SourceControlType) – Required. The type of source control service. Possible values include: ‘Github’, ‘VisualStudioTeamService’

  • repository_url (str) – Required. The full URL to the source code repository

  • is_commit_trigger_enabled (bool) – The value of this property indicates whether the source control commit trigger is enabled or not. Default value: False .

  • source_control_auth_properties (SourceControlAuthInfo) – The authorization properties for accessing the source code repository.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.SourceRepositoryUpdateParameters(*, source_control_auth_properties=None, is_commit_trigger_enabled: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties for updating the source code repository configuration.

Parameters
  • source_control_auth_properties (SourceControlAuthInfo) – The authorization properties for accessing the source code repository.

  • is_commit_trigger_enabled (bool) – The value of this property indicates whether the source control commit trigger is enabled or not.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.SourceUploadDefinition(*, upload_url: str = None, relative_path: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties of a response to source upload request.

Parameters
  • upload_url (str) – The URL where the client can upload the source.

  • relative_path (str) – The relative path to the source. This is used to submit the subsequent queue build request.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Status(**kwargs)[source]

Bases: msrest.serialization.Model

The status of an Azure resource at the time the operation was called.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • display_status (str) – The short label for the status.

  • message (str) – The detailed message for the status, including alerts and error messages.

  • timestamp (datetime) – The timestamp when the status was changed to the current value.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.StorageAccountProperties(*, id: str, **kwargs)[source]

Bases: msrest.serialization.Model

The properties of a storage account for a container registry. Only applicable to Classic SKU.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. The resource ID of the storage account.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Target(*, media_type: str = None, size: int = None, digest: str = None, length: int = None, repository: str = None, url: str = None, tag: str = None, name: str = None, version: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The target of the event.

Parameters
  • media_type (str) – The MIME type of the referenced object.

  • size (long) – The number of bytes of the content. Same as Length field.

  • digest (str) – The digest of the content, as defined by the Registry V2 HTTP API Specification.

  • length (long) – The number of bytes of the content. Same as Size field.

  • repository (str) – The repository name.

  • url (str) – The direct URL to the content.

  • tag (str) – The tag name.

  • name (str) – The name of the artifact.

  • version (str) – The version of the artifact.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.TokenType(value)[source]

Bases: str, enum.Enum

An enumeration.

oauth = 'OAuth'
pat = 'PAT'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.TrustPolicy(*, type=None, status=None, **kwargs)[source]

Bases: msrest.serialization.Model

An object that represents content trust policy for a container registry.

Parameters
  • type (str or TrustPolicyType) – The type of trust policy. Possible values include: ‘Notary’

  • status (str or PolicyStatus) – The value that indicates whether the policy is enabled or not. Possible values include: ‘enabled’, ‘disabled’

class azure.mgmt.containerregistry.v2018_02_01_preview.models.TrustPolicyType(value)[source]

Bases: str, enum.Enum

An enumeration.

notary = 'Notary'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.VirtualNetworkRule(*, virtual_network_resource_id: str, action='Allow', **kwargs)[source]

Bases: msrest.serialization.Model

Virtual network rule.

All required parameters must be populated in order to send to Azure.

Parameters
  • action (str or Action) – The action of virtual network rule. Possible values include: ‘Allow’. Default value: “Allow” .

  • virtual_network_resource_id (str) – Required. Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.Webhook(*, location: str, actions, tags=None, status=None, scope: str = None, **kwargs)[source]

Bases: azure.mgmt.containerregistry.v2018_02_01_preview.models._models_py3.Resource

An object that represents a webhook for a container registry.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the webhook at the time the operation was called. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Canceled’

Parameters
  • location (str) – Required. The location of the resource. This cannot be changed after the resource is created.

  • tags (dict[str, str]) – The tags of the resource.

  • status (str or WebhookStatus) – The status of the webhook at the time the operation was called. Possible values include: ‘enabled’, ‘disabled’

  • scope (str) – The scope of repositories where the event can be triggered. For example, ‘foo:*’ means events for all tags under repository ‘foo’. ‘foo:bar’ means events for ‘foo:bar’ only. ‘foo’ is equivalent to ‘foo:latest’. Empty means all events.

  • actions (list[str or WebhookAction]) – Required. The list of actions that trigger the webhook to post notifications.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.WebhookAction(value)[source]

Bases: str, enum.Enum

An enumeration.

chart_delete = 'chart_delete'
chart_push = 'chart_push'
delete = 'delete'
push = 'push'
quarantine = 'quarantine'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.WebhookCreateParameters(*, location: str, service_uri: str, actions, tags=None, custom_headers=None, status=None, scope: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters for creating a webhook.

All required parameters must be populated in order to send to Azure.

Parameters
  • tags (dict[str, str]) – The tags for the webhook.

  • location (str) – Required. The location of the webhook. This cannot be changed after the resource is created.

  • service_uri (str) – Required. The service URI for the webhook to post notifications.

  • custom_headers (dict[str, str]) – Custom headers that will be added to the webhook notifications.

  • status (str or WebhookStatus) – The status of the webhook at the time the operation was called. Possible values include: ‘enabled’, ‘disabled’

  • scope (str) – The scope of repositories where the event can be triggered. For example, ‘foo:*’ means events for all tags under repository ‘foo’. ‘foo:bar’ means events for ‘foo:bar’ only. ‘foo’ is equivalent to ‘foo:latest’. Empty means all events.

  • actions (list[str or WebhookAction]) – Required. The list of actions that trigger the webhook to post notifications.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.WebhookPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Webhook object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.containerregistry.v2018_02_01_preview.models.WebhookStatus(value)[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'disabled'
enabled = 'enabled'
class azure.mgmt.containerregistry.v2018_02_01_preview.models.WebhookUpdateParameters(*, tags=None, service_uri: str = None, custom_headers=None, status=None, scope: str = None, actions=None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters for updating a webhook.

Parameters
  • tags (dict[str, str]) – The tags for the webhook.

  • service_uri (str) – The service URI for the webhook to post notifications.

  • custom_headers (dict[str, str]) – Custom headers that will be added to the webhook notifications.

  • status (str or WebhookStatus) – The status of the webhook at the time the operation was called. Possible values include: ‘enabled’, ‘disabled’

  • scope (str) – The scope of repositories where the event can be triggered. For example, ‘foo:*’ means events for all tags under repository ‘foo’. ‘foo:bar’ means events for ‘foo:bar’ only. ‘foo’ is equivalent to ‘foo:latest’. Empty means all events.

  • actions (list[str or WebhookAction]) – The list of actions that trigger the webhook to post notifications.