Share via

az acr artifact-streaming

  • Preview

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage artifact streaming for any repositories or supported images in an ACR.

Commands

Name Description Type Status
az acr artifact-streaming create

Create a referrers streaming artifact for a specific image in an ACR.

 Core Preview
az acr artifact-streaming operation

Manage the streaming artifact creation operations for ACR.

 Core Preview
az acr artifact-streaming operation cancel

Cancel the given streaming artifact operation for ACR.

 Core Preview
az acr artifact-streaming operation show

Check the operation status for artifact streaming in an ACR.

 Core Preview
az acr artifact-streaming show

Show if artifact streaming is enabled in a repository for an Azure Container Registry.

 Core Preview
az acr artifact-streaming update

Enable or disable auto-creation of streaming artifacts for newly pushed images under a given registry.

 Core Preview

az acr artifact-streaming create

Edit
Preview

Command group 'acr artifact-streaming' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a referrers streaming artifact for a specific image in an ACR.

az acr artifact-streaming create --image
                                 --name
                                 [--no-wait]
                                 [--password]
                                 [--suffix]
                                 [--username]

Examples

Create the streaming artifact of 'MyImage' in the registry 'myregistry'.

az acr artifact-streaming create -n myregistry -t MyImage

Required Parameters

--image -t

The name of the image. May include a tag in the format 'name:tag' or digest in the format 'name@digest'.

--name -n

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the run to complete and return immediately after queuing the run.

Property Value
Default value: False
--password -p

The password used to log into a container registry.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acr artifact-streaming show

Edit
Preview

Command group 'acr artifact-streaming' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show if artifact streaming is enabled in a repository for an Azure Container Registry.

az acr artifact-streaming show --name
                               --repository
                               [--password]
                               [--suffix]
                               [--username]

Examples

Get the repository 'MyRepo' streaming status.

az acr artifact-streaming show -n myregistry --repository MyRepo

Required Parameters

--name -n

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

--repository

The name of the repository.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--password -p

The password used to log into a container registry.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acr artifact-streaming update

Edit
Preview

Command group 'acr artifact-streaming' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Enable or disable auto-creation of streaming artifacts for newly pushed images under a given registry.

Enable or disable auto-creation of streaming artifacts for newly pushed images under a given registry. Note that whenever the flag is enabled, new images pushed into the selected registry will have auto-creation enabled and will be associated with the original image as a referrers artifact.

az acr artifact-streaming update --enable-streaming {false, true}
                                 --name
                                 --repository
                                 [--password]
                                 [--suffix]
                                 [--username]

Examples

Enable artifact streaming for 'MyRepository' associated with the registry 'myregistry'.

az acr artifact-streaming update -n myregistry --repository MyRepository --enable-streaming True

Disable artifact streaming for 'MyRepository' associated with the registry 'myregistry'.

az acr artifact-streaming update -n myregistry --repository MyRepository --enable-streaming False

Required Parameters

--enable-streaming

Indicates whether artifact streaming is enabled for a repository.

Property Value
Accepted values: false, true
--name -n

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

--repository

The name of the repository.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--password -p

The password used to log into a container registry.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False