Sim Policies - Get

Reference

Služba:: Mobile Network

Verze rozhraní API:: 2024-04-01

Získá informace o zadaných zásadách SIM.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
mobileNetworkName	path	True	string	Název mobilní sítě. Vzor regulárního výrazu: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
simPolicyName	path	True	string	Název zásady SIM karty. Vzor regulárního výrazu: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	SimPolicy	Žádost byla úspěšná. Operace vrátí výsledný prostředek zásad SIM karty.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get SIM policy

Ukázkový požadavek

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


/**
 * Samples for SimPolicies Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/SimPolicyGet.json
     */
    /**
     * Sample code: Get SIM policy.
     * 
     * @param manager Entry point to MobileNetworkManager.
     */
    public static void getSIMPolicy(com.azure.resourcemanager.mobilenetwork.MobileNetworkManager manager) {
        manager.simPolicies().getWithResponse("rg1", "testMobileNetwork", "testPolicy",
            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 sim_policy_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.sim_policies.get(
        resource_group_name="rg1",
        mobile_network_name="testMobileNetwork",
        sim_policy_name="testPolicy",
    )
    print(response)


# x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/SimPolicyGet.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/SimPolicyGet.json
func ExampleSimPoliciesClient_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.NewSimPoliciesClient().Get(ctx, "rg1", "testMobileNetwork", "testPolicy", 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.SimPolicy = armmobilenetwork.SimPolicy{
	// 	Name: to.Ptr("testPolicy"),
	// 	Type: to.Ptr("Microsoft.MobileNetwork/simPolicy"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy"),
	// 	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.SimPolicyPropertiesFormat{
	// 		DefaultSlice: &armmobilenetwork.SliceResourceID{
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"),
	// 		},
	// 		ProvisioningState: to.Ptr(armmobilenetwork.ProvisioningStateSucceeded),
	// 		RegistrationTimer: to.Ptr[int32](3240),
	// 		SiteProvisioningState: map[string]*armmobilenetwork.SiteProvisioningState{
	// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": to.Ptr(armmobilenetwork.SiteProvisioningStateAdding),
	// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": to.Ptr(armmobilenetwork.SiteProvisioningStateAdding),
	// 		},
	// 		SliceConfigurations: []*armmobilenetwork.SliceConfiguration{
	// 			{
	// 				DataNetworkConfigurations: []*armmobilenetwork.DataNetworkConfiguration{
	// 					{
	// 						FiveQi: to.Ptr[int32](9),
	// 						AdditionalAllowedSessionTypes: []*armmobilenetwork.PduSessionType{
	// 						},
	// 						AllocationAndRetentionPriorityLevel: to.Ptr[int32](9),
	// 						AllowedServices: []*armmobilenetwork.ServiceResourceID{
	// 							{
	// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService"),
	// 						}},
	// 						DataNetwork: &armmobilenetwork.DataNetworkResourceID{
	// 							ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"),
	// 						},
	// 						DefaultSessionType: to.Ptr(armmobilenetwork.PduSessionTypeIPv4),
	// 						MaximumNumberOfBufferedPackets: to.Ptr[int32](200),
	// 						PreemptionCapability: to.Ptr(armmobilenetwork.PreemptionCapabilityNotPreempt),
	// 						PreemptionVulnerability: to.Ptr(armmobilenetwork.PreemptionVulnerabilityPreemptable),
	// 						SessionAmbr: &armmobilenetwork.Ambr{
	// 							Downlink: to.Ptr("1 Gbps"),
	// 							Uplink: to.Ptr("500 Mbps"),
	// 						},
	// 				}},
	// 				DefaultDataNetwork: &armmobilenetwork.DataNetworkResourceID{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"),
	// 				},
	// 				Slice: &armmobilenetwork.SliceResourceID{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"),
	// 				},
	// 		}},
	// 		UeAmbr: &armmobilenetwork.Ambr{
	// 			Downlink: to.Ptr("1 Gbps"),
	// 			Uplink: to.Ptr("500 Mbps"),
	// 		},
	// 	},
	// }
}

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 SIM policy.
 *
 * @summary Gets information about the specified SIM policy.
 * x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/SimPolicyGet.json
 */
async function getSimPolicy() {
  const subscriptionId =
    process.env["MOBILENETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MOBILENETWORK_RESOURCE_GROUP"] || "rg1";
  const mobileNetworkName = "testMobileNetwork";
  const simPolicyName = "testPolicy";
  const credential = new DefaultAzureCredential();
  const client = new MobileNetworkManagementClient(credential, subscriptionId);
  const result = await client.simPolicies.get(resourceGroupName, mobileNetworkName, simPolicyName);
  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

Ukázková odpověď

Stavový kód:: 200

{
  "name": "testPolicy",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy",
  "type": "Microsoft.MobileNetwork/simPolicy",
  "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",
    "siteProvisioningState": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": "Adding",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": "Adding"
    },
    "registrationTimer": 3240,
    "ueAmbr": {
      "uplink": "500 Mbps",
      "downlink": "1 Gbps"
    },
    "defaultSlice": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
    },
    "sliceConfigurations": [
      {
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "defaultDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
        },
        "dataNetworkConfigurations": [
          {
            "dataNetwork": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"
            },
            "sessionAmbr": {
              "uplink": "500 Mbps",
              "downlink": "1 Gbps"
            },
            "5qi": 9,
            "allocationAndRetentionPriorityLevel": 9,
            "preemptionCapability": "NotPreempt",
            "preemptionVulnerability": "Preemptable",
            "defaultSessionType": "IPv4",
            "additionalAllowedSessionTypes": [],
            "allowedServices": [
              {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService"
              }
            ],
            "maximumNumberOfBufferedPackets": 200
          }
        ]
      }
    ]
  }
}

Definice

Name	Description
Ambr	Agregovat maximální přenosovou rychlost.
createdByType	Typ identity, která prostředek vytvořila.
DataNetworkConfiguration	Nastavení, která řídí použití datové sítě
DataNetworkResourceId	Odkaz na prostředek datové sítě.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
PduSessionType	Typ relace pdu (IPv4/IPv6).
PreemptionCapability	Preempční schopnost.
PreemptionVulnerability	Ohrožení zabezpečení z hlediska preempce
ProvisioningState	Aktuální stav zřizování.
ServiceResourceId	Odkaz na prostředek služby
SimPolicy	Prostředek zásad SIM karty.
SliceConfiguration	Nastavení jednotlivých řezů
SliceResourceId	Odkaz na prostředek řezu
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

Ambr

Agregovat maximální přenosovou rychlost.

Name	Typ	Description
downlink	string	Přenosová rychlost downlinku.
uplink	string	Přenosová rychlost odesílání.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataNetworkConfiguration

Nastavení, která řídí použití datové sítě

Name	Typ	Default value	Description
5qi	integer	9	Výchozí hodnota indikátoru toku QoS 5G 5QI identifikuje konkrétní proceduru předávání QoS, která se má toku poskytnout. Úplný popis parametru 5QI najdete v článku 3GPP TS23.501 v oddílu 5.7.2.1 a v tabulce 5.7.4-1 pro definici hodnot 5QI.
additionalAllowedSessionTypes	PduSessionType[]		Povolené typy relací kromě výchozího typu relace. Výchozí typ relace nesmí duplikovat.
allocationAndRetentionPriorityLevel	integer	9	Výchozí úroveň přidělování a priority uchovávání (ARP) toku QoS. Toky s vyšší prioritou zaměňují toky s nižší prioritou, pokud to nastavení `preemptionCapability` a `preemptionVulnerability` umožňují. 1 je nejvyšší úroveň priority. Pokud toto pole není zadané `5qi` , použije se k odvození hodnoty protokolu ARP. Úplný popis parametrů ARP najdete v článku 3GPP TS23.501 v části 5.7.2.2.
allowedServices	ServiceResourceId[]		Seznam služeb, které je možné použít jako součást této zásady SIM. Seznam nesmí obsahovat duplicitní položky a musí obsahovat alespoň jednu položku. Služby musí být ve stejném umístění jako zásady SIM karty.
dataNetwork	DataNetworkResourceId		Odkaz na datovou síť, pro kterou se tato nastavení vztahují. Datová síť musí být ve stejném umístění jako zásady SIM karty.
defaultSessionType	PduSessionType	IPv4	Výchozí typ relace primárního řadiče domény, který se použije v případě, že uživatelské prostředí nevyžaduje konkrétní typ relace.
maximumNumberOfBufferedPackets	integer	10	Maximální počet paketů downlinku, které se mají ukládat do vyrovnávací paměti v rovině uživatele pro komunikaci s vysokou latencí – rozšířené ukládání do vyrovnávací paměti. Úplný popis viz 3GPP TS29.272 v15.10.0 oddíl 7.3.188. Toto maximum není zaručeno, protože pro všechny relace primárního řadiče domény platí interní limit pro pakety ve vyrovnávací paměti.
preemptionCapability	PreemptionCapability	NotPreempt	Výchozí možnost preempce toku QoS Funkce preempce toku QoS určuje, jestli může předejde jinému toku QoS s nižší prioritou. Úplný popis parametrů ARP najdete v článku 3GPP TS23.501 v části 5.7.2.2.
preemptionVulnerability	PreemptionVulnerability	Preemptable	Ohrožení zabezpečení spočívající v preempci výchozího toku QoS Ohrožení zabezpečení preempce toku QoS určuje, jestli ho může tok QoS s vyšší úrovní priority zneužít. Úplný popis parametrů ARP najdete v článku 3GPP TS23.501 v části 5.7.2.2.
sessionAmbr	Ambr		Agregovat maximální přenosovou rychlost napříč všemi toky QoS bez GBR dané relace primárního řadiče domény. Úplný popis relace-AMBR najdete v článku 3GPP TS23.501 v části 5.7.2.6.

DataNetworkResourceId

Odkaz na prostředek datové sítě.

Name	Typ	Description
id	string	ID prostředku datové sítě.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

PduSessionType

Typ relace pdu (IPv4/IPv6).

Name	Typ	Description
IPv4	string
IPv6	string

PreemptionCapability

Preempční schopnost.

Name	Typ	Description
MayPreempt	string	Může dojít k preempt
NotPreempt	string	Nelze přepít.

PreemptionVulnerability

Ohrožení zabezpečení z hlediska preempce

Name	Typ	Description
NotPreemptable	string	Nelze ho zmácet.
Preemptable	string	Může být zrušena

ProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Accepted	string
Canceled	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Unknown	string

ServiceResourceId

Odkaz na prostředek služby

Name	Typ	Description
id	string	ID prostředku služby.

SimPolicy

Prostředek zásad SIM karty.

Name	Typ	Default value	Description
id	string		Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
location	string		Geografické umístění, kde se prostředek nachází
name	string		Název prostředku
properties.defaultSlice	SliceResourceId		Výchozí řez, který se má použít, pokud ho UE explicitně neurcuje. Tento řez musí existovat v mapě `sliceConfigurations` . Řez musí být ve stejném umístění jako zásady SIM karty.
properties.provisioningState	ProvisioningState		Stav zřizování prostředku zásad SIM.
properties.registrationTimer	integer	3240	Časovač aktualizace pravidelné registrace UE (5G) nebo časovač aktualizace oblasti pravidelného sledování UE (4G) v sekundách.
properties.rfspIndex	integer		RAT/Frequency Selection Priority Index, definovaný v 3GPP TS 36.413. Toto nastavení je volitelné a ve výchozím nastavení není určeno.
properties.siteProvisioningState	object		Slovník webů pro stav zřizování této zásady SIM na tomto webu.
properties.sliceConfigurations	SliceConfiguration[]		Povolené řezy a nastavení, která se pro ně mají použít. Seznam nesmí obsahovat duplicitní položky a musí obsahovat alespoň jednu položku.
properties.ueAmbr	Ambr		Agregovat maximální přenosovou rychlost napříč všemi toky QoS bez GBR všech relací primárního řadiče domény daného UE. Úplný popis UE-AMBR najdete v článku 3GPP TS23.501 v části 5.7.2.6.
systemData	systemData		Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object		Značky prostředků.
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SliceConfiguration

Nastavení jednotlivých řezů

Name	Typ	Description
dataNetworkConfigurations	DataNetworkConfiguration[]	Povolené datové sítě a nastavení, která se pro ně mají použít. Seznam nesmí obsahovat duplicitní položky a musí obsahovat alespoň jednu položku.
defaultDataNetwork	DataNetworkResourceId	Výchozí datová síť, která se má použít, pokud ji UE explicitně nezadá. V mapě musí existovat konfigurace tohoto objektu `dataNetworkConfigurations` . Datová síť musí být ve stejném umístění jako zásady SIM karty.
slice	SliceResourceId	Odkaz na řez, na který se tato nastavení vztahují. Řez musí být ve stejném umístění jako zásady SIM karty.

SliceResourceId

Odkaz na prostředek řezu

Name	Typ	Description
id	string	Id prostředku průřezu

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Sim Policies - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Get SIM policy

Ukázkový požadavek

Ukázková odpověď

Definice

Ambr

createdByType

DataNetworkConfiguration

DataNetworkResourceId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PduSessionType

PreemptionCapability

PreemptionVulnerability

ProvisioningState

ServiceResourceId

SimPolicy

SliceConfiguration

SliceResourceId

systemData

Další materiály