Share via

az mobile-network sim group

  • 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 group command. Learn more about extensions.

Manage sim group.

Commands

Name Description Type Status
az mobile-network sim group bulk-delete-sims

Bulk delete SIMs from a SIM group.

 Extension GA
az mobile-network sim group bulk-upload-sims

Bulk upload SIMs to a SIM group.

 Extension GA
az mobile-network sim group create

Create a SIM group.

 Extension GA
az mobile-network sim group delete

Delete the specified SIM group.

 Extension GA
az mobile-network sim group list

List all the SIM groups in a subscription.

 Extension GA
az mobile-network sim group show

Get information about the specified SIM group.

 Extension GA
az mobile-network sim group update

Update a SIM group.

 Extension GA
az mobile-network sim group wait

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

 Extension GA

az mobile-network sim group bulk-delete-sims

Bulk delete SIMs from a SIM group.

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

Examples

Deleting multiple sims in a sim group

az mobile-network sim group bulk-delete-sims -g group --sim-group-name SimGroup --sims "sim01,sim02"

Required Parameters

--sims

A list of SIM resource names to delete. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.

--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>.

--sim-group-name

The name of the SIM Group.

--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 group bulk-upload-sims

Bulk upload SIMs to a SIM group.

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

Examples

Uploading multiple sims to a sim group

az mobile-network sim group bulk-upload-sims -g rg --sim-group-name SimGroup --sims "[{name:bulk-upload-sim-01,authentication-key:00000000000000000000000000000000,operator-key-code:00000000000000000000000000000000,international-msi:0000000000},{name:bulk-upload-sim-02,authentication-key:00000000000000000000000000000001,operator-key-code:00000000000000000000000000000001,international-msi:0000000001}]"
az mobile-network sim group bulk-upload-sims -g rg --sim-group-name SimGroup --sims "[{name:bulk-upload-sim-01,authentication-key:00000000000000000000000000000000,operator-key-code:00000000000000000000000000000000,international-msi:0000000000,icc-id:00000000000000000000,device-type:camera,sim-policy:{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MobileNetwork/mobileNetworks/mobile-network/simPolicies/policy01},static-ip-configuration:[{attached-data-network:{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/pccp01/packetCoreDataPlanes/pccp01/attachedDataNetworks/internet1},slice:{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MobileNetwork/mobileNetworks/mobile-network/slices/slice01},static-ip:{ipv4-address:2.4.0.10}}]}]"

Required Parameters

--sims

A list of SIMs to upload. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.

--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>.

--sim-group-name

The name of the SIM Group.

--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 group create

Create a SIM group.

az mobile-network sim group create --name
                                   --resource-group
                                   [--encryption-key]
                                   [--identity]
                                   [--location]
                                   [--mobile-network]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--tags]

Examples

Create sim group

az mobile-network sim group create -n sim-group-name -g rg --mobile-network "{id:mobile-network-id}"

Required Parameters

--name --sim-group-name -n

The name of the SIM Group.

--resource-group -g

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

Optional Parameters

--encryption-key

A key to encrypt the SIM data that belongs to this SIM group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--identity

The identity used to retrieve the encryption key from Azure key vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

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

--mobile-network

Mobile network that this SIM belongs to Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 group delete

Delete the specified SIM group.

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

Examples

Delete sim group

az mobile-network sim group delete -n sim-group-name -g rg -y

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.

--name --sim-group-name -n

The name of the SIM Group.

--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 group list

List all the SIM groups in a subscription.

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

Examples

List sim group by resource group

az mobile-network sim group list -g rg

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.

--resource-group -g

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

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 group show

Get information about the specified SIM group.

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

Examples

Show sim goup

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

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.

--name --sim-group-name -n

The name of the SIM Group.

--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 group update

Update a SIM group.

az mobile-network sim group update [--add]
                                   [--encryption-key]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--identity]
                                   [--ids]
                                   [--mobile-network]
                                   [--name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]
                                   [--tags]

Examples

Update sim group tags

az mobile-network sim group update -n sim-group-name -g rg --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>.

--encryption-key

A key to encrypt the SIM data that belongs to this SIM group. 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
--identity

The identity used to retrieve the encryption key from Azure key vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--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

Mobile network that this SIM belongs to Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name --sim-group-name -n

The name of the SIM Group.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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>.

--set

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

--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.

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 group wait

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

az mobile-network sim group wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--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
--name --sim-group-name -n

The name of the SIM Group.

--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.