az mobile-network sim policy

  • Reference

Note

This reference is part of the mobile-network extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az mobile-network sim policy command. Learn more about extensions.

Manage sim policy.

Commands

Name Description Type Status
az mobile-network sim policy create

Create a SIM policy.

 Extension GA
az mobile-network sim policy delete

Delete the specified SIM policy.

 Extension GA
az mobile-network sim policy list

List all the SIM policies in a mobile network.

 Extension GA
az mobile-network sim policy show

Get information about the specified SIM policy.

 Extension GA
az mobile-network sim policy update

Update a SIM policy.

 Extension GA
az mobile-network sim policy wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az mobile-network sim policy create

Create a SIM policy.

az mobile-network sim policy create --default-slice
                                    --mobile-network-name
                                    --name
                                    --resource-group
                                    --slice-config
                                    --ue-ambr
                                    [--location]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--registration-timer]
                                    [--rfsp-index]
                                    [--tags]

Examples

Create sim policy

az mobile-network sim policy create -g rg -n sim-policy-name --mobile-network-name mobile-network-name --default-slice '{id:slice-id}' --slice-config "[{slice:{id:slice-id},defaultDataNetwork:{id:data-network-id},dataNetworkConfigurations:[{dataNetwork:{id:data-network-id},allowedServices:[{id:service-id}],sessionAmbr:{uplink:'500 Mbps',downlink:'1 Gbps'}}]}]" --ue-ambr "{uplink:'500 Mbps',downlink:'1 Gbps'}"

Required Parameters

--default-slice

The default slice to use if the UE does not explicitly specify it. This slice must exist in the sliceConfigurations map. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--mobile-network-name

The name of the mobile network.

--name --sim-policy-name -n

The name of the SIM policy.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--slice-config

The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ue-ambr

Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--registration-timer

Interval for the UE periodic registration update procedure, in seconds.

Default value: 3240
--rfsp-index

RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 mobile-network sim policy delete

Delete the specified SIM policy.

az mobile-network sim policy delete [--ids]
                                    [--mobile-network-name]
                                    [--name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

Examples

Delete sim policy

az mobile-network sim policy delete -g rg -n sim-policy-name --mobile-network-name mobile-network-name

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--mobile-network-name

The name of the mobile network.

--name --sim-policy-name -n

The name of the SIM policy.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

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 mobile-network sim policy list

List all the SIM policies in a mobile network.

az mobile-network sim policy list --mobile-network-name
                                  --resource-group
                                  [--max-items]
                                  [--next-token]

Examples

List sim policy by resource group

az mobile-network sim policy list -g rg --mobile-network-name mobile-network-name

Required Parameters

--mobile-network-name

The name of the mobile network.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 mobile-network sim policy show

Get information about the specified SIM policy.

az mobile-network sim policy show [--ids]
                                  [--mobile-network-name]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Show sim policy

az mobile-network sim policy show -g rg -n sim-policy-name --mobile-network-name mobile-network-name

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--mobile-network-name

The name of the mobile network.

--name --sim-policy-name -n

The name of the SIM policy.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 mobile-network sim policy update

Update a SIM policy.

az mobile-network sim policy update [--add]
                                    [--default-slice]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--mobile-network-name]
                                    [--name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--registration-timer]
                                    [--remove]
                                    [--resource-group]
                                    [--rfsp-index]
                                    [--set]
                                    [--slice-config]
                                    [--subscription]
                                    [--tags]
                                    [--ue-ambr]

Examples

Update sim policy tags

az mobile-network sim policy update -g rg-n sim-policy-name --mobile-network-name mobile-network-name --tags "{tag:test,tag2:test2}"

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--default-slice

The default slice to use if the UE does not explicitly specify it. This slice must exist in the sliceConfigurations map. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--mobile-network-name

The name of the mobile network.

--name --sim-policy-name -n

The name of the SIM policy.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--registration-timer

Interval for the UE periodic registration update procedure, in seconds.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rfsp-index

RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--slice-config

The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ue-ambr

Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 mobile-network sim policy wait

Place the CLI in a waiting state until a condition is met.

az mobile-network sim policy wait [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--mobile-network-name]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--timeout]
                                  [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--mobile-network-name

The name of the mobile network.

--name --sim-policy-name -n

The name of the SIM policy.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.