Services - Get

Référence

Service:: Mobile Network

Version d'API:: 2024-04-01

Obtient des informations sur le service spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
mobileNetworkName	path	True	string	Nom du réseau mobile. Modèle d’expression régulière: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string	Nom du service. Vous ne devez pas utiliser les chaînes réservées suivantes : `default`, `requested` ou `service` Modèle d’expression régulière: `^(?!(default\|requested\|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$`
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	Service	Demande réussie. L’opération retourne la ressource de service résultante.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Get service

Exemple de requête

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


/**
 * Samples for Services Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/ServiceGet.json
     */
    /**
     * Sample code: Get service.
     * 
     * @param manager Entry point to MobileNetworkManager.
     */
    public static void getService(com.azure.resourcemanager.mobilenetwork.MobileNetworkManager manager) {
        manager.services().getWithResponse("rg1", "testMobileNetwork", "TestService", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.mobilenetwork import MobileNetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mobilenetwork
# USAGE
    python service_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MobileNetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.services.get(
        resource_group_name="rg1",
        mobile_network_name="testMobileNetwork",
        service_name="TestService",
    )
    print(response)


# x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/ServiceGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmobilenetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d88c94b22a8efdd47c0cadfe6d8d489107db2b23/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/ServiceGet.json
func ExampleServicesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmobilenetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().Get(ctx, "rg1", "testMobileNetwork", "TestService", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Service = armmobilenetwork.Service{
	// 	Name: to.Ptr("testPolicy"),
	// 	Type: to.Ptr("Microsoft.MobileNetwork/service"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/TestService"),
	// 	SystemData: &armmobilenetwork.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armmobilenetwork.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armmobilenetwork.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armmobilenetwork.ServicePropertiesFormat{
	// 		PccRules: []*armmobilenetwork.PccRuleConfiguration{
	// 			{
	// 				RuleName: to.Ptr("default-rule"),
	// 				RulePrecedence: to.Ptr[int32](255),
	// 				RuleQosPolicy: &armmobilenetwork.PccRuleQosPolicy{
	// 					FiveQi: to.Ptr[int32](9),
	// 					AllocationAndRetentionPriorityLevel: to.Ptr[int32](9),
	// 					MaximumBitRate: &armmobilenetwork.Ambr{
	// 						Downlink: to.Ptr("1 Gbps"),
	// 						Uplink: to.Ptr("500 Mbps"),
	// 					},
	// 					PreemptionCapability: to.Ptr(armmobilenetwork.PreemptionCapabilityNotPreempt),
	// 					PreemptionVulnerability: to.Ptr(armmobilenetwork.PreemptionVulnerabilityPreemptable),
	// 				},
	// 				ServiceDataFlowTemplates: []*armmobilenetwork.ServiceDataFlowTemplate{
	// 					{
	// 						Direction: to.Ptr(armmobilenetwork.SdfDirectionUplink),
	// 						Ports: []*string{
	// 						},
	// 						RemoteIPList: []*string{
	// 							to.Ptr("10.3.4.0/24")},
	// 							TemplateName: to.Ptr("IP-to-server"),
	// 							Protocol: []*string{
	// 								to.Ptr("ip")},
	// 						}},
	// 						TrafficControl: to.Ptr(armmobilenetwork.TrafficControlPermissionEnabled),
	// 				}},
	// 				ProvisioningState: to.Ptr(armmobilenetwork.ProvisioningStateSucceeded),
	// 				ServicePrecedence: to.Ptr[int32](255),
	// 				ServiceQosPolicy: &armmobilenetwork.QosPolicy{
	// 					FiveQi: to.Ptr[int32](9),
	// 					AllocationAndRetentionPriorityLevel: to.Ptr[int32](9),
	// 					MaximumBitRate: &armmobilenetwork.Ambr{
	// 						Downlink: to.Ptr("1 Gbps"),
	// 						Uplink: to.Ptr("500 Mbps"),
	// 					},
	// 					PreemptionCapability: to.Ptr(armmobilenetwork.PreemptionCapabilityNotPreempt),
	// 					PreemptionVulnerability: to.Ptr(armmobilenetwork.PreemptionVulnerabilityPreemptable),
	// 				},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MobileNetworkManagementClient } = require("@azure/arm-mobilenetwork");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified service.
 *
 * @summary Gets information about the specified service.
 * x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/ServiceGet.json
 */
async function getService() {
  const subscriptionId =
    process.env["MOBILENETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MOBILENETWORK_RESOURCE_GROUP"] || "rg1";
  const mobileNetworkName = "testMobileNetwork";
  const serviceName = "TestService";
  const credential = new DefaultAzureCredential();
  const client = new MobileNetworkManagementClient(credential, subscriptionId);
  const result = await client.services.get(resourceGroupName, mobileNetworkName, serviceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
Ambr	Agréger le débit binaire maximal.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
PccRuleConfiguration	Configuration de la règle de stratégie de flux de données
PccRuleQosPolicy	Stratégie QoS de règle de stratégie de flux de données
PreemptionCapability	Fonctionnalité de préemption.
PreemptionVulnerability	Vulnérabilité de préemption.
ProvisioningState	État d’approvisionnement actuel.
QosPolicy	Stratégie QoS
SdfDirection	Direction du flux de données de service.
Service	Ressource de service. Doit être créé au même emplacement que son réseau mobile parent.
ServiceDataFlowTemplate	Modèle de flux de données
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TrafficControlPermission	Autorisation de contrôle du trafic.

Ambr

Agréger le débit binaire maximal.

Nom	Type	Description
downlink	string	Débit de liaison descendante.
uplink	string	Débit de liaison montante.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

PccRuleConfiguration

Configuration de la règle de stratégie de flux de données

Nom	Type	Valeur par défaut	Description
ruleName	string		nom de la règle. Cela doit être unique au sein du service parent. Vous ne devez utiliser aucune des chaînes réservées suivantes : `default`, `requested` ou `service`.
rulePrecedence	integer		Valeur de précédence utilisée pour choisir entre les règles de stratégie de flux de données lors de l’identification des valeurs QoS à utiliser pour une carte SIM particulière. Une valeur inférieure indique une priorité plus élevée. Cette valeur doit être unique parmi toutes les règles de stratégie de flux de données configurées dans le réseau mobile.
ruleQosPolicy	PccRuleQosPolicy		Stratégie QoS à utiliser pour les paquets correspondant à cette règle. Si ce champ a la valeur Null, le service parent définit les paramètres QoS.
serviceDataFlowTemplates	ServiceDataFlowTemplate[]		Ensemble de modèles de flux de données à utiliser pour cette règle de stratégie de flux de données.
trafficControl	TrafficControlPermission	Enabled	Détermine si les flux qui correspondent à cette règle de stratégie de flux de données sont autorisés.

PccRuleQosPolicy

Stratégie QoS de règle de stratégie de flux de données

Nom	Type	Valeur par défaut	Description
5qi	integer	9	Valeur de l’indicateur de flux QoS 5G. Le 5QI identifie un traitement de transfert QoS spécifique à fournir à un flux. Consultez 3GPP TS23.501 section 5.7.2.1 pour obtenir une description complète du paramètre 5QI et le tableau 5.7.4-1 pour la définition des valeurs 5QI.
allocationAndRetentionPriorityLevel	integer	9	Niveau de priorité d’allocation et de rétention de flux QoS (ARP). Les flux avec une priorité plus élevée préemptent les flux avec une priorité inférieure, si les paramètres de `preemptionCapability` et `preemptionVulnerability` l’autorisent. 1 est le niveau de priorité le plus élevé. Si ce champ n’est pas spécifié, `5qi` est utilisé pour dériver la valeur ARP. Pour obtenir une description complète des paramètres ARP, consultez la section 5.7.2.2 de 3GPP TS23.501.
guaranteedBitRate	Ambr		Débit binaire garanti (GBR) pour tous les flux de données de service qui utilisent cette règle de stratégie de flux de données. Ce paramètre est facultatif. Si vous ne fournissez pas de valeur, il n’y aura pas de paramètre GBR défini pour la règle de stratégie de flux de données qui utilise cette définition qoS.
maximumBitRate	Ambr		Débit binaire maximal (MBR) pour tous les flux de données de service qui utilisent cette règle ou ce service de stratégie de flux de données.
preemptionCapability	PreemptionCapability	NotPreempt	Fonctionnalité de préemption de flux QoS. La capacité de préemption d’un flux QoS détermine si ce flux peut préempter un autre flux QoS ayant un niveau de priorité inférieur. Pour obtenir une description complète des paramètres ARP, consultez la section 5.7.2.2 de 3GPP TS23.501.
preemptionVulnerability	PreemptionVulnerability	Preemptable	Vulnérabilité de préemption de flux QoS. La vulnérabilité de préemption d’un flux QoS détermine s’il peut être préempté par un flux QoS avec un niveau de priorité plus élevé. Pour obtenir une description complète des paramètres ARP, consultez la section 5.7.2.2 de 3GPP TS23.501.

PreemptionCapability

Fonctionnalité de préemption.

Nom	Type	Description
MayPreempt	string	Préempter mai
NotPreempt	string	Impossible de préempter

PreemptionVulnerability

Vulnérabilité de préemption.

Nom	Type	Description
NotPreemptable	string	Ne peut pas être préempté
Preemptable	string	Peut être préempté

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Accepted	string
Canceled	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Unknown	string

QosPolicy

Stratégie QoS

Nom	Type	Valeur par défaut	Description
5qi	integer	9	Valeur de l’indicateur de flux QoS 5G. Le 5QI identifie un traitement de transfert QoS spécifique à fournir à un flux. Consultez 3GPP TS23.501 section 5.7.2.1 pour obtenir une description complète du paramètre 5QI et le tableau 5.7.4-1 pour la définition des valeurs 5QI.
allocationAndRetentionPriorityLevel	integer	9	Niveau de priorité d’allocation et de rétention de flux QoS (ARP). Les flux avec une priorité plus élevée préemptent les flux avec une priorité inférieure, si les paramètres de `preemptionCapability` et `preemptionVulnerability` l’autorisent. 1 est le niveau de priorité le plus élevé. Si ce champ n’est pas spécifié, `5qi` est utilisé pour dériver la valeur ARP. Pour obtenir une description complète des paramètres ARP, consultez la section 5.7.2.2 de 3GPP TS23.501.
maximumBitRate	Ambr		Débit binaire maximal (MBR) pour tous les flux de données de service qui utilisent cette règle ou ce service de stratégie de flux de données.
preemptionCapability	PreemptionCapability	NotPreempt	Fonctionnalité de préemption de flux QoS. La capacité de préemption d’un flux QoS détermine si ce flux peut préempter un autre flux QoS ayant un niveau de priorité inférieur. Pour obtenir une description complète des paramètres ARP, consultez la section 5.7.2.2 de 3GPP TS23.501.
preemptionVulnerability	PreemptionVulnerability	Preemptable	Vulnérabilité de préemption de flux QoS. La vulnérabilité de préemption d’un flux QoS détermine s’il peut être préempté par un flux QoS avec un niveau de priorité plus élevé. Pour obtenir une description complète des paramètres ARP, consultez la section 5.7.2.2 de 3GPP TS23.501.

SdfDirection

Direction du flux de données de service.

Nom	Type	Description
Bidirectional	string	Trafic circulant à la fois vers et depuis l’ue.
Downlink	string	Trafic circulant du réseau de données vers l’ue.
Uplink	string	Trafic circulant de l’ue vers le réseau de données.

Service

Ressource de service. Doit être créé au même emplacement que son réseau mobile parent.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties.pccRules	PccRuleConfiguration[]	Ensemble de règles de stratégie de flux de données qui composent ce service.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de service.
properties.servicePrecedence	integer	Valeur de précédence utilisée pour choisir entre les services lors de l’identification des valeurs QoS à utiliser pour une carte SIM particulière. Une valeur inférieure indique une priorité plus élevée. Cette valeur doit être unique parmi tous les services configurés dans le réseau mobile.
properties.serviceQosPolicy	QosPolicy	Stratégie QoS à utiliser pour les paquets correspondant à ce service. Cela peut être remplacé pour des flux particuliers à l’aide du champ ruleQosPolicy dans un PccRuleConfiguration. Si ce champ est null, la stratégie SIM de l’ue définit les paramètres QoS.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ServiceDataFlowTemplate

Modèle de flux de données

Nom	Type	Description
direction	SdfDirection	Sens de ce flux.
ports	string[]	Port(s) auquel les E/S se connectent pour ce flux. Vous pouvez spécifier zéro ou plusieurs ports ou plages de ports. Si vous spécifiez un ou plusieurs ports ou plages de ports, vous devez spécifier une valeur autre que `ip` dans le `protocol` champ . Ce paramètre est facultatif. Si vous ne le spécifiez pas, les connexions sont autorisées sur tous les ports. Les plages de ports doivent être spécifiées sous la forme -. Par exemple : [`8080`, `8082-8085`].
protocol	string[]	Liste des protocoles autorisés pour ce flux. Si vous souhaitez que ce flux puisse utiliser n’importe quel protocole dans la suite de protocoles Internet, utilisez la valeur `ip`. Si vous souhaitez uniquement autoriser une sélection de protocoles, vous devez utiliser le numéro de protocole Internet attribué IANA correspondant pour chaque protocole, comme décrit dans https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. Par exemple, pour UDP, vous devez utiliser 17. Si vous utilisez la valeur `ip` , vous devez laisser le champ `port` non spécifié.
remoteIpList	string[]	Chaque adresse IP distante à laquelle les UE se connecteront pour ce flux. Si vous souhaitez autoriser les connexions sur n’importe quelle adresse IP, utilisez la valeur `any`. Sinon, vous devez fournir chacune des adresses IP distantes auxquelles le cœur de paquets instance se connectera pour ce flux. Vous devez fournir chaque adresse IP en notation CIDR, y compris le masque réseau (par exemple, 192.0.2.54/24).
templateName	string	Nom du modèle de flux de données. Cela doit être unique dans la règle de stratégie de flux de données parent. Vous ne devez utiliser aucune des chaînes réservées suivantes : `default`, `requested` ou `service`.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TrafficControlPermission

Autorisation de contrôle du trafic.

Nom	Type	Description
Blocked	string	Le trafic correspondant à cette règle n’est pas autorisé à circuler.
Enabled	string	Le trafic correspondant à cette règle est autorisé à circuler.

Partager via

Services - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get service

Exemple de requête

Exemple de réponse

Définitions

Ambr

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PccRuleConfiguration

PccRuleQosPolicy

PreemptionCapability

PreemptionVulnerability

ProvisioningState

QosPolicy

SdfDirection

Service

ServiceDataFlowTemplate

systemData

TrafficControlPermission

Ressources supplémentaires