Udostępnij za pośrednictwem


Services - Get

Pobiera informacje o określonej usłudze.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
mobileNetworkName
path True

string

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

Nazwa sieci komórkowej.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName
path True

string

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

Nazwa usługi. Nie można używać żadnych z następujących ciągów zarezerwowanych — default, requested lub service

subscriptionId
path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Service

Żądanie powiodło się. Operacja zwraca wynikowy zasób usługi.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Get service

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "name": "testPolicy",
  "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": {},
  "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": []
          }
        ]
      }
    ]
  }
}

Definicje

Nazwa Opis
Ambr

Agregacja maksymalnej szybkości bitów.

createdByType

Typ tożsamości, która utworzyła zasób.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

PccRuleConfiguration

Konfiguracja reguły zasad przepływu danych

PccRuleQosPolicy

Zasady QoS reguły przepływu danych

PreemptionCapability

Możliwość wywłaszczania.

PreemptionVulnerability

Luka w zabezpieczeniach dotycząca wywłaszczania.

ProvisioningState

Bieżący stan aprowizacji.

QosPolicy

Zasady QoS

SdfDirection

Kierunek przepływu danych usługi.

Service

Zasób usługi. Należy utworzyć w tej samej lokalizacji co nadrzędna sieć mobilna.

ServiceDataFlowTemplate

Szablon przepływu danych

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TrafficControlPermission

Uprawnienie do kontroli ruchu.

Ambr

Agregacja maksymalnej szybkości bitów.

Nazwa Typ Opis
downlink

string

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

Szybkość ściągnięć bitów.

uplink

string

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

Szybkość pasma bitów.

createdByType

Typ tożsamości, która utworzyła zasób.

Wartość Opis
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

PccRuleConfiguration

Konfiguracja reguły zasad przepływu danych

Nazwa Typ Domyślna wartość Opis
ruleName

string

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

Nazwa reguły. Musi to być unikatowe w ramach usługi nadrzędnej. Nie można używać żadnych z następujących ciągów zarezerwowanych — default, requested ani service.

rulePrecedence

integer (int32)

minimum: 0
maximum: 255

Wartość pierwszeństwa używana do decydowania między regułami zasad przepływu danych podczas identyfikowania wartości QoS do użycia dla określonej karty SIM. Niższa wartość oznacza wyższy priorytet. Ta wartość powinna być unikatowa wśród wszystkich reguł zasad przepływu danych skonfigurowanych w sieci komórkowej.

ruleQosPolicy

PccRuleQosPolicy

Zasady QoS do użycia dla pakietów pasujących do tej reguły. Jeśli to pole ma wartość null, usługa nadrzędna zdefiniuje ustawienia QoS.

serviceDataFlowTemplates

ServiceDataFlowTemplate[]

Zestaw szablonów przepływu danych do użycia dla tej reguły zasad przepływu danych.

trafficControl

TrafficControlPermission

Enabled

Określa, czy przepływy zgodne z tą regułą zasad przepływu danych są dozwolone.

PccRuleQosPolicy

Zasady QoS reguły przepływu danych

Nazwa Typ Domyślna wartość Opis
5qi

integer (int32)

minimum: 1
maximum: 127
9

Wartość wskaźnika przepływu QoS 5G. 5QI identyfikuje konkretne leczenie przekazywania QoS, które ma zostać dostarczone do przepływu. Zobacz sekcję 3GPP TS23.501 5.7.2.1, aby uzyskać pełny opis parametru 5QI i tabeli 5.7.4-1, aby uzyskać definicję wartości 5QI.

allocationAndRetentionPriorityLevel

integer (int32)

minimum: 1
maximum: 15
9

Poziom alokacji i przechowywania przepływu QoS (ARP). Przepływy z wywłaszczanym priorytetem przepływy o niższym prioryfiksie, jeśli zezwalają na to ustawienia preemptionCapability i preemptionVulnerability. 1 jest najwyższym poziomem priorytetu. Jeśli to pole nie zostanie określone, 5qi zostanie użyta do uzyskania wartości ARP. Aby uzyskać pełny opis parametrów protokołu ARP, zobacz sekcję 3GPP TS23.501 5.7.2.2.

guaranteedBitRate

Ambr

Gwarantowana szybkość bitów (GBR) dla wszystkich przepływów danych usługi korzystających z tej reguły zasad przepływu danych. Jest to ustawienie opcjonalne. Jeśli nie podasz wartości, dla reguły zasad przepływu danych nie będzie ustawiony gbr, która używa tej definicji QoS.

maximumBitRate

Ambr

Maksymalna szybkość bitów (MBR) dla wszystkich przepływów danych usługi korzystających z tej reguły zasad przepływu danych lub usługi.

preemptionCapability

PreemptionCapability

NotPreempt

Możliwość wywłaszczania przepływu QoS. Możliwość wywłaszczania przepływu QoS steruje tym, czy może wyprzedać inny przepływ QoS z niższym priorytetem. Aby uzyskać pełny opis parametrów protokołu ARP, zobacz sekcję 3GPP TS23.501 5.7.2.2.

preemptionVulnerability

PreemptionVulnerability

Preemptable

Luka w zabezpieczeniach dotycząca wywłaszczania przepływu QoS. Luka w zabezpieczeniach dotycząca wywłaszczania przepływu QoS steruje tym, czy może zostać wywłaszczone przez przepływ QoS z wyższym poziomem priorytetu. Aby uzyskać pełny opis parametrów protokołu ARP, zobacz sekcję 3GPP TS23.501 5.7.2.2.

PreemptionCapability

Możliwość wywłaszczania.

Wartość Opis
MayPreempt

Może przewłaszczać

NotPreempt

Nie można wyprzedać

PreemptionVulnerability

Luka w zabezpieczeniach dotycząca wywłaszczania.

Wartość Opis
NotPreemptable

Nie można wywłaszać

Preemptable

Może zostać wywłaszczone

ProvisioningState

Bieżący stan aprowizacji.

Wartość Opis
Accepted
Canceled
Deleted
Deleting
Failed
Succeeded
Unknown

QosPolicy

Zasady QoS

Nazwa Typ Domyślna wartość Opis
5qi

integer (int32)

minimum: 1
maximum: 127
9

Wartość wskaźnika przepływu QoS 5G. 5QI identyfikuje konkretne leczenie przekazywania QoS, które ma zostać dostarczone do przepływu. Zobacz sekcję 3GPP TS23.501 5.7.2.1, aby uzyskać pełny opis parametru 5QI i tabeli 5.7.4-1, aby uzyskać definicję wartości 5QI.

allocationAndRetentionPriorityLevel

integer (int32)

minimum: 1
maximum: 15
9

Poziom alokacji i przechowywania przepływu QoS (ARP). Przepływy z wywłaszczanym priorytetem przepływy o niższym prioryfiksie, jeśli zezwalają na to ustawienia preemptionCapability i preemptionVulnerability. 1 jest najwyższym poziomem priorytetu. Jeśli to pole nie zostanie określone, 5qi zostanie użyta do uzyskania wartości ARP. Aby uzyskać pełny opis parametrów protokołu ARP, zobacz sekcję 3GPP TS23.501 5.7.2.2.

maximumBitRate

Ambr

Maksymalna szybkość bitów (MBR) dla wszystkich przepływów danych usługi korzystających z tej reguły zasad przepływu danych lub usługi.

preemptionCapability

PreemptionCapability

NotPreempt

Możliwość wywłaszczania przepływu QoS. Możliwość wywłaszczania przepływu QoS steruje tym, czy może wyprzedać inny przepływ QoS z niższym priorytetem. Aby uzyskać pełny opis parametrów protokołu ARP, zobacz sekcję 3GPP TS23.501 5.7.2.2.

preemptionVulnerability

PreemptionVulnerability

Preemptable

Luka w zabezpieczeniach dotycząca wywłaszczania przepływu QoS. Luka w zabezpieczeniach dotycząca wywłaszczania przepływu QoS steruje tym, czy może zostać wywłaszczone przez przepływ QoS z wyższym poziomem priorytetu. Aby uzyskać pełny opis parametrów protokołu ARP, zobacz sekcję 3GPP TS23.501 5.7.2.2.

SdfDirection

Kierunek przepływu danych usługi.

Wartość Opis
Bidirectional

Ruch przepływa zarówno do, jak i z UE.

Downlink

Ruch przepływujący z sieci danych do UE.

Uplink

Ruch przepływający z UE do sieci danych.

Service

Zasób usługi. Należy utworzyć w tej samej lokalizacji co nadrzędna sieć mobilna.

Nazwa Typ Opis
id

string (arm-id)

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.pccRules

PccRuleConfiguration[]

Zestaw reguł zasad przepływu danych, które tworzą tę usługę.

properties.provisioningState

ProvisioningState

Stan aprowizacji zasobu usługi.

properties.servicePrecedence

integer (int32)

minimum: 0
maximum: 255

Wartość pierwszeństwa używana do decydowania między usługami podczas identyfikowania wartości QoS do użycia dla określonej karty SIM. Niższa wartość oznacza wyższy priorytet. Ta wartość powinna być unikatowa wśród wszystkich usług skonfigurowanych w sieci komórkowej.

properties.serviceQosPolicy

QosPolicy

Zasady QoS do użycia dla pakietów pasujących do tej usługi. Można to zastąpić dla określonych przepływów przy użyciu pola ruleQosPolicy w pccRuleConfiguration. Jeśli to pole ma wartość null, zasady karty SIM ue zdefiniują ustawienia QoS.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ServiceDataFlowTemplate

Szablon przepływu danych

Nazwa Typ Opis
direction

SdfDirection

Kierunek tego przepływu.

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]))?$

Porty, z którymi będą łączyć się interfejsy użytkownika dla tego przepływu. Można określić zero lub więcej portów lub zakresów portów. Jeśli określisz co najmniej jeden port lub zakresy portów, musisz określić wartość inną niż ip w polu protocol. Jest to ustawienie opcjonalne. Jeśli nie określisz tego parametru, połączenia będą dozwolone na wszystkich portach. Zakresy portów muszą być określone jako -. Na przykład: [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])$

Lista dozwolonych protokołów dla tego przepływu. Jeśli chcesz, aby ten przepływ mógł używać dowolnego protokołu w pakiecie protokołów internetowych, użyj wartości ip. Jeśli chcesz zezwolić tylko na wybór protokołów, musisz użyć odpowiedniego numeru protokołu internetowego przypisanego przez IANA dla każdego protokołu, zgodnie z opisem w https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. Na przykład w przypadku protokołu UDP należy użyć wartości 17. Jeśli używasz wartości ip, musisz pozostawić pole port nieokreślone.

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])))$

Zdalny adres IP, z którym interfejsy użytkownika będą łączyć się dla tego przepływu. Jeśli chcesz zezwolić na połączenia na dowolnym adresie IP, użyj wartości any. W przeciwnym razie należy podać każdy z zdalnych adresów IP, z którymi będzie łączyć się wystąpienie podstawowe pakietu dla tego przepływu. Należy podać każdy adres IP w notacji CIDR, w tym maskę sieci (na przykład 192.0.2.54/24).

templateName

string

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

Nazwa szablonu przepływu danych. Musi to być unikatowe w ramach nadrzędnej reguły zasad przepływu danych. Nie można używać żadnych z następujących ciągów zarezerwowanych — default, requested ani service.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

TrafficControlPermission

Uprawnienie do kontroli ruchu.

Wartość Opis
Blocked

Ruch zgodny z tą regułą nie może przepływać.

Enabled

Ruch zgodny z tą regułą może przepływać.