az apr distro

Note

This reference is part of the apr extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az apr distro command. Learn more about extensions.

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

Manage distributions that serve a repository's content.

Commands

Name	Description	Type	Status
az apr distro create	Create a distribution.	Extension	Preview
az apr distro delete	Delete a distribution.	Extension	Preview
az apr distro list	List distributions.	Extension	Preview
az apr distro show	Show details for a distribution.	Extension	Preview
az apr distro update	Update a distribution.	Extension	Preview

az apr distro create

Preview

Command group 'apr distro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a distribution.

az apr distro create --base-path
                     --name
                     --registry
                     --type {apt, file, yum}
                     [--acquire-policy-token]
                     [--change-reference]
                     [--hidden {false, true}]
                     [--no-wait]
                     [--publication]
                     [--repository]
                     [--resource-group]

Examples

Create an apt distribution serving a repository.

az apr distro create -g myrg -r myregistry -n mydistro         --type apt --base-path dists/stable --repository myrepo

Required Parameters

--base-path

Base path the distribution is served at.

--name -n

Name or ID of the distribution.

--registry -r

Name of the parent APR registry.

--type

Distribution type.

Property	Value
Accepted values:	apt, file, yum

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--hidden

Mark the distribution as hidden.

Property	Value
Accepted values:	false, true

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--publication

ID of a specific publication to serve as a fixed snapshot. Cannot be used with --repository.

--repository

Name or ID of the repository to serve. The distribution follows the repository's latest publication automatically. Cannot be used with --publication.

--resource-group -g

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

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 apr distro delete

Preview

Command group 'apr distro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a distribution.

az apr distro delete --name
                     --registry
                     [--acquire-policy-token]
                     [--change-reference]
                     [--no-wait]
                     [--resource-group]
                     [--yes]

Examples

Delete a distribution by name.

az apr distro delete -g myrg -r myregistry -n mydistro

Required Parameters

--name -n

Name or ID of the distribution.

--registry -r

Name of the parent APR registry.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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 apr distro list

Preview

Command group 'apr distro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List distributions.

az apr distro list --registry
                   [--limit]
                   [--repository]
                   [--resource-group]

Examples

List all distributions in a registry.

az apr distro list -g myrg -r myregistry

List distributions serving a given repository.

az apr distro list -g myrg -r myregistry --repository myrepo

Required Parameters

--registry -r

Name of the parent APR registry.

Optional Parameters

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

--limit

Max number of distributions to return. Omit to return all.

--repository

Name or ID of a repository to filter distributions by.

--resource-group -g

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

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 apr distro show

Preview

Command group 'apr distro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details for a distribution.

az apr distro show --name
                   --registry
                   [--resource-group]

Examples

Show a distribution by name.

az apr distro show -g myrg -r myregistry -n mydistro

Required Parameters

--name -n

Name or ID of the distribution.

--registry -r

Name of the parent APR registry.

Optional Parameters

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

--resource-group -g

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

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 apr distro update

Preview

Command group 'apr distro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a distribution.

az apr distro update --name
                     --registry
                     [--acquire-policy-token]
                     [--base-path]
                     [--change-reference]
                     [--hidden {false, true}]
                     [--no-wait]
                     [--publication]
                     [--repository]
                     [--resource-group]

Examples

Change the base path a distribution is served at.

az apr distro update -g myrg -r myregistry -n mydistro --base-path dists/next

Required Parameters

--name -n

Name or ID of the distribution.

--registry -r

Name of the parent APR registry.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--base-path

Base path the distribution is served at.

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--hidden

Mark the distribution as hidden.

Property	Value
Accepted values:	false, true

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--publication

ID of a specific publication to serve as a fixed snapshot. Cannot be used with --repository.

--repository

Name or ID of the repository to serve. The distribution follows the repository's latest publication automatically. Cannot be used with --publication.

--resource-group -g

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

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