az aosm nsd

  • Preview
  • Reference

Note

This reference is part of the aosm extension for the Azure CLI (version 2.45.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.

Commands

Name Description Type Status
az aosm nsd build

Build an AOSM Network Service Design.

 Extension Preview
az aosm nsd delete

Delete a published NSD.

 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

Preview

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

Build an AOSM Network Service Design.

az aosm nsd build --config-file
                  [--force]

Required Parameters

--config-file -f

The path to the configuration file.

Optional Parameters

--force

Force the build, even if the design has already been built.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aosm nsd delete

Preview

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

Delete a published NSD.

az aosm nsd delete --config-file
                   [--clean {false, true}]
                   [--force]

Required Parameters

--config-file -f

The path to the configuration file.

Optional Parameters

--clean

Also delete NSD Group. Use with care.

accepted values: false, true
default value: False
--force

If True, will not prompt for confirmation before deleting the resources.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aosm nsd 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 publisher Network Service Design.

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

Optional Parameters

--output-file

Path to output config file, defaults to "input.json".

default value: input.json
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aosm nsd publish

Preview

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.

az aosm nsd publish --config-file
                    [--design-file]
                    [--manifest-file]
                    [--manifest-params-file]
                    [--parameters-json-file]
                    [--skip {artifact-upload, bicep-publish}]

Required Parameters

--config-file -f

The path to the configuration file.

Optional Parameters

--design-file

Optional path to an override bicep template to deploy the NSDV.

--manifest-file

Optional path to an override bicep template to deploy manifests.

--manifest-params-file

Optional path to an override bicep parameters file for manifest parameters.

--parameters-json-file

Optional path to a parameters file for the bicep file, in case the user wants to edit the built NSDV template. If omitted, parameters from config will be turned into parameters for the bicep file.

--skip

Optional skip steps.

accepted values: artifact-upload, bicep-publish
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.