Package version:

Interface VirtualNetworkRules

Interface representing a VirtualNetworkRules.

Hierarchy

VirtualNetworkRules

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByServer

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, virtualNetworkRuleName: string, parameters: VirtualNetworkRule, options?: VirtualNetworkRulesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkRule>, VirtualNetworkRule>>
Creates or updates an existing virtual network rule.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- virtualNetworkRuleName: string
  
  The name of the virtual network rule.
- parameters: VirtualNetworkRule
  
  The requested virtual Network Rule Resource state.
- Optional options: VirtualNetworkRulesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualNetworkRule>, VirtualNetworkRule>>
- Defined in operationsInterfaces/virtualNetworkRules.ts:59

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, virtualNetworkRuleName: string, parameters: VirtualNetworkRule, options?: VirtualNetworkRulesCreateOrUpdateOptionalParams): Promise<VirtualNetworkRule>
Creates or updates an existing virtual network rule.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- virtualNetworkRuleName: string
  
  The name of the virtual network rule.
- parameters: VirtualNetworkRule
  
  The requested virtual Network Rule Resource state.
- Optional options: VirtualNetworkRulesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualNetworkRule>
- Defined in operationsInterfaces/virtualNetworkRules.ts:80

beginDelete

beginDelete(resourceGroupName: string, serverName: string, virtualNetworkRuleName: string, options?: VirtualNetworkRulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes the virtual network rule with the given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- virtualNetworkRuleName: string
  
  The name of the virtual network rule.
- Optional options: VirtualNetworkRulesDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualNetworkRules.ts:95

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, virtualNetworkRuleName: string, options?: VirtualNetworkRulesDeleteOptionalParams): Promise<void>
Deletes the virtual network rule with the given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- virtualNetworkRuleName: string
  
  The name of the virtual network rule.
- Optional options: VirtualNetworkRulesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualNetworkRules.ts:109

get

get(resourceGroupName: string, serverName: string, virtualNetworkRuleName: string, options?: VirtualNetworkRulesGetOptionalParams): Promise<VirtualNetworkRule>
Gets a virtual network rule.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- virtualNetworkRuleName: string
  
  The name of the virtual network rule.
- Optional options: VirtualNetworkRulesGetOptionalParams
  
  The options parameters.
Returns Promise<VirtualNetworkRule>
- Defined in operationsInterfaces/virtualNetworkRules.ts:44

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: VirtualNetworkRulesListByServerOptionalParams): PagedAsyncIterableIterator<VirtualNetworkRule>
Gets a list of virtual network rules in a server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- Optional options: VirtualNetworkRulesListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualNetworkRule>
- Defined in operationsInterfaces/virtualNetworkRules.ts:31

Interface VirtualNetworkRules

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

virtualNetworkRuleName: string

parameters: VirtualNetworkRule

Optional options: VirtualNetworkRulesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<VirtualNetworkRule>, VirtualNetworkRule>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

virtualNetworkRuleName: string

parameters: VirtualNetworkRule

Optional options: VirtualNetworkRulesCreateOrUpdateOptionalParams

Returns Promise<VirtualNetworkRule>

beginDelete

Parameters

resourceGroupName: string

serverName: string

virtualNetworkRuleName: string

Optional options: VirtualNetworkRulesDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

virtualNetworkRuleName: string

Optional options: VirtualNetworkRulesDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

virtualNetworkRuleName: string

Optional options: VirtualNetworkRulesGetOptionalParams

Returns Promise<VirtualNetworkRule>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: VirtualNetworkRulesListByServerOptionalParams

Returns PagedAsyncIterableIterator<VirtualNetworkRule>

Settings

Member Visibility

Theme

`Optional` options: VirtualNetworkRulesCreateOrUpdateOptionalParams

`Optional` options: VirtualNetworkRulesCreateOrUpdateOptionalParams

`Optional` options: VirtualNetworkRulesDeleteOptionalParams

`Optional` options: VirtualNetworkRulesDeleteOptionalParams

`Optional` options: VirtualNetworkRulesGetOptionalParams

`Optional` options: VirtualNetworkRulesListByServerOptionalParams