az aosm nfd
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 nfd 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 Function Definitions.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az aosm nfd build |
Build an AOSM Network Function Definition. |
Extension | Preview |
| az aosm nfd delete |
Delete AOSM Network Function Definition. |
Extension | Preview |
| az aosm nfd generate-config |
Generate configuration file for building an AOSM publisher Network Function Definition. |
Extension | Preview |
| az aosm nfd publish |
Publish a pre-built AOSM Network Function definition. |
Extension | Preview |
az aosm nfd build
Command group 'aosm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Build an AOSM Network Function Definition.
az aosm nfd build --config-file
--definition-type {cnf, vnf}
[--force]
[--interactive {false, true}]
[--order-params {false, true}]Required Parameters
The path to the configuration file.
Type of AOSM definition.
Optional Parameters
Force the build even if the design has already been built.
Prompt user to choose every parameter to expose as an NFD parameter. Those without defaults are automatically included.
VNF definition_type only - ignored for CNF. Order deploymentParameters schema and configMappings to have the parameters without default values at the top and those with default values at the bottom. Can make it easier to remove those with defaults which you do not want to expose as NFD parameters.
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 nfd delete
Command group 'aosm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete AOSM Network Function Definition.
az aosm nfd delete --config-file
--definition-type {cnf, vnf}
[--clean {false, true}]
[--force]Required Parameters
The path to the configuration file.
Type of AOSM definition.
Optional Parameters
Also delete artifact stores, NFD Group and Publisher. Use with care.
If True, will not prompt for confirmation before deleting the resources.
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 nfd 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 Function Definition.
az aosm nfd generate-config --definition-type {cnf, vnf}
[--output-file]Required Parameters
Type of AOSM definition.
Optional Parameters
Path to output config file, defaults to "input.json".
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 nfd 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 Function definition.
az aosm nfd publish --config-file
--definition-type {cnf, vnf}
[--definition-file]
[--manifest-file]
[--manifest-params-file]
[--no-subscription-permissions {false, true}]
[--parameters-file]
[--skip {artifact-upload, bicep-publish, image-upload}]Required Parameters
The path to the configuration file.
Type of AOSM definition.
Optional Parameters
Optional path to a bicep file to publish. Use to override publish of the built definition with an alternative file.
Optional path to a bicep file to publish manifests. Use to override publish of the built definition with an alternative file.
Optional path to a parameters file for the manifest definition file. Use to override publish of the built definition and config with alternative parameters.
CNF definition_type publish only - ignored for VNF. Set to True 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.
Optional path to a parameters file for the bicep definition file. Use to override publish of the built definition and config with alternative parameters.
Optional skip steps. 'bicep-publish' will skip deploying the bicep template; 'artifact-upload' will skip uploading any artifacts; 'image-upload' will skip uploading the VHD image (for VNFs) or the container images (for CNFs).
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for