Microsoft.Network (preview:2024-01-01)

2025/01/16 • 4 updated methods

IpamPools_List (updated)
Description :  Gets list of Pool resources at Network Manager level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IpamPools_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "properties",
              "Required": {
                "new": true,
                "old": false
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/ipamPools
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
networkManagerName:
{
Description: The name of the network manager. ,
Required: True ,
}
string ,
skipToken:
{
Description: Optional skip token. ,
Required: False ,
}
string ,
skip:
{
Description: Optional num entries to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Optional num entries to show. ,
Format: int32 ,
Required: False ,
}
integer ,
sortKey:
{
Description: Optional key by which to sort. ,
Required: False ,
}
string ,
sortValue:
{
Description: Optional sort value for pagination. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of IpamPool resource properties which are specific to the Pool resource. ,
Required: True ,
}
{
description:
{
Required: False ,
}
string ,
displayName:
{
Description: String representing a friendly name for the resource. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: List of IP address type for the IpamPool. ,
Required: False ,
}
[
string ,
]
,
parentPoolName:
{
Description: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of IP address prefixes of the resource. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning states of a resource. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
IpamPools_Create (updated)
Description :  Creates/Updates the Pool resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IpamPools_Create",
  "$parameters": [
    {
      "#name": "body",
      "Required": {
        "new": true,
        "old": false
      },
      "$schema": {
        "$properties": [
          {
            "#name": "properties",
            "Required": {
              "new": true,
              "old": false
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "properties",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/ipamPools/{poolName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
networkManagerName:
{
Description: The name of the network manager. ,
Required: True ,
}
string ,
poolName:
{
Description: IP Address Manager Pool resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
body:
{
Description: Pool resource object to create/update. ,
Required: True ,
}
{
properties:
{
Description: Properties of IpamPool resource properties which are specific to the Pool resource. ,
Required: True ,
}
{
description:
{
Required: False ,
}
string ,
displayName:
{
Description: String representing a friendly name for the resource. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: List of IP address type for the IpamPool. ,
Required: False ,
}
[
string ,
]
,
parentPoolName:
{
Description: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of IP address prefixes of the resource. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning states of a resource. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of IpamPool resource properties which are specific to the Pool resource. ,
Required: True ,
}
{
description:
{
Required: False ,
}
string ,
displayName:
{
Description: String representing a friendly name for the resource. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: List of IP address type for the IpamPool. ,
Required: False ,
}
[
string ,
]
,
parentPoolName:
{
Description: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of IP address prefixes of the resource. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning states of a resource. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of IpamPool resource properties which are specific to the Pool resource. ,
Required: True ,
}
{
description:
{
Required: False ,
}
string ,
displayName:
{
Description: String representing a friendly name for the resource. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: List of IP address type for the IpamPool. ,
Required: False ,
}
[
string ,
]
,
parentPoolName:
{
Description: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of IP address prefixes of the resource. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning states of a resource. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
IpamPools_Update (updated)
Description :  Updates the specific Pool resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IpamPools_Update",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/ipamPools/{poolName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
networkManagerName:
{
Description: The name of the network manager. ,
Required: True ,
}
string ,
poolName:
{
Description: IP Address Manager Pool resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
body:
{
Description: Pool resource object to update partially. ,
Required: False ,
}
{
tags:
{
Required: False ,
}
object ,
properties:
{
Description: Represents the IpamPool update properties. ,
Required: False ,
}
{
description:
{
Required: False ,
}
string ,
displayName:
{
Description: String representing a friendly name for the resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of IpamPool resource properties which are specific to the Pool resource. ,
Required: True ,
}
{
description:
{
Required: False ,
}
string ,
displayName:
{
Description: String representing a friendly name for the resource. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: List of IP address type for the IpamPool. ,
Required: False ,
}
[
string ,
]
,
parentPoolName:
{
Description: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of IP address prefixes of the resource. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning states of a resource. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
IpamPools_Get (updated)
Description :  Gets the specific Pool resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IpamPools_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/ipamPools/{poolName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
networkManagerName:
{
Description: The name of the network manager. ,
Required: True ,
}
string ,
poolName:
{
Description: Pool resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of IpamPool resource properties which are specific to the Pool resource. ,
Required: True ,
}
{
description:
{
Required: False ,
}
string ,
displayName:
{
Description: String representing a friendly name for the resource. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: List of IP address type for the IpamPool. ,
Required: False ,
}
[
string ,
]
,
parentPoolName:
{
Description: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of IP address prefixes of the resource. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning states of a resource. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}