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
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
The path to the configuration file. This is a JSONC file that contains the required parameters for building the NSD.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az aosm sns deploy
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
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.
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az aosm sns generate-config
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.
The name of the output file to write the generated config text to.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |