Services - Get

Referencia

Servicio:: Mobile Network

Versión de la API:: 2024-04-01

Obtiene información sobre el servicio especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
mobileNetworkName	path	True	string	Nombre de la red móvil. Patrón de Regex: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	El nombre del servicio. No debe usar ninguna de las siguientes cadenas reservadas: `default`, `requested` o `service` Patrón de Regex: `^(?!(default\|requested\|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$`
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	Service	Solicite correctamente. La operación devuelve el recurso de servicio resultante.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get service

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
Ambr	Velocidad de bits máxima agregada.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PccRuleConfiguration	Configuración de reglas de directiva de flujo de datos
PccRuleQosPolicy	Directiva QoS de la regla de directiva de flujo de datos
PreemptionCapability	Funcionalidad de adelantamiento.
PreemptionVulnerability	Vulnerabilidad de adelantamiento.
ProvisioningState	Estado de aprovisionamiento actual.
QosPolicy	Directiva de QoS
SdfDirection	Dirección del flujo de datos del servicio.
Service	Recurso de servicio. Debe crearse en la misma ubicación que su red móvil primaria.
ServiceDataFlowTemplate	Plantilla de flujo de datos
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
TrafficControlPermission	Permiso de control de tráfico.

Ambr

Velocidad de bits máxima agregada.

Nombre	Tipo	Description
downlink	string	Velocidad de bits de vínculo descendente.
uplink	string	Velocidad de bits de vínculo superior.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

PccRuleConfiguration

Configuración de reglas de directiva de flujo de datos

Nombre	Tipo	Valor predeterminado	Description
ruleName	string		Nombre de la regla. Debe ser único dentro del servicio primario. No debe usar ninguna de las siguientes cadenas reservadas: `default`, `requested` o `service`.
rulePrecedence	integer		Valor de precedencia que se usa para decidir entre reglas de directiva de flujo de datos al identificar los valores de QoS que se van a usar para una SIM determinada. Un valor más bajo representa una prioridad más alta. Este valor debe ser único entre todas las reglas de directiva de flujo de datos configuradas en la red móvil.
ruleQosPolicy	PccRuleQosPolicy		La directiva QoS que se va a usar para los paquetes que coinciden con esta regla. Si este campo es null, el servicio primario definirá la configuración de QoS.
serviceDataFlowTemplates	ServiceDataFlowTemplate[]		Conjunto de plantillas de flujo de datos que se van a usar para esta regla de directiva de flujo de datos.
trafficControl	TrafficControlPermission	Enabled	Determina si se permiten flujos que coincidan con esta regla de directiva de flujo de datos.

PccRuleQosPolicy

Directiva QoS de la regla de directiva de flujo de datos

Nombre	Tipo	Valor predeterminado	Description
5qi	integer	9	Valor del indicador de flujo de QoS 5G. El 5QI identifica un tratamiento específico de reenvío de QoS que se va a proporcionar a un flujo. Vea 3GPP TS23.501 sección 5.7.2.1 para obtener una descripción completa del parámetro 5QI y la tabla 5.7.4-1 para la definición de los valores de 5QI.
allocationAndRetentionPriorityLevel	integer	9	Nivel de prioridad de retención y asignación de flujo de QoS (ARP). Fluye con un preempt de prioridad más alta con prioridad más baja, si la configuración de `preemptionCapability` y `preemptionVulnerability` la permite. 1 es el nivel de prioridad más alto. Si no se especifica este campo, `5qi` se usa para derivar el valor de ARP. Consulte la sección 5.7.2.2.2 de 3GPP TS23.501 para obtener una descripción completa de los parámetros de ARP.
guaranteedBitRate	Ambr		Velocidad de bits garantizada (GBR) para todos los flujos de datos de servicio que usan esta regla de directiva de flujo de datos. Se trata de un parámetro opcional. Si no proporciona un valor, no habrá ningún GBR establecido para la regla de directiva de flujo de datos que use esta definición de QoS.
maximumBitRate	Ambr		Velocidad de bits máxima (MBR) para todos los flujos de datos de servicio que usan esta regla de directiva de flujo de datos o servicio.
preemptionCapability	PreemptionCapability	NotPreempt	Funcionalidad de adelantamiento de QoS Flow. La funcionalidad de adelantamiento de un flujo de QoS controla si puede adelantar a otro flujo de QoS con un nivel de prioridad inferior. Consulte la sección 5.7.2.2.2 de 3GPP TS23.501 para obtener una descripción completa de los parámetros de ARP.
preemptionVulnerability	PreemptionVulnerability	Preemptable	Vulnerabilidad de adelantamiento de QoS Flow. La vulnerabilidad de adelantamiento de un flujo de QoS controla si puede ser adelantada por un flujo de QoS con un nivel de prioridad más alto. Consulte la sección 5.7.2.2.2 de 3GPP TS23.501 para obtener una descripción completa de los parámetros de ARP.

PreemptionCapability

Funcionalidad de adelantamiento.

Nombre	Tipo	Description
MayPreempt	string	Puede adelantamiento
NotPreempt	string	No se puede anteponer

PreemptionVulnerability

Vulnerabilidad de adelantamiento.

Nombre	Tipo	Description
NotPreemptable	string	No se puede adelantamiento
Preemptable	string	Se puede adelantamiento

ProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Accepted	string
Canceled	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Unknown	string

QosPolicy

Directiva de QoS

Nombre	Tipo	Valor predeterminado	Description
5qi	integer	9	Valor del indicador de flujo de QoS 5G. El 5QI identifica un tratamiento específico de reenvío de QoS que se va a proporcionar a un flujo. Vea 3GPP TS23.501 sección 5.7.2.1 para obtener una descripción completa del parámetro 5QI y la tabla 5.7.4-1 para la definición de los valores de 5QI.
allocationAndRetentionPriorityLevel	integer	9	Nivel de prioridad de retención y asignación de flujo de QoS (ARP). Fluye con un preempt de prioridad más alta con prioridad más baja, si la configuración de `preemptionCapability` y `preemptionVulnerability` la permite. 1 es el nivel de prioridad más alto. Si no se especifica este campo, `5qi` se usa para derivar el valor de ARP. Consulte la sección 5.7.2.2.2 de 3GPP TS23.501 para obtener una descripción completa de los parámetros de ARP.
maximumBitRate	Ambr		Velocidad de bits máxima (MBR) para todos los flujos de datos de servicio que usan esta regla de directiva de flujo de datos o servicio.
preemptionCapability	PreemptionCapability	NotPreempt	Funcionalidad de adelantamiento de QoS Flow. La funcionalidad de adelantamiento de un flujo de QoS controla si puede adelantar a otro flujo de QoS con un nivel de prioridad inferior. Consulte la sección 5.7.2.2.2 de 3GPP TS23.501 para obtener una descripción completa de los parámetros de ARP.
preemptionVulnerability	PreemptionVulnerability	Preemptable	Vulnerabilidad de adelantamiento de QoS Flow. La vulnerabilidad de adelantamiento de un flujo de QoS controla si puede ser adelantada por un flujo de QoS con un nivel de prioridad más alto. Consulte la sección 5.7.2.2.2 de 3GPP TS23.501 para obtener una descripción completa de los parámetros de ARP.

SdfDirection

Dirección del flujo de datos del servicio.

Nombre	Tipo	Description
Bidirectional	string	Tráfico que fluye hacia y desde la UE.
Downlink	string	Tráfico que fluye desde la red de datos a la UE.
Uplink	string	Tráfico que fluye desde la UE a la red de datos.

Service

Recurso de servicio. Debe crearse en la misma ubicación que su red móvil primaria.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.pccRules	PccRuleConfiguration[]	Conjunto de reglas de directiva de flujo de datos que componen este servicio.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de servicio.
properties.servicePrecedence	integer	Valor de precedencia que se usa para decidir entre servicios al identificar los valores de QoS que se van a usar para una SIM determinada. Un valor más bajo representa una prioridad más alta. Este valor debe ser único entre todos los servicios configurados en la red móvil.
properties.serviceQosPolicy	QosPolicy	La directiva QoS que se va a usar para los paquetes que coinciden con este servicio. Esto se puede invalidar para flujos concretos mediante el campo ruleQosPolicy en una PccRuleConfiguration. Si este campo es null, la directiva sim de la UE definirá la configuración de QoS.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ServiceDataFlowTemplate

Plantilla de flujo de datos

Nombre	Tipo	Description
direction	SdfDirection	Dirección de este flujo.
ports	string[]	Los puertos a los que se conectarán los ESTADOS para este flujo. Puede especificar cero o más puertos o intervalos de puertos. Si especifica uno o varios puertos o intervalos de puertos, debe especificar un valor distinto `ip` de en el `protocol` campo . Se trata de un parámetro opcional. Si no lo especifica, se permitirán conexiones en todos los puertos. Los intervalos de puertos deben especificarse como -. Por ejemplo: [`8080`, `8082-8085`].
protocol	string[]	Lista de los protocolos permitidos para este flujo. Si desea que este flujo pueda usar cualquier protocolo dentro del conjunto de protocolos de Internet, use el valor `ip`. Si solo desea permitir una selección de protocolos, debe usar el número de protocolo de Internet asignado de IANA correspondiente para cada protocolo, como se describe en https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. Por ejemplo, para UDP, debe usar 17. Si usa el valor `ip` , debe dejar el campo `port` sin especificar.
remoteIpList	string[]	Direcciones IP remotas a las que se conectarán los UE para este flujo. Si desea permitir conexiones en cualquier dirección IP, use el valor `any`. De lo contrario, debe proporcionar cada una de las direcciones IP remotas a las que se conectará la instancia de núcleo del paquete para este flujo. Debe proporcionar cada dirección IP en notación CIDR, incluida la máscara de red (por ejemplo, 192.0.2.54/24).
templateName	string	Nombre de la plantilla de flujo de datos. Debe ser único dentro de la regla de directiva de flujo de datos principal. No debe usar ninguna de las siguientes cadenas reservadas: `default`, `requested` o `service`.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TrafficControlPermission

Permiso de control de tráfico.

Nombre	Tipo	Description
Blocked	string	No se permite que el tráfico que coincida con esta regla fluya.
Enabled	string	El tráfico que coincide con esta regla puede fluir.

Compartir a través de

Services - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get service

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Ambr

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PccRuleConfiguration

PccRuleQosPolicy

PreemptionCapability

PreemptionVulnerability

ProvisioningState

QosPolicy

SdfDirection

Service

ServiceDataFlowTemplate

systemData

TrafficControlPermission

Recursos adicionales