operations

Creates, updates, deletes, gets or lists an operations resource.

Overview

Name	operations
Type	Resource
Id	azure.network.operations

Fields

The following fields are returned by SELECT queries:

list

OK. The request has succeeded.

Name	Datatype	Description
name	string	The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
actionType	string	Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
display	object	Localized display information for this particular operation.
isDataAction	boolean	Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
origin	string	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select			Lists all of the available Network Rest API operations.
express_route_provider_port	exec	providerport, subscriptionId		Retrieves detail of a provider port.
check_dns_name_availability	exec	location, domainNameLabel, subscriptionId		Checks whether a domain name in the cloudapp.azure.com zone is available for use.
supported_security_providers	exec	subscriptionId, resourceGroupName, virtualWANName		Gives the supported security providers for the virtual wan.
generatevirtualwanvpnserverconfigurationvpnprofile	exec	subscriptionId, resourceGroupName, virtualWANName		Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.
disconnect_active_sessions	exec	resourceGroupName, bastionHostName, subscriptionId		Returns the list of currently active sessions on the Bastion.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bastionHostName	string	The name of the Bastion Host.
domainNameLabel	string	The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.
location	string	The location of the domain name.
providerport	string	The name of the provider port.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualWANName	string	The name of the VirtualWAN whose associated VpnServerConfigurations is needed.

SELECT examples

list

Lists all of the available Network Rest API operations.

SELECT
name,
actionType,
display,
isDataAction,
origin
FROM azure.network.operations
;

Lifecycle Methods

express_route_provider_port

Retrieves detail of a provider port.

EXEC azure.network.operations.express_route_provider_port 
@providerport='{{ providerport }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

check_dns_name_availability

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

EXEC azure.network.operations.check_dns_name_availability 
@location='{{ location }}' --required, 
@domainNameLabel='{{ domainNameLabel }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

supported_security_providers

Gives the supported security providers for the virtual wan.

EXEC azure.network.operations.supported_security_providers 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualWANName='{{ virtualWANName }}' --required
;

generatevirtualwanvpnserverconfigurationvpnprofile

Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.

EXEC azure.network.operations.generatevirtualwanvpnserverconfigurationvpnprofile 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualWANName='{{ virtualWANName }}' --required 
@@json=
'{
"vpnServerConfigurationResourceId": "{{ vpnServerConfigurationResourceId }}", 
"authenticationMethod": "{{ authenticationMethod }}"
}'
;

disconnect_active_sessions

Returns the list of currently active sessions on the Bastion.

EXEC azure.network.operations.disconnect_active_sessions 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bastionHostName='{{ bastionHostName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sessionIds": "{{ sessionIds }}"
}'
;