Microsoft.DevOpsInfrastructure (stable:2024-10-19)

2024/12/10 • 1 new methods

Pools_CheckNameAvailability (new)
Description :  Checks that the pool name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: The CheckAvailability request ,
Required: True ,
}
{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource that is used as the scope of the availability check. ,
Enum:
{
Microsoft.DevOpsInfrastructure/pools: DevOpsInfrastructure pool resource. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
available:
{
Description: Availability status of the name. ,
Enum:
{
Available: The name is available. ,
Unavailable: The name is unavailable ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A message explaining why the name is unavailable. Will be null if the name is available. ,
Required: True ,
}
string ,
name:
{
Description: The name whose availability was checked. ,
Required: True ,
}
string ,
reason:
{
Description: The reason code explaining why the name is unavailable. Will be null if the name is available. ,
Enum:
{
Invalid: The name is invalid. ,
AlreadyExists: The name already exists. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}