Skip to main content

Microsoft Azure Command-Line Tools ACR Command Module

Project description

Microsoft Azure CLI ‘acr’ Command Module

Commands to manage Azure container registries

Group
    az acr: Manage Azure container registries.

Subgroups:
    credential: Manage login credentials for Azure container registries.
    repository: Manage repositories for Azure container registries.

Commands:
    check-name: Checks whether the container registry name is available for use.
    create    : Creates a container registry.
    delete    : Deletes a container registry.
    list      : Lists all the container registries under the current subscription.
    show      : Gets the properties of the specified container registry.
    update    : Updates a container registry.

Create a container registry

Command
    az acr create: Creates a container registry.

Arguments
    --name -n           [Required]: The name of the container registry.
    --resource-group -g [Required]: Name of resource group. You can configure the default group
                                    using 'az configure --defaults group=<name>'.
    --sku               [Required]: The SKU of the container registry.  Allowed values: Basic.
    --admin-enabled               : Indicates whether the admin user is enabled.  Allowed values:
                                    false, true.
    --location -l                 : Location. You can configure the default location using 'az
                                    configure --defaults location=<location>'.
    --storage-account-name        : Default: A new storage account will be created. Provide the name
                                    of an existing storage account if you're recreating a container
                                    registry over a previous registry created storage account.

Examples
    Create a container registry with a new storage account.
        az acr create -n MyRegistry -g MyResourceGroup --sku Basic

Delete a container registry

Command
    az acr delete: Deletes a container registry.

Arguments
    --name -n [Required]: The name of the container registry.
    --resource-group -g : Name of resource group. You can configure the default group using 'az
                        configure --defaults group=<name>'.

Examples
    Delete a container registry
        az acr delete -n MyRegistry

List container registries

Command
    az acr list: Lists all the container registries under the current subscription.

Arguments
    --resource-group -g: Name of resource group. You can configure the default group using 'az
                        configure --defaults group=<name>'.

Examples
    List container registries and show the results in a table.
        az acr list -o table

    List container registries in a resource group and show the results in a table.
        az acr list -g MyResourceGroup -o table

Get a container registry

Command
    az acr show: Gets the properties of the specified container registry.

Arguments
    --name -n [Required]: The name of the container registry.
    --resource-group -g : Name of resource group. You can configure the default group using 'az
                        configure --defaults group=<name>'.

Examples
    Get the login server for a container registry.
        az acr show -n MyRegistry --query loginServer

Update a container registry

Command
    az acr update: Updates a container registry.

Arguments
    --name -n   [Required]: The name of the container registry.
    --admin-enabled       : Indicates whether the admin user is enabled.  Allowed values: false,
                            true.
    --resource-group -g   : Name of resource group. You can configure the default group using 'az
                            configure --defaults group=<name>'.
    --storage-account-name: Provide the name of an existing storage account if you're recreating a
                            container registry over a previous registry created storage account.
    --tags                : Space separated tags in 'key[=value]' format. Use "" to clear existing
                            tags.

Generic Update Arguments
    --add                 : Add an object to a list of objects by specifying a path and key value
                            pairs.  Example: --add property.listProperty <key=value, string or JSON
                            string>.
    --remove              : Remove a property or an element from a list.  Example: --remove
                            property.list <indexToRemove> OR --remove propertyToRemove.
    --set                 : Update an object by specifying a property path and value to set.
                            Example: --set property1.property2=<value>.

Examples
    Update tags for a container registry.
        az acr update -n MyRegistry --tags key1=value1 key2=value2

    Update the storage account for a container registry.
        az acr update -n MyRegistry --storage-account-name MyStorageAccount

    Enable the administrator user account for a container registry.
        az acr update -n MyRegistry --admin-enabled true

Get login credentials for a container registry

Command
    az acr credential show: Gets the login credentials for the specified container registry.

Arguments
    --name -n [Required]: The name of the container registry.
    --resource-group -g : Name of resource group. You can configure the default group using 'az
                        configure --defaults group=<name>'.

Examples
    Get the login credentials for a container registry.
        az acr credential show -n MyRegistry

    Get the username used to log into a container registry.
        az acr credential show -n MyRegistry --query username

    Get one of the passwords used to log into a container registry.
        az acr credential show -n MyRegistry --query passwords[0].value

Regenerate login credentials for a container registry

Command
    az acr credential renew: Regenerates one of the login credentials for the specified container
    registry.

Arguments
    --name -n       [Required]: The name of the container registry.
    --password-name [Required]: The name of password to regenerate.  Allowed values: password,
                                password2.
    --resource-group -g       : Name of resource group. You can configure the default group using
                                'az configure --defaults group=<name>'.

Examples
    Renew the second password for a container registry.
        az acr credential renew -n MyRegistry --password-name password2

List repositories in a given container registry

Command
    az acr repository list: Lists repositories in the specified container registry.

Arguments
    --name -n [Required]: The name of the container registry.
    --password -p       : The password used to log into a container registry.
    --username -u       : The username used to log into a container registry.

Examples
    List repositories in a given container registry. Enter login credentials in the prompt if admin
    user is disabled.
        az acr repository list -n MyRegistry

Show tags of a given repository in a given container registry

Command
    az acr repository show-tags: Shows tags of a given repository in the specified container
    registry.

Arguments
    --name -n    [Required]: The name of the container registry.
    --repository [Required]: The repository to obtain tags from.
    --password -p          : The password used to log into a container registry.
    --username -u          : The username used to log into a container registry.

Examples
    Show tags of a given repository in a given container registry. Enter login credentials in the
    prompt if admin user is disabled.
        az acr repository show-tags -n MyRegistry --repository MyRepository

Release History

2.0.5 (2017-05-30)

  • Minor fixes.

2.0.4 (2017-05-09)

  • Minor fixes.

2.0.3 (2017-05-05)

  • Minor fixes.

2.0.2 (2017-04-28)

  • New packaging system.

2.0.1 (2017-04-17)

  • Apply core changes required for API profile support (#2834) & JSON string parsing from shell (#2705)

2.0.0 (2017-04-03)

  • Module is GA.

  • [ACR] Update to 2017-03-01 api-version (#2563)

0.1.1b5 (2017-03-13)

  • –admin-enabled no longer requires an input value

0.1.1b4 (2017-02-22)

  • Documentation fixes.

0.1.1b3 (2017-02-17)

  • Polish error messages for repository/credential commands

  • Storage account sku validation

  • Show commands return empty string with exit code 0 for 404 responses

0.1.1b2 (2017-01-30)

  • Support Python 3.6.

  • Fix storage account name with capital letters.

0.1.1b1 (2017-01-17)

  • Update ACR SDK version to 0.1.1

  • Add tty check before prompting for user input

  • Enable storage account encryption by default

0.1.0b11 (2016-12-12)

  • Preview release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

azure-cli-acr-2.0.5.tar.gz (11.2 kB view hashes)

Uploaded Source

Built Distribution

azure_cli_acr-2.0.5-py2.py3-none-any.whl (19.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page