az aosm nsd
Note
This reference is part of the aosm extension for the Azure CLI (version 2.54.0 or higher). The extension will automatically install the first time you run an az aosm nsd 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 publisher Network Service Designs.
A Network Service Design (NSD) is a collection of Network Function Definitions (NFD) and any supporting infrastructure that define a network service. This command group allows you to build and publish NSDs to Azure.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az aosm nsd build |
Build an AOSM Network Service Design. |
Extension | Preview |
| az aosm nsd generate-config |
Generate configuration file for building an AOSM publisher Network Service Design. |
Extension | Preview |
| az aosm nsd publish |
Publish a pre-built AOSM Network Service Design. |
Extension | Preview |
az aosm nsd build
Command group 'aosm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Build an AOSM Network Service Design.
Builds an AOSM Network Service Design (NSD) based on the configuration file provided. The NSD is built from the Network Function Definitions (NFD) and ARM templates specifying supporting infrastructure, as specified in the configuration file. The output is a directory which can either be published directly (using the aosm nsd publish command) or manually customized before publishing.
az aosm nsd build --config-fileExamples
Build a Network Service Design.
az aosm nsd build --config-file my-nsd-input-config.jsoncRequired 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.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az aosm nsd 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 publisher Network Service Design.
Generates a configuration file that you can use to build an AOSM Network Service Design (NSD). The configuration file is a JSONC file that contains the required parameters for building the NSD. You must complete the configuration file with your specific values before building the NSD.
az aosm nsd generate-config [--output-file]Examples
Generate a configuration file for a Network Service Design.
az aosm nsd generate-configGenerate a configuration file for a Network Service Design and write to a specific file.
az aosm nsd generate-config --output-file my-nsd-input-config.jsoncOptional Parameters
The name of the output file to write the generated config text to.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az aosm nsd publish
Command group 'aosm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Publish a pre-built AOSM Network Service Design.
Publishes a pre-built AOSM Network Service Design (NSD) to Azure. The NSD must be built using the aosm nsd build command before it can be published. The NSD and other required resources (publisher resource, artifact manifest(s), storage account(s) etc.) is published to the specified resource group in the currently active Azure subscription.
az aosm nsd publish --build-output-folder
[--no-subscription-permissions]Examples
Publish a Network Service Design.
az aosm nsd publish --build-output-folder my-nsd-output-folderRequired Parameters
Path to the folder to publish, created by the build command.
Optional Parameters
CNF definition_type publish only - ignored for VNF. 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.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
