NeighborGroups interface
Interface representing a NeighborGroups.
Methods
Method Details
beginCreate(string, string, NeighborGroup, NeighborGroupsCreateOptionalParams)
Implements the Neighbor Group PUT method.
function beginCreate(resourceGroupName: string, neighborGroupName: string, body: NeighborGroup, options?: NeighborGroupsCreateOptionalParams): Promise<SimplePollerLike<OperationState<NeighborGroup>, NeighborGroup>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- neighborGroupName
-
string
Name of the Neighbor Group.
- body
- NeighborGroup
Request payload.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<NeighborGroup>, NeighborGroup>>
beginCreateAndWait(string, string, NeighborGroup, NeighborGroupsCreateOptionalParams)
Implements the Neighbor Group PUT method.
function beginCreateAndWait(resourceGroupName: string, neighborGroupName: string, body: NeighborGroup, options?: NeighborGroupsCreateOptionalParams): Promise<NeighborGroup>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- neighborGroupName
-
string
Name of the Neighbor Group.
- body
- NeighborGroup
Request payload.
The options parameters.
Returns
Promise<NeighborGroup>
beginDelete(string, string, NeighborGroupsDeleteOptionalParams)
Implements Neighbor Group DELETE method.
function beginDelete(resourceGroupName: string, neighborGroupName: string, options?: NeighborGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- neighborGroupName
-
string
Name of the Neighbor Group.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, NeighborGroupsDeleteOptionalParams)
Implements Neighbor Group DELETE method.
function beginDeleteAndWait(resourceGroupName: string, neighborGroupName: string, options?: NeighborGroupsDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- neighborGroupName
-
string
Name of the Neighbor Group.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, NeighborGroupPatch, NeighborGroupsUpdateOptionalParams)
Updates the Neighbor Group.
function beginUpdate(resourceGroupName: string, neighborGroupName: string, body: NeighborGroupPatch, options?: NeighborGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NeighborGroup>, NeighborGroup>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- neighborGroupName
-
string
Name of the Neighbor Group.
- body
- NeighborGroupPatch
Neighbor Group properties to update. Only annotations are supported.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<NeighborGroup>, NeighborGroup>>
beginUpdateAndWait(string, string, NeighborGroupPatch, NeighborGroupsUpdateOptionalParams)
Updates the Neighbor Group.
function beginUpdateAndWait(resourceGroupName: string, neighborGroupName: string, body: NeighborGroupPatch, options?: NeighborGroupsUpdateOptionalParams): Promise<NeighborGroup>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- neighborGroupName
-
string
Name of the Neighbor Group.
- body
- NeighborGroupPatch
Neighbor Group properties to update. Only annotations are supported.
The options parameters.
Returns
Promise<NeighborGroup>
get(string, string, NeighborGroupsGetOptionalParams)
Gets the Neighbor Group.
function get(resourceGroupName: string, neighborGroupName: string, options?: NeighborGroupsGetOptionalParams): Promise<NeighborGroup>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- neighborGroupName
-
string
Name of the Neighbor Group.
- options
- NeighborGroupsGetOptionalParams
The options parameters.
Returns
Promise<NeighborGroup>
listByResourceGroup(string, NeighborGroupsListByResourceGroupOptionalParams)
Displays NeighborGroups list by resource group GET method.
function listByResourceGroup(resourceGroupName: string, options?: NeighborGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NeighborGroup, NeighborGroup[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(NeighborGroupsListBySubscriptionOptionalParams)
Displays NeighborGroups list by subscription GET method.
function listBySubscription(options?: NeighborGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NeighborGroup, NeighborGroup[], PageSettings>
Parameters
The options parameters.