Sim Policies - Get

リファレンス

サービス:: Mobile Network

API バージョン:: 2024-04-01

指定した SIM ポリシーに関する情報を取得します。

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

URI パラメーター

名前	/	必須	型	説明
mobileNetworkName	path	True	string	モバイルネットワークの名前。正規表現パターン: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
simPolicyName	path	True	string	SIM ポリシーの名前。正規表現パターン: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
subscriptionId	path	True	string uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	SimPolicy	要求が成功しました。この操作は、結果の SIM ポリシーリソースを返します。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get SIM policy

要求のサンプル

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

応答のサンプル

状態コード:: 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
          }
        ]
      }
    ]
  }
}

定義

名前	説明
Ambr	最大ビットレートを集計します。
createdByType	リソースを作成した ID の種類。
DataNetworkConfiguration	データネットワークの使用を制御する設定
DataNetworkResourceId	データネットワークリソースへの参照。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PduSessionType	PDU セッションの種類 (IPv4/IPv6)。
PreemptionCapability	プリエンプション機能。
PreemptionVulnerability	プリエンプションの脆弱性。
ProvisioningState	現在のプロビジョニング状態。
ServiceResourceId	サービスリソースへの参照。
SimPolicy	SIM ポリシーリソース。
SliceConfiguration	スライスごとの設定
SliceResourceId	スライスリソースへの参照。
systemData	リソースの作成と最後の変更に関連するメタデータ。

Ambr

最大ビットレートを集計します。

名前	型	説明
downlink	string	ダウンリンクビットレート。
uplink	string	アップリンクビットレート。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DataNetworkConfiguration

データネットワークの使用を制御する設定

名前	型	規定値	説明
5qi	integer	9	既定の 5G QoS フローインジケーター値。 5QI は、フローに提供される特定の QoS 転送処理を識別します。 5QI パラメーターの完全な説明については 3GPP TS23.501 セクション 5.7.2.1 を参照し、5QI 値の定義については表 5.7.4-1 を参照してください。
additionalAllowedSessionTypes	PduSessionType[]		既定のセッションの種類に加えて、許可されるセッションの種類。既定のセッションの種類を複製することはできません。
allocationAndRetentionPriorityLevel	integer	9	既定の QoS フローの割り当てとリテンション期間の優先順位 (ARP) レベル。優先度が高いフローは、の設定と`preemptionVulnerability`許可の場合、優先順位の`preemptionCapability`低いフローです。1 が最も優先度の高いレベルです。このフィールドが指定されていない場合は、 `5qi` ARP 値の派生に使用されます。 ARP パラメータの詳細な説明については、「3GPP TS23.501 セクション 5.7.2.2」を参照してください。
allowedServices	ServiceResourceId[]		この SIM ポリシーの一部として使用できるサービスの一覧。リストには重複するアイテムを含めず、少なくとも 1 つの項目を含む必要があります。サービスは SIM ポリシーと同じ場所にある必要があります。
dataNetwork	DataNetworkResourceId		これらの設定が適用されるデータネットワークへの参照。データネットワークは、SIM ポリシーと同じ場所にある必要があります。
defaultSessionType	PduSessionType	IPv4	既定の PDU セッションの種類。UE が特定のセッションの種類を要求しない場合に使用されます。
maximumNumberOfBufferedPackets	integer	10	高遅延通信 - 拡張バッファリングのためにユーザープレーンでバッファーするダウンリンクパケットの最大数。詳細については、3GPP TS29.272 v15.10.0 セクション 7.3.188 を参照してください。この最大値は、すべての PDU セッションにわたってバッファーされたパケットに内部的な制限があるため、保証されません。
preemptionCapability	PreemptionCapability	NotPreempt	既定の QoS フロープリエンプション機能。 QoS フローのプリエンプション機能は、QoS フローを、優先度レベルが低い別の QoS フローよりも優先させるかどうかを制御します。 ARP パラメータの詳細な説明については、「3GPP TS23.501 セクション 5.7.2.2」を参照してください。
preemptionVulnerability	PreemptionVulnerability	Preemptable	既定の QoS フロープリエンプションの脆弱性。 QoS フローのプリエンプション脆弱性は、優先度レベルの高い QoS フローによって優先できるかどうかを制御します。 ARP パラメータの詳細な説明については、「3GPP TS23.501 セクション 5.7.2.2」を参照してください。
sessionAmbr	Ambr		特定の PDU セッションのすべての非 GBR QoS フローの最大ビットレートを集計します。 Session-AMBR の完全な説明については、3GPP TS23.501 セクション 5.7.2.6 を参照してください。

DataNetworkResourceId

データネットワークリソースへの参照。

名前	型	説明
id	string	データネットワークリソース ID。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

PduSessionType

PDU セッションの種類 (IPv4/IPv6)。

名前	型	説明
IPv4	string
IPv6	string

PreemptionCapability

プリエンプション機能。

名前	型	説明
MayPreempt	string	5 月
NotPreempt	string	プリエンプトできない

PreemptionVulnerability

プリエンプションの脆弱性。

名前	型	説明
NotPreemptable	string	割り込むことができません
Preemptable	string	割り込まれる可能性がある

ProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Accepted	string
Canceled	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Unknown	string

ServiceResourceId

サービスリソースへの参照。

名前	型	説明
id	string	サービスリソース ID。

SimPolicy

SIM ポリシーリソース。

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		リソースが保存されている地理的な場所
name	string		リソースの名前
properties.defaultSlice	SliceResourceId		UE で明示的に指定されていない場合に使用する既定のスライス。このスライスはマップ内に存在する `sliceConfigurations` 必要があります。スライスは SIM ポリシーと同じ場所にある必要があります。
properties.provisioningState	ProvisioningState		SIM ポリシーリソースのプロビジョニング状態。
properties.registrationTimer	integer	3240	UE 定期登録更新タイマー (5G) または UE 定期追跡領域更新タイマー (4G) (秒)。
properties.rfspIndex	integer		RAT/Frequency Selection Priority Index(3GPP TS 36.413 で定義)。これは省略可能な設定であり、既定では指定されていません。
properties.siteProvisioningState	object		サイト上のこの SIM ポリシーのプロビジョニング状態に対するサイトの辞書。
properties.sliceConfigurations	SliceConfiguration[]		許可されたスライスと、それらに使用する設定。リストには重複するアイテムを含めず、少なくとも 1 つの項目を含む必要があります。
properties.ueAmbr	Ambr		特定の UE のすべての PDU セッションのすべての非 GBR QoS フロー全体の最大ビットレートを集計します。 UE-AMBR の完全な説明については、3GPP TS23.501 セクション 5.7.2.6 を参照してください。
systemData	systemData		createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object		リソースタグ。
type	string		リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SliceConfiguration

スライスごとの設定

名前	型	説明
dataNetworkConfigurations	DataNetworkConfiguration[]	許可されたデータネットワークと、それらに使用する設定。リストには重複するアイテムを含めず、少なくとも 1 つの項目を含む必要があります。
defaultDataNetwork	DataNetworkResourceId	UE で明示的に指定されていない場合に使用する既定のデータネットワーク。このオブジェクトの構成は、マップに存在する `dataNetworkConfigurations` 必要があります。データネットワークは、SIM ポリシーと同じ場所にある必要があります。
slice	SliceResourceId	これらの設定が適用されるスライスへの参照。スライスは SIM ポリシーと同じ場所にある必要があります。

SliceResourceId

スライスリソースへの参照。

名前	型	説明
id	string	スライスリソース ID。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Sim Policies - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

Get SIM policy

要求のサンプル

応答のサンプル

定義

Ambr

createdByType

DataNetworkConfiguration

DataNetworkResourceId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PduSessionType

PreemptionCapability

PreemptionVulnerability

ProvisioningState

ServiceResourceId

SimPolicy

SliceConfiguration

SliceResourceId

systemData

その他のリソース