通过

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

Services - Update Tags

  • 参考
服务:
Mobile Network
API 版本:
2024-04-01

更新服务标记。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services/{serviceName}?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

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

string

maxLength: 64
pattern: ^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$

服务的名称。 不得使用以下任何保留字符串 - default、requested 或 service
subscriptionId
 path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。
api-version
 query True

string

minLength: 1

用于此作的 API 版本。

请求正文

名称 类型 说明
tags

object

资源标记。

响应

名称 类型 说明
200 OK

Service

更新成功。 该作返回生成的服务资源。
Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Update service tags

示例请求

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

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

示例响应

状态代码:
200 
{
  "name": "TestService",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/TestService",
  "type": "Microsoft.MobileNetwork/service",
  "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": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "servicePrecedence": 255,
    "serviceQosPolicy": {
      "5qi": 9,
      "allocationAndRetentionPriorityLevel": 9,
      "preemptionCapability": "NotPreempt",
      "preemptionVulnerability": "Preemptable",
      "maximumBitRate": {
        "uplink": "500 Mbps",
        "downlink": "1 Gbps"
      }
    },
    "pccRules": [
      {
        "ruleName": "default-rule",
        "rulePrecedence": 255,
        "ruleQosPolicy": {
          "5qi": 9,
          "allocationAndRetentionPriorityLevel": 9,
          "preemptionCapability": "NotPreempt",
          "preemptionVulnerability": "Preemptable",
          "maximumBitRate": {
            "uplink": "500 Mbps",
            "downlink": "1 Gbps"
          }
        },
        "trafficControl": "Enabled",
        "serviceDataFlowTemplates": [
          {
            "templateName": "IP-to-server",
            "direction": "Uplink",
            "protocol": [
              "ip"
            ],
            "remoteIpList": [
              "10.3.4.0/24"
            ],
            "ports": []
          }
        ]
      }
    ]
  }
}

定义

名称 说明
Ambr

聚合最大比特率。
createdByType

创建资源的标识的类型。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
PccRuleConfiguration

数据流策略规则配置
PccRuleQosPolicy

数据流策略规则 QoS 策略
PreemptionCapability

抢占功能。
PreemptionVulnerability

抢占漏洞。
ProvisioningState

当前预配状态。
QosPolicy

QoS 策略
SdfDirection

服务数据流方向。
Service

服务资源。 必须在其父移动网络所在的同一位置创建。
ServiceDataFlowTemplate

数据流模板
systemData

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

用于修补操作的标记对象。
TrafficControlPermission

流量控制权限。

Ambr

Object

聚合最大比特率。

名称 类型 说明
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

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

PccRuleConfiguration

Object

数据流策略规则配置

名称 类型 默认值 说明
ruleName

string

maxLength: 64
pattern: ^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$

规则的名称。 这在父服务中必须是唯一的。 不得使用以下任何保留字符串 - default、requested 或 service。
rulePrecedence

integer (int32)

minimum: 0
maximum: 255

确定要用于特定 SIM 卡的 QoS 值时，用于在数据流策略规则之间决定的优先值。 较低的值表示更高的优先级。 此值在移动网络中配置的所有数据流策略规则中应是唯一的。
ruleQosPolicy

PccRuleQosPolicy

用于匹配此规则的数据包的 QoS 策略。 如果此字段为 null，则父服务将定义 QoS 设置。
serviceDataFlowTemplates

ServiceDataFlowTemplate[]

用于此数据流策略规则的数据流模板集。
trafficControl

TrafficControlPermission

Enabled

确定是否允许与此数据流策略规则匹配的流。

PccRuleQosPolicy

Object

数据流策略规则 QoS 策略

名称 类型 默认值 说明
5qi

integer (int32)

minimum: 1
maximum: 127 		9

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

integer (int32)

minimum: 1
maximum: 15 		9

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

Ambr

使用此数据流策略规则的所有服务数据流的保证比特率 （GBR）。 这是一个可选设置。 如果未提供值，则不会为使用此 QoS 定义的数据流策略规则设置 GBR。
maximumBitRate

Ambr

使用此数据流策略规则或服务的所有服务数据流的最大比特率（MBR）。
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。

PreemptionCapability

枚举

抢占功能。

值 说明
MayPreempt

梅抢占
NotPreempt

无法抢占

PreemptionVulnerability

枚举

抢占漏洞。

值 说明
NotPreemptable

无法抢占
Preemptable

可能抢占

ProvisioningState

枚举

当前预配状态。

值 说明
Accepted
Canceled
Deleted
Deleting
Failed
Succeeded
Unknown

QosPolicy

Object

QoS 策略

名称 类型 默认值 说明
5qi

integer (int32)

minimum: 1
maximum: 127 		9

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

integer (int32)

minimum: 1
maximum: 15 		9

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

Ambr

使用此数据流策略规则或服务的所有服务数据流的最大比特率（MBR）。
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。

SdfDirection

枚举

服务数据流方向。

值 说明
Bidirectional

流入和流出 UE 的流量。
Downlink

从数据网络流向 UE 的流量。
Uplink

从 UE 流向数据网络的流量。

Service

Object

服务资源。 必须在其父移动网络所在的同一位置创建。

名称 类型 说明
id

string (arm-id)

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

string

资源所在的地理位置
name

string

资源的名称
properties.pccRules

PccRuleConfiguration[]

构成此服务的数据流策略规则集。
properties.provisioningState

ProvisioningState

服务资源的预配状态。
properties.servicePrecedence

integer (int32)

minimum: 0
maximum: 255

确定要用于特定 SIM 卡的 QoS 值时，用于在服务之间决定的优先值。 较低的值表示更高的优先级。 此值在移动网络中配置的所有服务中应是唯一的。
properties.serviceQosPolicy

QosPolicy

用于与此服务匹配的数据包的 QoS 策略。 可以使用 PccRuleConfiguration 中的 ruleQosPolicy 字段覆盖特定流。 如果此字段为 null，则 UE 的 SIM 策略将定义 QoS 设置。
systemData

systemData

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

object

资源标记。
type

string

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

ServiceDataFlowTemplate

Object

数据流模板

名称 类型 说明
direction

SdfDirection

此流的方向。
ports

string[]

pattern: ^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$

要连接到此流的 UE 的端口。 可以指定零个或多个端口或端口范围。 如果指定一个或多个端口或端口范围，则必须在 ip 字段中指定除 protocol 以外的值。 这是一个可选设置。 如果未指定连接，则会在所有端口上允许连接。 端口范围必须指定为 -。 例如：[8080，8082-8085]。
protocol

string[]

pattern: ^(ip|[0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

此流的允许协议列表。 如果希望此流能够使用 Internet 协议套件中的任何协议，请使用值 ip。 如果只想允许选择协议，则必须为每个协议使用相应的 IANA 分配的 Internet 协议编号，如 https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml中所述。 例如，对于 UDP，必须使用 17。 如果使用值 ip，则必须将字段保留 port 未指定。
remoteIpList

string[]

pattern: ^(any|(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2])))$

要连接到此流的远程 IP 地址（es）。 如果要允许任何 IP 地址上的连接，请使用值 any。 否则，必须提供数据包核心实例将连接到此流的每个远程 IP 地址。 必须提供 CIDR 表示法中的每个 IP 地址，包括 netmask（例如 192.0.2.54/24）。
templateName

string

maxLength: 64
pattern: ^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$

数据流模板的名称。 这在父数据流策略规则中必须是唯一的。 不得使用以下任何保留字符串 - default、requested 或 service。

systemData

Object

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

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

上次修改的资源时间戳（UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

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

TagsObject

Object

用于修补操作的标记对象。

名称 类型 说明
tags

object

资源标记。

TrafficControlPermission

枚举

流量控制权限。

值 说明
Blocked

不允许此规则匹配的流量流。
Enabled

允许与此规则匹配的流量流动。