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: Commands to manage Azure container registries.

Subgroups:
    credential: Manage administrator 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 available 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
    --location -l       [Required]: Location.
    --name -n           [Required]: The name of the container registry.
    --resource-group -g [Required]: Name of resource group.
    --admin-enabled               : Indicates whether the admin user is enabled.
                                    Allowed values: false, true.  Default: false.
    --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 -l southcentralus

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.

List container registries

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

Arguments
    --resource-group -g: Name of resource group.

Examples
    List container registries and show result in a table
        az acr list -o table
    List container registries in a resource group and show result 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.

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.
    --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 storage account for a container registry
        az acr update -n myRegistry --storage-account-name myStorageAccount
    Enable admin user 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 administrator login credentials for the specified container registry.

Arguments
    --name -n [Required]: The name of the container registry.
    --resource-group -g : Name of resource group.

Regenerate login credentials for a container registry

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

Arguments
    --name -n [Required]: The name of the container registry.
    --resource-group -g : Name of resource group.

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 if admin user is enabled
        az acr repository list -n myRegistry
    List repositories in a given container registry with credentials
        az acr repository list -n myRegistry -u myUsername -p myPassword

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 if admin user is enabled
        az acr repository show-tags -n myRegistry --repository myRepository
    Show tags of a given repository in a given container registry with credentials
        az acr repository show-tags -n myRegistry --repository myRepository -u myUsername -p myPassword

Release History

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-0.1.1b5.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

azure_cli_acr-0.1.1b5-py2.py3-none-any.whl (18.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file azure-cli-acr-0.1.1b5.tar.gz.

File metadata

File hashes

Hashes for azure-cli-acr-0.1.1b5.tar.gz
Algorithm Hash digest
SHA256 1b29c56ec9827038a66a1ef07ee205f79299beea8accde2e2b22e6ce84cbd07a
MD5 a548c38e6323e9d36b320f9f067d9276
BLAKE2b-256 c61cec2418f6446afa44d9f96a5dac606d7b9ab572e8b31b628fe96a2cf2c6e0

See more details on using hashes here.

File details

Details for the file azure_cli_acr-0.1.1b5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for azure_cli_acr-0.1.1b5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0992b0b4f796d89a5a73fbe8414ae128e51fd9ff1da51a338239dac146ae5009
MD5 817091ff2a66990e79e208e671e82889
BLAKE2b-256 52cd220f847a6fde3d3d7f37f0030b9bdfd16b97c500a27ca0f43643a1667a7a

See more details on using hashes here.

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