IpamPools interface
Interface representing a IpamPools.
Methods
| begin |
Creates/Updates the Pool resource. |
| begin |
Creates/Updates the Pool resource. |
| begin |
Delete the Pool resource. |
| begin |
Delete the Pool resource. |
| get(string, string, string, Ipam |
Gets the specific Pool resource. |
| get |
Get the Pool Usage. |
| list(string, string, Ipam |
Gets list of Pool resources at Network Manager level. |
| list |
List Associated Resource in the Pool. |
| update(string, string, string, Ipam |
Updates the specific Pool resource. |
Method Details
beginCreate(string, string, string, IpamPool, IpamPoolsCreateOptionalParams)
Creates/Updates the Pool resource.
function beginCreate(resourceGroupName: string, networkManagerName: string, poolName: string, body: IpamPool, options?: IpamPoolsCreateOptionalParams): Promise<SimplePollerLike<OperationState<IpamPool>, IpamPool>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
IP Address Manager Pool resource name.
- body
- IpamPool
Pool resource object to create/update.
- options
- IpamPoolsCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<IpamPool>, IpamPool>>
beginCreateAndWait(string, string, string, IpamPool, IpamPoolsCreateOptionalParams)
Creates/Updates the Pool resource.
function beginCreateAndWait(resourceGroupName: string, networkManagerName: string, poolName: string, body: IpamPool, options?: IpamPoolsCreateOptionalParams): Promise<IpamPool>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
IP Address Manager Pool resource name.
- body
- IpamPool
Pool resource object to create/update.
- options
- IpamPoolsCreateOptionalParams
The options parameters.
Returns
Promise<IpamPool>
beginDelete(string, string, string, IpamPoolsDeleteOptionalParams)
Delete the Pool resource.
function beginDelete(resourceGroupName: string, networkManagerName: string, poolName: string, options?: IpamPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IpamPoolsDeleteHeaders>, IpamPoolsDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
Pool resource name.
- options
- IpamPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<IpamPoolsDeleteHeaders>, IpamPoolsDeleteHeaders>>
beginDeleteAndWait(string, string, string, IpamPoolsDeleteOptionalParams)
Delete the Pool resource.
function beginDeleteAndWait(resourceGroupName: string, networkManagerName: string, poolName: string, options?: IpamPoolsDeleteOptionalParams): Promise<IpamPoolsDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
Pool resource name.
- options
- IpamPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<IpamPoolsDeleteHeaders>
get(string, string, string, IpamPoolsGetOptionalParams)
Gets the specific Pool resource.
function get(resourceGroupName: string, networkManagerName: string, poolName: string, options?: IpamPoolsGetOptionalParams): Promise<IpamPool>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
Pool resource name.
- options
- IpamPoolsGetOptionalParams
The options parameters.
Returns
Promise<IpamPool>
getPoolUsage(string, string, string, IpamPoolsGetPoolUsageOptionalParams)
Get the Pool Usage.
function getPoolUsage(resourceGroupName: string, networkManagerName: string, poolName: string, options?: IpamPoolsGetPoolUsageOptionalParams): Promise<PoolUsage>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
Pool resource name.
The options parameters.
Returns
Promise<PoolUsage>
list(string, string, IpamPoolsListOptionalParams)
Gets list of Pool resources at Network Manager level.
function list(resourceGroupName: string, networkManagerName: string, options?: IpamPoolsListOptionalParams): PagedAsyncIterableIterator<IpamPool, IpamPool[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- options
- IpamPoolsListOptionalParams
The options parameters.
Returns
listAssociatedResources(string, string, string, IpamPoolsListAssociatedResourcesOptionalParams)
List Associated Resource in the Pool.
function listAssociatedResources(resourceGroupName: string, networkManagerName: string, poolName: string, options?: IpamPoolsListAssociatedResourcesOptionalParams): PagedAsyncIterableIterator<PoolAssociation, PoolAssociation[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
Pool resource name.
The options parameters.
Returns
update(string, string, string, IpamPoolsUpdateOptionalParams)
Updates the specific Pool resource.
function update(resourceGroupName: string, networkManagerName: string, poolName: string, options?: IpamPoolsUpdateOptionalParams): Promise<IpamPool>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkManagerName
-
string
The name of the network manager.
- poolName
-
string
IP Address Manager Pool resource name.
- options
- IpamPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<IpamPool>