Network Interfaces - Get

Szolgáltatás:

Azure Stack HCI

API-verzió:

2024-01-01

Hálózati adapter lekérdezve

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
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]$	A hálózati adapter neve
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	NetworkInterfaces	OKÉ
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

GetNetworkInterface

Mintakérelem

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

Mintaválasz

Állapotkód:

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"
          }
        }
      }
    ]
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ExtendedLocation	A kiterjesztett hely összetett típusa.
ExtendedLocationTypes	A kiterjesztett hely típusa.
InterfaceDNSSettings
IPConfiguration	InterfaceIPConfiguration iPConfiguration egy hálózati adapteren.
NetworkInterfaces	A hálózati adapter erőforrásdefiníciója.
Properties	Az IP-konfiguráció InterfaceIPConfigurationPropertiesFormat tulajdonságai.
ProvisioningStateEnum	A hálózati adapter kiépítési állapota.
ProvisioningStatus
Status	A hálózati adapteren végrehajtott művelet állapota [Sikeres, Sikertelen, Bejövő forgalom]
Subnet	Alhálózat – Az IP-konfigurációhoz kötött alhálózat neve.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ExtendedLocation

Objektum

A kiterjesztett hely összetett típusa.

Name	Típus	Description
name	string	A kiterjesztett hely neve.
type	ExtendedLocationTypes	A kiterjesztett hely típusa.

ExtendedLocationTypes

Enumerálás

A kiterjesztett hely típusa.

Érték	Description
CustomLocation

InterfaceDNSSettings

Objektum

Name	Típus	Description
dnsServers	string[]	A dns-kiszolgáló IP-címeinek listája az interfészhez

IPConfiguration

Objektum

InterfaceIPConfiguration iPConfiguration egy hálózati adapteren.

Name	Típus	Description
name	string pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$	Név – Az erőforráscsoporton belül egyedi erőforrás neve. Ez a név használható az erőforrás eléréséhez.
properties	Properties	Az IP-konfiguráció InterfaceIPConfigurationPropertiesFormat tulajdonságai.

NetworkInterfaces

Objektum

A hálózati adapter erőforrásdefiníciója.

Name	Típus	Description
extendedLocation	ExtendedLocation	Az erőforrás kiterjesztett áthelyezése.
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.dnsSettings	InterfaceDNSSettings	A felület DNS-beállításai
properties.ipConfigurations	IPConfiguration[]	IPConfigurations – A hálózati adapter IPConfigurations listája.
properties.macAddress	string	MacAddress – A hálózati adapter MAC-címe.
properties.provisioningState	ProvisioningStateEnum	A hálózati adapter kiépítési állapota.
properties.status.errorCode	string	NetworkInterface kiépítési hibakód
properties.status.errorMessage	string	Leíró hibaüzenet
properties.status.provisioningStatus	ProvisioningStatus
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

Properties

Objektum

Az IP-konfiguráció InterfaceIPConfigurationPropertiesFormat tulajdonságai.

Name	Típus	Description
gateway	string	Átjáró a hálózati adapterhez
prefixLength	string	előtagLength a hálózati adapterhez
privateIPAddress	string	PrivateIPAddress – Az IP-konfiguráció privát IP-címe.
subnet	Subnet	Alhálózat – Az IP-konfigurációhoz kötött alhálózat neve.

ProvisioningStateEnum

Enumerálás

A hálózati adapter kiépítési állapota.

Érték	Description
Accepted
Canceled
Deleting
Failed
InProgress
Succeeded

ProvisioningStatus

Objektum

Name	Típus	Description
operationId	string	A hálózati adapteren végrehajtott művelet azonosítója
status	Status	A hálózati adapteren végrehajtott művelet állapota [Sikeres, Sikertelen, Bejövő forgalom]

Status

Enumerálás

A hálózati adapteren végrehajtott művelet állapota [Sikeres, Sikertelen, Bejövő forgalom]

Érték	Description
Failed
InProgress
Succeeded

Subnet

Objektum

Alhálózat – Az IP-konfigurációhoz kötött alhálózat neve.

Name	Típus	Description
id	string	AZONOSÍTÓ – Az ARM-erőforrás azonosítója /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.