Share via

Sim Policies - Create Or Update

  • Reference
Service:
Mobile Network
API Version:
2024-04-01

Creates or updates a SIM policy. Must be created in the same location as its parent mobile network.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies/{simPolicyName}?api-version=2024-04-01

URI Parameters

Name In Required Type Description
mobileNetworkName
 path True

string

maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

The name of the mobile network.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
simPolicyName
 path True

string

maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

The name of the SIM policy.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Required Type Description
location True

string

The geo-location where the resource lives
properties.defaultSlice True

SliceResourceId

The default slice to use if the UE does not explicitly specify it. This slice must exist in the sliceConfigurations map. The slice must be in the same location as the SIM policy.
properties.sliceConfigurations True

SliceConfiguration[]

The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item.
properties.ueAmbr True

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

integer (int32)

minimum: 30

UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), in seconds.
properties.rfspIndex

integer (int32)

minimum: 1
maximum: 256

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

object

Resource tags.

Responses

Name Type Description
200 OK

SimPolicy

Update successful. The operation returns the resulting SIM policy resource.
201 Created

SimPolicy

Create successful. The operation returns the resulting SIM policy resource.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create SIM policy

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy?api-version=2024-04-01

{
  "location": "eastus",
  "properties": {
    "registrationTimer": 3240,
    "ueAmbr": {
      "uplink": "500 Mbps",
      "downlink": "1 Gbps"
    },
    "defaultSlice": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
    },
    "sliceConfigurations": [
      {
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "defaultDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
        },
        "dataNetworkConfigurations": [
          {
            "dataNetwork": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
            },
            "sessionAmbr": {
              "uplink": "500 Mbps",
              "downlink": "1 Gbps"
            },
            "5qi": 9,
            "allocationAndRetentionPriorityLevel": 9,
            "preemptionCapability": "NotPreempt",
            "preemptionVulnerability": "Preemptable",
            "defaultSessionType": "IPv4",
            "additionalAllowedSessionTypes": [],
            "allowedServices": [
              {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService"
              }
            ],
            "maximumNumberOfBufferedPackets": 200
          }
        ]
      }
    ]
  }
}

Sample response

Status code:
200 
{
  "name": "testPolicy",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy",
  "type": "Microsoft.MobileNetwork/simPolicy",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "siteProvisioningState": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": "Provisioned",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": "Provisioned"
    },
    "registrationTimer": 3240,
    "ueAmbr": {
      "uplink": "500 Mbps",
      "downlink": "1 Gbps"
    },
    "defaultSlice": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
    },
    "sliceConfigurations": [
      {
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "defaultDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
        },
        "dataNetworkConfigurations": [
          {
            "dataNetwork": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
            },
            "sessionAmbr": {
              "uplink": "500 Mbps",
              "downlink": "1 Gbps"
            },
            "5qi": 9,
            "allocationAndRetentionPriorityLevel": 9,
            "preemptionCapability": "NotPreempt",
            "preemptionVulnerability": "Preemptable",
            "defaultSessionType": "IPv4",
            "additionalAllowedSessionTypes": [],
            "allowedServices": [
              {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService"
              }
            ],
            "maximumNumberOfBufferedPackets": 200
          }
        ]
      }
    ]
  }
}
Status code:
201 
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.MobileNetwork/locations/testLocation/operationStatuses/testOperation?api-version=2024-04-01
{
  "name": "testPolicy",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy",
  "type": "Microsoft.MobileNetwork/simPolicy",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Created",
    "siteProvisioningState": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": "Adding",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": "Adding"
    },
    "registrationTimer": 3240,
    "ueAmbr": {
      "uplink": "500 Mbps",
      "downlink": "1 Gbps"
    },
    "defaultSlice": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
    },
    "sliceConfigurations": [
      {
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "defaultDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
        },
        "dataNetworkConfigurations": [
          {
            "dataNetwork": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
            },
            "sessionAmbr": {
              "uplink": "500 Mbps",
              "downlink": "1 Gbps"
            },
            "5qi": 9,
            "allocationAndRetentionPriorityLevel": 9,
            "preemptionCapability": "NotPreempt",
            "preemptionVulnerability": "Preemptable",
            "defaultSessionType": "IPv4",
            "additionalAllowedSessionTypes": [],
            "allowedServices": [
              {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService"
              }
            ],
            "maximumNumberOfBufferedPackets": 200
          }
        ]
      }
    ]
  }
}

Definitions

Name Description
Ambr

Aggregate maximum bit rate.
createdByType

The type of identity that created the resource.
DataNetworkConfiguration

Settings controlling data network use
DataNetworkResourceId

Reference to a data network resource.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
PduSessionType

PDU session type (IPv4/IPv6).
PreemptionCapability

Preemption capability.
PreemptionVulnerability

Preemption vulnerability.
ProvisioningState

The current provisioning state.
ServiceResourceId

Reference to a service resource.
SimPolicy

SIM policy resource.
SliceConfiguration

Per-slice settings
SliceResourceId

Reference to a slice resource.
systemData

Metadata pertaining to creation and last modification of the resource.

Ambr

Object

Aggregate maximum bit rate.

Name Type Description
downlink

string

pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

Downlink bit rate.
uplink

string

pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

Uplink bit rate.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
Application
Key
ManagedIdentity
User

DataNetworkConfiguration

Object

Settings controlling data network use

Name Type Default value Description
5qi

integer (int32)

minimum: 0
maximum: 255 		9

Default 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition the 5QI values.
additionalAllowedSessionTypes

PduSessionType[]

Allowed session types in addition to the default session type. Must not duplicate the default session type.
allocationAndRetentionPriorityLevel

integer (int32)

minimum: 1
maximum: 15 		9

Default QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of preemptionCapability and preemptionVulnerability allow it. 1 is the highest level of priority. If this field is not specified then 5qi is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.
allowedServices

ServiceResourceId[]

List of services that can be used as part of this SIM policy. The list must not contain duplicate items and must contain at least one item. The services must be in the same location as the SIM policy.
dataNetwork

DataNetworkResourceId

A reference to the data network that these settings apply to. The data network must be in the same location as the SIM policy.
defaultSessionType

PduSessionType

IPv4

The default PDU session type, which is used if the UE does not request a specific session type.
maximumNumberOfBufferedPackets

integer (int32)

minimum: 0 		10

The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions.
preemptionCapability

PreemptionCapability

NotPreempt

Default QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.
preemptionVulnerability

PreemptionVulnerability

Preemptable

Default QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.
sessionAmbr

Ambr

Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR.

DataNetworkResourceId

Object

Reference to a data network resource.

Name Type Description
id

string

pattern: ^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+/[dD][aA][tT][aA][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$

Data network resource ID.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

PduSessionType

Enumeration

PDU session type (IPv4/IPv6).

Value Description
IPv4
IPv6

PreemptionCapability

Enumeration

Preemption capability.

Value Description
MayPreempt

May preempt
NotPreempt

Cannot preempt

PreemptionVulnerability

Enumeration

Preemption vulnerability.

Value Description
NotPreemptable

Cannot be preempted
Preemptable

May be preempted

ProvisioningState

Enumeration

The current provisioning state.

Value Description
Accepted
Canceled
Deleted
Deleting
Failed
Succeeded
Unknown

ServiceResourceId

Object

Reference to a service resource.

Name Type Description
id

string

pattern: ^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+/[sS][eE][rR][vV][iI][cC][eE][sS]/[^/?#]+$

Service resource ID.

SimPolicy

Object

SIM policy resource.

Name Type Default value Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location

string

The geo-location where the resource lives
name

string

The name of the resource
properties.defaultSlice

SliceResourceId

The default slice to use if the UE does not explicitly specify it. This slice must exist in the sliceConfigurations map. The slice must be in the same location as the SIM policy.
properties.provisioningState

ProvisioningState

The provisioning state of the SIM policy resource.
properties.registrationTimer

integer (int32)

minimum: 30 		3240

UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), in seconds.
properties.rfspIndex

integer (int32)

minimum: 1
maximum: 256

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

object

A dictionary of sites to the provisioning state of this SIM policy on that site.
properties.sliceConfigurations

SliceConfiguration[]

The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item.
properties.ueAmbr

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

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

object

Resource tags.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SliceConfiguration

Object

Per-slice settings

Name Type Description
dataNetworkConfigurations

DataNetworkConfiguration[]

The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item.
defaultDataNetwork

DataNetworkResourceId

The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the dataNetworkConfigurations map. The data network must be in the same location as the SIM policy.
slice

SliceResourceId

A reference to the slice that these settings apply to. The slice must be in the same location as the SIM policy.

SliceResourceId

Object

Reference to a slice resource.

Name Type Description
id

string

pattern: ^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+/[sS][lL][iI][cC][eE][sS]/[^/?#]+$

Slice resource ID.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.