az mobile-network sim

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

Manage sim.

Commands

Name	Description	Type	Status
az mobile-network sim create	Create a SIM.	Extension	GA
az mobile-network sim delete	Delete the specified SIM.	Extension	GA
az mobile-network sim group	Manage sim group.	Extension	GA
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 list	List all the SIMs in a SIM group.	Extension	GA
az mobile-network sim policy	Manage sim policy.	Extension	GA
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 show	Get information about the specified SIM.	Extension	GA
az mobile-network sim wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az mobile-network sim create

Create a SIM.

az mobile-network sim create --international-msi
                             --name --sim-name
                             --resource-group
                             --sim-group-name
                             [--authentication-key]
                             [--device-type]
                             [--icc-id]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--operator-key-code]
                             [--sim-policy]
                             [--static-ip-config]

Examples

Create sim

az mobile-network sim create -g rg --sim-group-name sim-group-name -n sim-name --international-msi 0000000000 --operator-key-code 00000000000000000000000000000000 --authentication-key 00000000000000000000000000000000

Required Parameters

--international-msi

The international mobile subscriber identity (IMSI) for the SIM.

Property	Value
Parameter group:	Properties Arguments

--name --sim-name -n

The name of the SIM.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--authentication-key

The Ki value for the SIM.

Property	Value
Parameter group:	Properties Arguments

--device-type

An optional free-form text field that can be used to record the device type this SIM is associated with, for example 'Video camera'. The Azure portal allows SIMs to be grouped and filtered based on this value.

Property	Value
Parameter group:	Properties Arguments

--icc-id

The integrated circuit card ID (ICCID) for the SIM.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--operator-key-code

The Opc value for the SIM.

Property	Value
Parameter group:	Properties Arguments

--sim-policy

The SIM policy used by this SIM. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--static-ip-config

A list of static IP addresses assigned to this SIM. Each address is assigned at a defined network scope, made up of {attached data network, slice}. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az mobile-network sim delete

Delete the specified SIM.

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

Examples

Delete sim

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --sim-name -n

The name of the SIM.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--sim-group-name

The name of the SIM Group.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az mobile-network sim list

List all the SIMs in a SIM group.

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

Examples

List sims by resource group

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

Required Parameters

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az mobile-network sim show

Get information about the specified SIM.

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

Examples

Show sim

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --sim-name -n

The name of the SIM.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--sim-group-name

The name of the SIM Group.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az mobile-network sim wait

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --sim-name -n

The name of the SIM.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--sim-group-name

The name of the SIM Group.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False