Virtual Networks - Check IP Address Availability

Verifica se um endereço IP privado está disponível para uso.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos.

subscriptionId
path True

string

As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

virtualNetworkName
path True

string

O nome da rede virtual.

api-version
query True

string

Versão de API do cliente.

ipAddress
query True

string

O endereço IP privado a ser verificado.

Respostas

Nome Tipo Description
200 OK

IPAddressAvailabilityResult

Disponibilidade de endereço IP privado e lista de outros endereços gratuitos se o solicitado não estiver disponível.

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

Nome Description
CloudError

Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

IPAddressAvailabilityResult

Resposta para a chamada de serviço da API CheckIPAddressAvailability.

CloudError

Uma resposta de erro do serviço.

Nome Tipo Description
error

CloudErrorBody

Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.

IPAddressAvailabilityResult

Resposta para a chamada de serviço da API CheckIPAddressAvailability.

Nome Tipo Description
available

boolean

Disponibilidade de endereço IP privado.

availableIPAddresses

string[]

Contém outros endereços IP privados disponíveis se o endereço solicitado for obtido.

isPlatformReserved

boolean

Plataforma de endereço IP privado reservada.