az apr remote

  • Preview

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 remote command. Learn more about extensions.

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

Manage upstream remotes that repositories sync from.

Commands

Name Description Type Status
az apr remote create

Create a remote.

 Extension Preview
az apr remote delete

Delete a remote.

 Extension Preview
az apr remote list

List remotes.

 Extension Preview
az apr remote show

Show details for a remote.

 Extension Preview
az apr remote update

Update a remote.

 Extension Preview

az apr remote create

Preview

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

Create a remote.

az apr remote create --name
                     --registry
                     --type {apt, yum}
                     --url
                     [--acquire-policy-token]
                     [--architectures]
                     [--change-reference]
                     [--components]
                     [--no-wait]
                     [--policy {immediate, on-demand, streamed}]
                     [--releases]
                     [--resource-group]

Examples

Create an apt remote syncing selected distributions and components.

az apr remote create -g myrg -r myregistry -n myremote --type apt         --url http://archive.ubuntu.com/ubuntu         --releases jammy,focal --components main,universe

Create a yum remote.

az apr remote create -g myrg -r myregistry -n myremote --type yum         --url https://packages.microsoft.com/rhel/9/prod --policy on-demand

Required Parameters

--name -n

Name or ID of the remote.

--registry -r

Name of the parent APR registry.

--type

Remote type.

Property Value
Accepted values: apt, yum
--url

Upstream URL to sync from.

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
--architectures

Comma-separated architectures to sync (apt remotes only).

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--components

Comma-separated components to sync (apt remotes only).

--no-wait

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

Property Value
Default value: False
--policy

How packages are fetched from upstream. immediate downloads packages during sync; on-demand downloads and stores each package when first requested; streamed fetches each package on every request without storing it.

Property Value
Accepted values: immediate, on-demand, streamed
--releases

Comma-separated upstream releases to sync (apt remotes only).

--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 remote delete

Preview

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

Delete a remote.

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

Examples

Delete a remote by name.

az apr remote delete -g myrg -r myregistry -n myremote

Required Parameters

--name -n

Name or ID of the remote.

--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 remote list

Preview

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

List remotes.

az apr remote list --registry
                   [--limit]
                   [--resource-group]

Examples

List all remotes in a registry.

az apr remote list -g myrg -r myregistry

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 remotes to return. Omit to return all.

--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 remote show

Preview

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

Show details for a remote.

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

Examples

Show a remote by name.

az apr remote show -g myrg -r myregistry -n myremote

Required Parameters

--name -n

Name or ID of the remote.

--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 remote update

Preview

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

Update a remote.

az apr remote update --name
                     --registry
                     [--acquire-policy-token]
                     [--architectures]
                     [--change-reference]
                     [--components]
                     [--no-wait]
                     [--policy {immediate, on-demand, streamed}]
                     [--releases]
                     [--resource-group]
                     [--url]

Examples

Change the upstream URL a remote syncs from.

az apr remote update -g myrg -r myregistry -n myremote --url http://archive.ubuntu.com/ubuntu

Download packages only when clients request them.

az apr remote update -g myrg -r myregistry -n myremote --policy on-demand

Required Parameters

--name -n

Name or ID of the remote.

--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
--architectures

Comma-separated architectures to sync (apt remotes only).

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--components

Comma-separated components to sync (apt remotes only).

--no-wait

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

Property Value
Default value: False
--policy

How packages are fetched from upstream. immediate downloads packages during sync; on-demand downloads and stores each package when first requested; streamed fetches each package on every request without storing it.

Property Value
Accepted values: immediate, on-demand, streamed
--releases

Comma-separated upstream releases to sync (apt remotes only).

--resource-group -g

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

--url

Upstream URL to sync from.

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