VirtualNetworkGatewayConnections | @azure/arm-network-profile-2019-03-01-hybrid

Class representing a VirtualNetworkGatewayConnections.

Hierarchy

VirtualNetworkGatewayConnections

Index

Constructors

constructor

Methods

Constructors

constructor

new VirtualNetworkGatewayConnections(client: NetworkManagementClientContext): VirtualNetworkGatewayConnections

- Defined in operations/virtualNetworkGatewayConnections.ts:20
Create a VirtualNetworkGatewayConnections.

Parameters
- client: NetworkManagementClientContext
  
  Reference to the service client.
Returns VirtualNetworkGatewayConnections

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VirtualNetworkGatewayConnection, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGatewayConnections.ts:208
Creates or updates a virtual network gateway connection in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- parameters: VirtualNetworkGatewayConnection
  
  Parameters supplied to the create or update virtual network gateway connection operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGatewayConnections.ts:227
Deletes the specified virtual network Gateway connection.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginResetSharedKey

beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionResetSharedKey, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGatewayConnections.ts:293
The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The virtual network gateway connection reset shared key Name.
- parameters: ConnectionResetSharedKey
  
  Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginSetSharedKey

beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionSharedKey, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGatewayConnections.ts:269
The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The virtual network gateway connection name.
- parameters: ConnectionSharedKey
  
  Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdateTags

beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: TagsObject, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGatewayConnections.ts:246
Updates a virtual network gateway connection tags.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- parameters: TagsObject
  
  Parameters supplied to update virtual network gateway connection tags.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate

createOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VirtualNetworkGatewayConnection, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsCreateOrUpdateResponse>

- Defined in operations/virtualNetworkGatewayConnections.ts:39
Creates or updates a virtual network gateway connection in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- parameters: VirtualNetworkGatewayConnection
  
  Parameters supplied to the create or update virtual network gateway connection operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsCreateOrUpdateResponse>

Promise<Models.VirtualNetworkGatewayConnectionsCreateOrUpdateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/virtualNetworkGatewayConnections.ts:83
Deletes the specified virtual network Gateway connection.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

get

get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsGetResponse>
get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: msRest.ServiceCallback<VirtualNetworkGatewayConnection>): void
get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGatewayConnection>): void

- Defined in operations/virtualNetworkGatewayConnections.ts:51
Gets the specified virtual network gateway connection by resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsGetResponse>

Promise<Models.VirtualNetworkGatewayConnectionsGetResponse>
- Defined in operations/virtualNetworkGatewayConnections.ts:57
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- callback: msRest.ServiceCallback<VirtualNetworkGatewayConnection>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGatewayConnections.ts:64
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGatewayConnection>
  
  The callback
Returns void

getSharedKey

getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsGetSharedKeyResponse>
getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: msRest.ServiceCallback<ConnectionSharedKey>): void
getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionSharedKey>): void

- Defined in operations/virtualNetworkGatewayConnections.ts:126
The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The virtual network gateway connection shared key name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsGetSharedKeyResponse>

Promise<Models.VirtualNetworkGatewayConnectionsGetSharedKeyResponse>
- Defined in operations/virtualNetworkGatewayConnections.ts:133
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The virtual network gateway connection shared key name.
- callback: msRest.ServiceCallback<ConnectionSharedKey>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGatewayConnections.ts:141
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The virtual network gateway connection shared key name.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ConnectionSharedKey>
  
  The callback
Returns void

list

list(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsListResponse>
list(resourceGroupName: string, callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>): void
list(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>): void

- Defined in operations/virtualNetworkGatewayConnections.ts:160
The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsListResponse>

Promise<Models.VirtualNetworkGatewayConnectionsListResponse>
- Defined in operations/virtualNetworkGatewayConnections.ts:165
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGatewayConnections.ts:171
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>): void

- Defined in operations/virtualNetworkGatewayConnections.ts:312
The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsListNextResponse>

Promise<Models.VirtualNetworkGatewayConnectionsListNextResponse>
- Defined in operations/virtualNetworkGatewayConnections.ts:317
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGatewayConnections.ts:323
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGatewayConnectionListResult>
  
  The callback
Returns void

resetSharedKey

resetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionResetSharedKey, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsResetSharedKeyResponse>

- Defined in operations/virtualNetworkGatewayConnections.ts:194
The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The virtual network gateway connection reset shared key Name.
- parameters: ConnectionResetSharedKey
  
  Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsResetSharedKeyResponse>

Promise<Models.VirtualNetworkGatewayConnectionsResetSharedKeyResponse>

setSharedKey

setSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: ConnectionSharedKey, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsSetSharedKeyResponse>

- Defined in operations/virtualNetworkGatewayConnections.ts:112
The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The virtual network gateway connection name.
- parameters: ConnectionSharedKey
  
  Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsSetSharedKeyResponse>

Promise<Models.VirtualNetworkGatewayConnectionsSetSharedKeyResponse>

updateTags

updateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: TagsObject, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewayConnectionsUpdateTagsResponse>

- Defined in operations/virtualNetworkGatewayConnections.ts:96
Updates a virtual network gateway connection tags.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection.
- parameters: TagsObject
  
  Parameters supplied to update virtual network gateway connection tags.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewayConnectionsUpdateTagsResponse>

Promise<Models.VirtualNetworkGatewayConnectionsUpdateTagsResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: NetworkManagementClientContext

Returns VirtualNetworkGatewayConnections

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

parameters: VirtualNetworkGatewayConnection

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginResetSharedKey

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

parameters: ConnectionResetSharedKey

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginSetSharedKey

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

parameters: ConnectionSharedKey

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginUpdateTags

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

parameters: TagsObject

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

createOrUpdate

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

parameters: VirtualNetworkGatewayConnection

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualNetworkGatewayConnectionsCreateOrUpdateResponse>

deleteMethod

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

get

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualNetworkGatewayConnectionsGetResponse>

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

callback: msRest.ServiceCallback<VirtualNetworkGatewayConnection>

Returns void

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<VirtualNetworkGatewayConnection>

Returns void

getSharedKey

Parameters

resourceGroupName: string

virtualNetworkGatewayConnectionName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualNetworkGatewayConnectionsGetSharedKeyResponse>