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

Services - List By Mobile Network

获取移动网络中的所有服务。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services?api-version=2022-04-01-preview

URI 参数

Name In Required Type Description
mobileNetworkName
path True
  • string

移动网络的名称。

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

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

请求成功。 该操作返回服务资源列表。

Other Status Codes

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

安全性

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 模拟用户帐户

示例

List services in a mobile network

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/testResourceGroupName/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services?api-version=2022-04-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/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": {},
      "properties": {
        "provisioningState": "Accepted",
        "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": []
              }
            ]
          }
        ]
      }
    }
  ],
  "nextLink": "nextLink"
}

定义

Ambr

聚合最大比特率。

createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

PccRuleConfiguration

数据流策略规则配置

PccRuleQosPolicy

数据流策略规则 QoS 策略

PreemptionCapability

抢占功能。

PreemptionVulnerability

抢占漏洞。

ProvisioningState

当前预配状态。

QosPolicy

QoS 策略

SdfDirection

服务数据流方向。

Service

服务资源。

ServiceDataFlowTemplate

数据流模板

ServiceListResult

服务 API 服务调用的响应。

systemData

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

TrafficControlPermission

流量控制权限。

Ambr

聚合最大比特率。

Name Type Description
downlink
  • string

下行链接比特率。

uplink
  • string

上行比特率。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

PccRuleConfiguration

数据流策略规则配置

Name Type Default Value Description
ruleName
  • string

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

rulePrecedence
  • integer

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

ruleQosPolicy

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

serviceDataFlowTemplates

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

trafficControl Enabled

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

PccRuleQosPolicy

数据流策略规则 QoS 策略

Name Type Default Value Description
5qi
  • integer
9

QoS 流 5G QoS 指示器值。 5QI 标识要提供给流的特定 QoS 转发处理。 这不能是与 GBR (保证比特率) QoS 流的标准化 5QI 值。 非法 GBR 5QI 值为:1、2、3、4、65、66、67、71、72、73、74、75、76、82、83、84 和 85。 有关 5QI 参数的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.1,有关其定义为 GBR 5QI 值的定义,请参阅表 5.7.4-1。

allocationAndRetentionPriorityLevel
  • integer
9

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

guaranteedBitRate

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

maximumBitRate

使用此数据流策略规则或服务的所有服务数据流的最大比特率 (MBR) 。

preemptionCapability NotPreempt

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

preemptionVulnerability Preemptable

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

PreemptionCapability

抢占功能。

Name Type Description
MayPreempt
  • string

5 月抢占

NotPreempt
  • string

无法抢占

PreemptionVulnerability

抢占漏洞。

Name Type Description
NotPreemptable
  • string

无法抢占

Preemptable
  • string

可能抢占

ProvisioningState

当前预配状态。

Name Type Description
Accepted
  • string
Canceled
  • string
Deleted
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Unknown
  • string

QosPolicy

QoS 策略

Name Type Default Value Description
5qi
  • integer
9

QoS 流 5G QoS 指示器值。 5QI 标识要提供给流的特定 QoS 转发处理。 这不能是与 GBR (保证比特率) QoS 流的标准化 5QI 值。 非法 GBR 5QI 值为:1、2、3、4、65、66、67、71、72、73、74、75、76、82、83、84 和 85。 有关 5QI 参数的完整说明,请参阅 3GPP TS23.501 部分 5.7.2.1,有关其定义为 GBR 5QI 值的定义,请参阅表 5.7.4-1。

allocationAndRetentionPriorityLevel
  • integer
9

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

maximumBitRate

使用此数据流策略规则或服务的所有服务数据流的最大比特率 (MBR) 。

preemptionCapability NotPreempt

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

preemptionVulnerability Preemptable

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

SdfDirection

服务数据流方向。

Name Type Description
Bidirectional
  • string

流向和流出 UE 的流量。

Downlink
  • string

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

Uplink
  • string

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

Service

服务资源。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties.pccRules

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

properties.provisioningState

服务资源的预配状态。

properties.servicePrecedence
  • integer

确定要用于特定 SIM 卡的 QoS 值时,用于在服务之间决定的优先值。 值越小,表示优先级越高。 此值在移动网络中配置的所有服务中应是唯一的。

properties.serviceQosPolicy

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

systemData

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

systemData.createdAt
  • string

资源创建时间戳 (UTC) 。

systemData.createdBy
  • string

创建资源的标识。

systemData.createdByType

创建资源的标识的类型。

systemData.lastModifiedAt
  • string

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

systemData.lastModifiedBy
  • string

上次修改资源的标识。

systemData.lastModifiedByType

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

tags
  • object

资源标记。

type
  • string

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

ServiceDataFlowTemplate

数据流模板

Name Type Description
direction

此流的方向。

ports
  • string[]

端口 (用于此流的 UE 连接到的) 。 可以指定零个或多个端口或端口范围。 如果指定一个或多个端口或端口范围,则必须指定字段以外的ipprotocol值。 这是一个可选设置。 如果未指定,则允许在所有端口上建立连接。 端口范围必须指定为 -。 例如:[80808082-8085].

protocol
  • string[]

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

remoteIpList
  • string[]

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

templateName
  • string

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

ServiceListResult

服务 API 服务调用的响应。

Name Type Description
nextLink
  • string

用于获取下一组结果的 URL。

value

服务列表。

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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

TrafficControlPermission

流量控制权限。

Name Type Description
Blocked
  • string

不允许流量与此规则匹配。

Enabled
  • string

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