Network Interfaces - Get

サービス:

Azure Stack HCI

API バージョン:

2024-01-01

ネットワーク インターフェイスを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}?api-version=2024-01-01

URI パラメーター

名前	/	必須	型	説明
networkInterfaceName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$	ネットワーク インターフェイスの名前
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	NetworkInterfaces	わかりました
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

GetNetworkInterface

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic?api-version=2024-01-01

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic",
  "name": "test-nic",
  "type": "Microsoft.AzureStackHCI/networkInterfaces",
  "location": "West US2",
  "extendedLocation": {
    "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
    "type": "CustomLocation"
  },
  "properties": {
    "provisioningState": "Accepted",
    "ipConfigurations": [
      {
        "name": "ipconfig-sample",
        "properties": {
          "subnet": {
            "id": "external"
          }
        }
      }
    ]
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ExtendedLocation	拡張された場所の複合型。
ExtendedLocationTypes	拡張された場所の型。
InterfaceDNSSettings
IPConfiguration	ネットワーク インターフェイスの InterfaceIPConfiguration iPConfiguration。
NetworkInterfaces	ネットワーク インターフェイス リソース定義。
Properties	IP 構成の InterfaceIPConfigurationPropertiesFormat プロパティ。
ProvisioningStateEnum	ネットワーク インターフェイスのプロビジョニング状態。
ProvisioningStatus
Status	ネットワーク インターフェイスで実行された操作の状態 [成功、失敗、InProgress]
Subnet	サブネット - IP 構成にバインドされているサブネットの名前。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ExtendedLocation

Object

拡張された場所の複合型。

名前	型	説明
name	string	拡張された場所の名前。
type	ExtendedLocationTypes	拡張された場所の型。

ExtendedLocationTypes

列挙

拡張された場所の型。

値	説明
CustomLocation

InterfaceDNSSettings

Object

名前	型	説明
dnsServers	string[]	インターフェイスの DNS サーバー IP アドレスの一覧

IPConfiguration

Object

ネットワーク インターフェイスの InterfaceIPConfiguration iPConfiguration。

名前	型	説明
name	string pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$	名前 - リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。
properties	Properties	IP 構成の InterfaceIPConfigurationPropertiesFormat プロパティ。

NetworkInterfaces

Object

ネットワーク インターフェイス リソース定義。

名前	型	説明
extendedLocation	ExtendedLocation	リソースの extendedLocation。
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.dnsSettings	InterfaceDNSSettings	インターフェイスの DNS 設定
properties.ipConfigurations	IPConfiguration[]	IPConfigurations - ネットワーク インターフェイスの IPConfiguration の一覧。
properties.macAddress	string	MacAddress - ネットワーク インターフェイスの MAC アドレス。
properties.provisioningState	ProvisioningStateEnum	ネットワーク インターフェイスのプロビジョニング状態。
properties.status.errorCode	string	NetworkInterface プロビジョニングのエラー コード
properties.status.errorMessage	string	説明エラー メッセージ
properties.status.provisioningStatus	ProvisioningStatus
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

Properties

Object

IP 構成の InterfaceIPConfigurationPropertiesFormat プロパティ。

名前	型	説明
gateway	string	ネットワーク インターフェイスのゲートウェイ
prefixLength	string	ネットワーク インターフェイスの prefixLength
privateIPAddress	string	PrivateIPAddress - IP 構成のプライベート IP アドレス。
subnet	Subnet	サブネット - IP 構成にバインドされているサブネットの名前。

ProvisioningStateEnum

列挙

ネットワーク インターフェイスのプロビジョニング状態。

値	説明
Succeeded
Failed
InProgress
Accepted
Deleting
Canceled

ProvisioningStatus

Object

名前	型	説明
operationId	string	ネットワーク インターフェイスで実行される操作の ID
status	Status	ネットワーク インターフェイスで実行された操作の状態 [成功、失敗、InProgress]

Status

列挙

ネットワーク インターフェイスで実行された操作の状態 [成功、失敗、InProgress]

値	説明
Succeeded
Failed
InProgress

Subnet

Object

サブネット - IP 構成にバインドされているサブネットの名前。

名前	型	説明
id	string	ID - /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。

systemData

Object

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

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