Virtual Networks - Check IP Address Availability

Sprawdza, czy prywatny adres IP jest dostępny do użycia.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability?ipAddress={ipAddress}&api-version=2023-09-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

virtualNetworkName
path True

string

Nazwa sieci wirtualnej.

api-version
query True

string

Wersja interfejsu API klienta.

ipAddress
query True

string

Prywatny adres IP do zweryfikowania.

Odpowiedzi

Nazwa Typ Opis
200 OK

IPAddressAvailabilityResult

Dostępność prywatnego adresu IP i lista innych bezpłatnych adresów, jeśli żądany adres jest niedostępny.

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Check IP address availability

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/CheckIPAddressAvailability?ipAddress=10.0.1.4&api-version=2023-09-01

Sample Response

{
  "available": false,
  "availableIPAddresses": [
    "10.0.1.5",
    "10.0.1.6",
    "10.0.1.7",
    "10.0.1.8",
    "10.0.1.9"
  ]
}

Definicje

Nazwa Opis
CloudError

Odpowiedź błędu z usługi.

CloudErrorBody

Odpowiedź błędu z usługi.

IPAddressAvailabilityResult

Odpowiedź na wywołanie usługi interfejsu API CheckIPAddressAvailability.

CloudError

Odpowiedź błędu z usługi.

Nazwa Typ Opis
error

CloudErrorBody

Treść błędu chmury.

CloudErrorBody

Odpowiedź błędu z usługi.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

details

CloudErrorBody[]

Lista dodatkowych szczegółów dotyczących błędu.

message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

target

string

Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

IPAddressAvailabilityResult

Odpowiedź na wywołanie usługi interfejsu API CheckIPAddressAvailability.

Nazwa Typ Opis
available

boolean

Dostępność prywatnego adresu IP.

availableIPAddresses

string[]

Zawiera inne dostępne prywatne adresy IP, jeśli zostanie podjęta prośba o adres.

isPlatformReserved

boolean

Zarezerwowana platforma prywatnych adresów IP.