你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Sim Policies - Create Or Update

创建或更新 SIM 策略。 必须在其父移动网络所在的同一位置创建。

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

URI 参数

名称 必需 类型 说明
mobileNetworkName
path True

string

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

移动网络的名称。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。

simPolicyName
path True

string

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

SIM 策略的名称。

subscriptionId
path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

minLength: 1

用于此作的 API 版本。

请求正文

名称 必需 类型 说明
location True

string

资源所在的地理位置

properties.defaultSlice True

SliceResourceId

如果 UE 未显式指定它,则使用的默认切片。 此切片必须存在于 sliceConfigurations 映射中。 切片必须与 SIM 策略位于同一位置。

properties.sliceConfigurations True

SliceConfiguration[]

允许的切片和用于它们的设置。 该列表不得包含重复项,并且必须至少包含一个项目。

properties.ueAmbr True

Ambr

聚合给定 UE 的所有 PDU 会话的所有非 GBR QoS 流的最大比特率。 有关 UE-AMBR 的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.6。

properties.registrationTimer

integer (int32)

minimum: 30

UE 定期注册更新计时器 (5G) 或 UE 定期跟踪区域更新计时器 (4G),以秒为单位。

properties.rfspIndex

integer (int32)

minimum: 1
maximum: 256

RAT/频率选择优先级索引,在 3GPP TS 36.413 中定义。 这是一个可选设置,默认情况下未指定。

tags

object

资源标记。

响应

名称 类型 说明
200 OK

SimPolicy

更新成功。 该作返回生成的 SIM 策略资源。

201 Created

SimPolicy

创建成功。 该作返回生成的 SIM 策略资源。

Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create SIM policy

示例请求

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

示例响应

{
  "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
          }
        ]
      }
    ]
  }
}
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
          }
        ]
      }
    ]
  }
}

定义

名称 说明
Ambr

聚合最大比特率。

createdByType

创建资源的标识的类型。

DataNetworkConfiguration

控制数据网络使用的设置

DataNetworkResourceId

对数据网络资源的引用。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

PduSessionType

PDU 会话类型(IPv4/IPv6)。

PreemptionCapability

抢占功能。

PreemptionVulnerability

抢占漏洞。

ProvisioningState

当前预配状态。

ServiceResourceId

对服务资源的引用。

SimPolicy

SIM 策略资源。

SliceConfiguration

按切片设置

SliceResourceId

对切片资源的引用。

systemData

与创建和上次修改资源相关的元数据。

Ambr

聚合最大比特率。

名称 类型 说明
downlink

string

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

下行比特率。

uplink

string

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

上行比特率。

createdByType

创建资源的标识的类型。

说明
Application
Key
ManagedIdentity
User

DataNetworkConfiguration

控制数据网络使用的设置

名称 类型 默认值 说明
5qi

integer (int32)

minimum: 0
maximum: 255
9

默认的 5G QoS 流指示器值。 5QI 标识要提供给流的特定 QoS 转发处理。 有关 5QI 参数的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.1,有关 5QI 值的定义,请参阅表 5.7.4-1。

additionalAllowedSessionTypes

PduSessionType[]

除了默认会话类型之外,允许的会话类型。 不得复制默认会话类型。

allocationAndRetentionPriorityLevel

integer (int32)

minimum: 1
maximum: 15
9

默认 QoS 流分配和保留优先级 (ARP) 级别。 如果 preemptionCapability 设置和 preemptionVulnerability 允许,优先级较高的流会抢占优先级较低的流。1 是最高优先级。 如果未指定此字段,则 5qi 用于派生 ARP 值。 有关 ARP 参数的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.2。

allowedServices

ServiceResourceId[]

可用作此 SIM 策略一部分的服务列表。 该列表不得包含重复项,并且必须至少包含一个项目。 这些服务必须与 SIM 策略位于同一位置。

dataNetwork

DataNetworkResourceId

对这些设置应用于的数据网络的引用。 数据网络必须与 SIM 策略位于同一位置。

defaultSessionType

PduSessionType

IPv4

默认的 PDU 会话类型,如果 UE 不请求特定会话类型,则使用此类型。

maximumNumberOfBufferedPackets

integer (int32)

minimum: 0
10

在用户平面上缓冲的最大下行数据包数,以实现高延迟通信 - 扩展缓冲。 有关完整说明,请参阅 3GPP TS29.272 v15.10.0 部分 7.3.188。 无法保证此最大值,因为所有 PDU 会话中的缓冲数据包存在内部限制。

preemptionCapability

PreemptionCapability

NotPreempt

默认 QoS 流抢占功能。 QoS 流的抢占功能控制它是否可以抢占优先级较低的另一个 QoS 流。 有关 ARP 参数的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.2。

preemptionVulnerability

PreemptionVulnerability

Preemptable

默认 QoS 流抢占漏洞。 QoS 流的抢占漏洞控制是否可以被优先级较高的 QoS 流抢占。 有关 ARP 参数的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.2。

sessionAmbr

Ambr

聚合给定 PDU 会话的所有非 GBR QoS 流的最大比特率。 有关 Session-AMBR 的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.6。

DataNetworkResourceId

对数据网络资源的引用。

名称 类型 说明
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]/[^/?#]+$

数据网络资源 ID。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

PduSessionType

PDU 会话类型(IPv4/IPv6)。

说明
IPv4
IPv6

PreemptionCapability

抢占功能。

说明
MayPreempt

梅抢占

NotPreempt

无法抢占

PreemptionVulnerability

抢占漏洞。

说明
NotPreemptable

无法抢占

Preemptable

可能抢占

ProvisioningState

当前预配状态。

说明
Accepted
Canceled
Deleted
Deleting
Failed
Succeeded
Unknown

ServiceResourceId

对服务资源的引用。

名称 类型 说明
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]/[^/?#]+$

服务资源 ID。

SimPolicy

SIM 策略资源。

名称 类型 默认值 说明
id

string (arm-id)

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

location

string

资源所在的地理位置

name

string

资源的名称

properties.defaultSlice

SliceResourceId

如果 UE 未显式指定它,则使用的默认切片。 此切片必须存在于 sliceConfigurations 映射中。 切片必须与 SIM 策略位于同一位置。

properties.provisioningState

ProvisioningState

SIM 策略资源的预配状态。

properties.registrationTimer

integer (int32)

minimum: 30
3240

UE 定期注册更新计时器 (5G) 或 UE 定期跟踪区域更新计时器 (4G),以秒为单位。

properties.rfspIndex

integer (int32)

minimum: 1
maximum: 256

RAT/频率选择优先级索引,在 3GPP TS 36.413 中定义。 这是一个可选设置,默认情况下未指定。

properties.siteProvisioningState

object

站点的字典,指向该站点上此 SIM 策略的预配状态。

properties.sliceConfigurations

SliceConfiguration[]

允许的切片和用于它们的设置。 该列表不得包含重复项,并且必须至少包含一个项目。

properties.ueAmbr

Ambr

聚合给定 UE 的所有 PDU 会话的所有非 GBR QoS 流的最大比特率。 有关 UE-AMBR 的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.6。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SliceConfiguration

按切片设置

名称 类型 说明
dataNetworkConfigurations

DataNetworkConfiguration[]

允许的数据网络和要用于它们的设置。 该列表不得包含重复项,并且必须至少包含一个项目。

defaultDataNetwork

DataNetworkResourceId

如果 UE 未显式指定它,则要使用的默认数据网络。 此对象的配置必须存在于 dataNetworkConfigurations 映射中。 数据网络必须与 SIM 策略位于同一位置。

slice

SliceResourceId

对这些设置应用到的切片的引用。 切片必须与 SIM 策略位于同一位置。

SliceResourceId

对切片资源的引用。

名称 类型 说明
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]/[^/?#]+$

切片资源 ID。

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。