Sims - Get

サービス:

Mobile Network

API バージョン:

2024-04-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/sims/{simName}?api-version=2024-04-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
simGroupName	path	True	string	SIM グループの名前。 正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
simName	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	Sim	要求が成功しました。 操作は、結果の 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

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroupName/providers/Microsoft.MobileNetwork/simGroups/testSimGroup/sims/testSimName?api-version=2024-04-01

Java

/**
 * Samples for Sims Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/SimGet.json
     */
    /**
     * Sample code: Get SIM.
     * 
     * @param manager Entry point to MobileNetworkManager.
     */
    public static void getSIM(com.azure.resourcemanager.mobilenetwork.MobileNetworkManager manager) {
        manager.sims().getWithResponse("testResourceGroupName", "testSimGroup", "testSimName",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mobilenetwork import MobileNetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mobilenetwork
# USAGE
    python sim_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.sims.get(
        resource_group_name="testResourceGroupName",
        sim_group_name="testSimGroup",
        sim_name="testSimName",
    )
    print(response)


# x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/SimGet.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

Go

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/SimGet.json
func ExampleSimsClient_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.NewSimsClient().Get(ctx, "testResourceGroupName", "testSimGroup", "testSimName", 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.Sim = armmobilenetwork.Sim{
	// 	Name: to.Ptr("testSim"),
	// 	Type: to.Ptr("Microsoft.MobileNetwork/simGroups/sims"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/simGroups/testSimGroup/sims/testSim"),
	// 	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),
	// 	},
	// 	Properties: &armmobilenetwork.SimPropertiesFormat{
	// 		DeviceType: to.Ptr("Video camera"),
	// 		IntegratedCircuitCardIdentifier: to.Ptr("8900000000000000000"),
	// 		InternationalMobileSubscriberIdentity: to.Ptr("00000"),
	// 		ProvisioningState: to.Ptr(armmobilenetwork.ProvisioningStateSucceeded),
	// 		SimPolicy: &armmobilenetwork.SimPolicyResourceID{
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy"),
	// 		},
	// 		SimState: to.Ptr(armmobilenetwork.SimStateEnabled),
	// 		SiteProvisioningState: map[string]*armmobilenetwork.SiteProvisioningState{
	// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": to.Ptr(armmobilenetwork.SiteProvisioningStateProvisioned),
	// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": to.Ptr(armmobilenetwork.SiteProvisioningStateProvisioned),
	// 		},
	// 		StaticIPConfiguration: []*armmobilenetwork.SimStaticIPProperties{
	// 			{
	// 				AttachedDataNetwork: &armmobilenetwork.AttachedDataNetworkResourceID{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork"),
	// 				},
	// 				Slice: &armmobilenetwork.SliceResourceID{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"),
	// 				},
	// 				StaticIP: &armmobilenetwork.SimStaticIPPropertiesStaticIP{
	// 					IPv4Address: to.Ptr("2.4.0.1"),
	// 				},
	// 		}},
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets information about the specified SIM.
 *
 * @summary Gets information about the specified SIM.
 * x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/SimGet.json
 */
async function getSim() {
  const subscriptionId =
    process.env["MOBILENETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MOBILENETWORK_RESOURCE_GROUP"] || "testResourceGroupName";
  const simGroupName = "testSimGroup";
  const simName = "testSimName";
  const credential = new DefaultAzureCredential();
  const client = new MobileNetworkManagementClient(credential, subscriptionId);
  const result = await client.sims.get(resourceGroupName, simGroupName, simName);
  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": "testSim",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/simGroups/testSimGroup/sims/testSim",
  "type": "Microsoft.MobileNetwork/simGroups/sims",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "simState": "Enabled",
    "siteProvisioningState": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": "Provisioned",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": "Provisioned"
    },
    "integratedCircuitCardIdentifier": "8900000000000000000",
    "internationalMobileSubscriberIdentity": "00000",
    "deviceType": "Video camera",
    "simPolicy": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy"
    },
    "staticIpConfiguration": [
      {
        "attachedDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork"
        },
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "staticIp": {
          "ipv4Address": "2.4.0.1"
        }
      }
    ]
  }
}

定義

名前	説明
AttachedDataNetworkResourceId	接続されているデータ ネットワーク リソースへの参照。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ProvisioningState	現在のプロビジョニング状態。
Sim	SIM リソース。
SimPolicyResourceId	SIM ポリシー リソースへの参照。
SimState	SIM リソースの状態。
SimStaticIpProperties	SIM の静的 IP 構成。特定の接続されたデータ ネットワークとスライスにスコープが設定されます。
SliceResourceId	スライス リソースへの参照。
StaticIp	定義されたネットワーク スコープで使用する SIM の静的 IP 構成。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AttachedDataNetworkResourceId

接続されているデータ ネットワーク リソースへの参照。

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

createdByType

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

ProvisioningState

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

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

Sim

SIM リソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.authenticationKey	string	SIM の Ki 値。
properties.deviceType	string	この SIM が関連付けられているデバイスの種類を記録するために使用できるオプションの自由形式のテキスト フィールド (例: "ビデオ カメラ")。 Azure portalを使用すると、この値に基づいて SIM をグループ化およびフィルター処理できます。
properties.integratedCircuitCardIdentifier	string	SIM の集積回路カード ID (ICCID)。
properties.internationalMobileSubscriberIdentity	string	SIM の国際モバイル サブスクライバー ID (IMSI)。
properties.operatorKeyCode	string	SIM の Opc 値。
properties.provisioningState	ProvisioningState	SIM リソースのプロビジョニング状態。
properties.simPolicy	SimPolicyResourceId	この SIM で使用される SIM ポリシー。 SIM ポリシーは、SIM と同じ場所にある必要があります。
properties.simState	SimState	SIM リソースの状態。
properties.siteProvisioningState	object	サイト上のこの SIM のプロビジョニング状態に対するサイトのディクショナリ。
properties.staticIpConfiguration	SimStaticIpProperties[]	この SIM に割り当てられている静的 IP アドレスの一覧。 各アドレスは、{attached data network, slice} で構成される定義済みのネットワーク スコープで割り当てられます。
properties.vendorKeyFingerprint	string	この SIM を提供した SIM ベンダーのパブリック キー フィンガープリント (存在する場合)。
properties.vendorName	string	この SIM を提供した SIM ベンダーの名前 (存在する場合)。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SimPolicyResourceId

SIM ポリシー リソースへの参照。

名前	型	説明
id	string	SIM ポリシー リソース ID。

SimState

SIM リソースの状態。

名前	型	説明
Disabled	string	有効にするために必要なすべての構成が存在するわけではないため、SIM は無効になっています。
Enabled	string	SIM が有効になっています。
Invalid	string	関連付けられている構成の一部が無効であるため、SIM を有効にできません。

SimStaticIpProperties

SIM の静的 IP 構成。特定の接続されたデータ ネットワークとスライスにスコープが設定されます。

名前	型	説明
attachedDataNetwork	AttachedDataNetworkResourceId	静的 IP アドレスが使用される接続データ ネットワーク。 接続されたデータ ネットワークとスライスの組み合わせによって、IP アドレスのネットワーク スコープが定義されます。 接続されたデータ ネットワークは、SIM と同じ場所にある必要があります。
slice	SliceResourceId	静的 IP アドレスが使用されるネットワーク スライス。 接続されたデータ ネットワークとスライスの組み合わせによって、IP アドレスのネットワーク スコープが定義されます。 スライスは SIM と同じ場所にある必要があります。
staticIp	StaticIp	定義されたネットワーク スコープで使用する SIM の静的 IP 構成。

SliceResourceId

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

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

StaticIp

定義されたネットワーク スコープで使用する SIM の静的 IP 構成。

名前	型	説明
ipv4Address	string	このネットワーク スコープで SIM に割り当てられた IPv4 アドレス。 このアドレスは、接続されたデータ ネットワークで定義されている userEquipmentStaticAddressPoolPrefix 内に存在する必要があります。

systemData

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

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