Share via


az aosm sns

Note

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

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

Manage AOSM Site Network Services.

A Site Network Service (SNS) is a collection of network functions along with platform that come together to offer a service..

Commands

Name Description Type Status
az aosm sns build

Build the Site Network Service.

Extension Preview
az aosm sns deploy

Deploy the SNS definition.

Extension Preview
az aosm sns generate-config

Generate configuration file for building an AOSM SNS.

Extension Preview

az aosm sns build

Preview

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

Build the Site Network Service.

az aosm sns build --config-file

Required Parameters

--config-file -f

The path to the configuration file. This is a JSONC file that contains the required parameters for building the NSD.

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 aosm sns deploy

Preview

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

Deploy the SNS definition.

az aosm sns deploy --build-output-folder
                   [--no-subscription-permissions]

Required Parameters

--build-output-folder -b

Path to the folder to deploy, created by the build command.

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-subscription-permissions -u

Pass this flag if you do not have permission to import to the Publisher subscription (Contributor role + AcrPush role, or a custom role that allows the importImage action and AcrPush over the whole subscription). This means that the image artifacts will be pulled to your local machine and then pushed to the Artifact Store. Requires Docker to be installed locally.

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 aosm sns generate-config

Preview

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

Generate configuration file for building an AOSM SNS.

Generates a configuration file that you can use to build an AOSM Site Network Service (SNS). The configuration file is a JSONC file that contains the required parameters for building the SNS. You must complete the configuration file with your specific values before building the SNS.

az aosm sns generate-config [--output-file]

Examples

Generate a configuration file for a Site Network Service.

az aosm sns generate-config

Generate a configuration file for a Site Network Service and write to a specific file.

az aosm sns generate-config --output-file my-sns-input-config.jsonc

Optional Parameters

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

--output-file

The name of the output file to write the generated config text to.

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