Virtual Networks - Check IP Address Availability

Überprüft, ob eine private IP-Adresse zur Verwendung verfügbar ist.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe.

subscriptionId
path True

string

Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

virtualNetworkName
path True

string

Den Namen des virtuellen Netzwerks.

api-version
query True

string

Client-API-Version.

ipAddress
query True

string

Die zu überprüfende private IP-Adresse.

Antworten

Name Typ Beschreibung
200 OK

IPAddressAvailabilityResult

Verfügbarkeit privater IP-Adressen und Liste anderer kostenloser Adressen, wenn die angeforderte Adresse nicht verfügbar ist.

Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name Beschreibung
CloudError

Eine Fehlerantwort vom Dienst.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

IPAddressAvailabilityResult

Antwort für checkIPAddressAvailability-API-Dienstaufruf.

CloudError

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
error

CloudErrorBody

Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

target

string

Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

IPAddressAvailabilityResult

Antwort für checkIPAddressAvailability-API-Dienstaufruf.

Name Typ Beschreibung
available

boolean

Verfügbarkeit privater IP-Adressen.

availableIPAddresses

string[]

Enthält andere verfügbare private IP-Adressen, wenn die angeforderte Adresse verwendet wird.

isPlatformReserved

boolean

Private IP-Adressplattform reserviert.