azure.mgmt.network.v2017_03_01.operations module

class azure.mgmt.network.v2017_03_01.operations.ApplicationGatewaysOperations(client, config, serializer, deserializer)[source]

Bases: object

ApplicationGatewaysOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

backend_health(resource_group_name, application_gateway_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the backend health of the specified application gateway in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • application_gateway_name (str) – The name of the application gateway.
  • expand (str) – Expands BackendAddressPool and BackendHttpSettings referenced in backend health.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ApplicationGatewayBackendHealth

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, application_gateway_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates the specified application gateway.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • application_gateway_name (str) – The name of the application gateway.
  • parameters (ApplicationGateway) – Parameters supplied to the create or update application gateway operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ApplicationGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, application_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified application gateway.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • application_gateway_name (str) – The name of the application gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, application_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified application gateway.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • application_gateway_name (str) – The name of the application gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ApplicationGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all application gateways in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ApplicationGatewayPaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all the application gateways in a subscription.

Parameters:
Return type:

ApplicationGatewayPaged

Raises:

CloudError

list_available_waf_rule_sets(custom_headers=None, raw=False, **operation_config)[source]

Lists all available web application firewall rule sets.

Parameters:
Return type:

ApplicationGatewayAvailableWafRuleSetsResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

start(resource_group_name, application_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Starts the specified application gateway.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • application_gateway_name (str) – The name of the application gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

stop(resource_group_name, application_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Stops the specified application gateway in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • application_gateway_name (str) – The name of the application gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.ExpressRouteCircuitAuthorizationsOperations(client, config, serializer, deserializer)[source]

Bases: object

ExpressRouteCircuitAuthorizationsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, circuit_name, authorization_name, authorization_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates an authorization in the specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • authorization_name (str) – The name of the authorization.
  • authorization_parameters (ExpressRouteCircuitAuthorization) – Parameters supplied to the create or update express route circuit authorization operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ExpressRouteCircuitAuthorization

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, circuit_name, authorization_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified authorization from the specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • authorization_name (str) – The name of the authorization.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, circuit_name, authorization_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified authorization from the specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • authorization_name (str) – The name of the authorization.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuitAuthorization

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all authorizations in an express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the circuit.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuitAuthorizationPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.ExpressRouteCircuitPeeringsOperations(client, config, serializer, deserializer)[source]

Bases: object

ExpressRouteCircuitPeeringsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, circuit_name, peering_name, peering_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a peering in the specified express route circuits.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • peering_name (str) – The name of the peering.
  • peering_parameters (ExpressRouteCircuitPeering) – Parameters supplied to the create or update express route circuit peering operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ExpressRouteCircuitPeering

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified peering from the specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • peering_name (str) – The name of the peering.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified authorization from the specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • peering_name (str) – The name of the peering.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuitPeering

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all peerings in a specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuitPeeringPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.ExpressRouteCircuitsOperations(client, config, serializer, deserializer)[source]

Bases: object

ExpressRouteCircuitsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, circuit_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates an express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the circuit.
  • parameters (ExpressRouteCircuit) – Parameters supplied to the create or update express route circuit operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ExpressRouteCircuit

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified express route circuit.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of express route circuit.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuit

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_peering_stats(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all stats from an express route circuit in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • peering_name (str) – The name of the peering.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuitStats

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_stats(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all the stats from an express route circuit in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuitStats

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all the express route circuits in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ExpressRouteCircuitPaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all the express route circuits in a subscription.

Parameters:
Return type:

ExpressRouteCircuitPaged

Raises:

CloudError

list_arp_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, **operation_config)[source]

Gets the currently advertised ARP table associated with the express route circuit in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • peering_name (str) – The name of the peering.
  • device_path (str) – The path of the device.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ExpressRouteCircuitsArpTableListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_routes_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, **operation_config)[source]

Gets the currently advertised routes table associated with the express route circuit in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • peering_name (str) – The name of the peering.
  • device_path (str) – The path of the device.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ExpressRouteCircuitsRoutesTableListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_routes_table_summary(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, **operation_config)[source]

Gets the currently advertised routes table summary associated with the express route circuit in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • circuit_name (str) – The name of the express route circuit.
  • peering_name (str) – The name of the peering.
  • device_path (str) – The path of the device.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ExpressRouteCircuitsRoutesTableSummaryListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.ExpressRouteServiceProvidersOperations(client, config, serializer, deserializer)[source]

Bases: object

ExpressRouteServiceProvidersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Gets all the available express route service providers.

Parameters:
Return type:

ExpressRouteServiceProviderPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.LoadBalancersOperations(client, config, serializer, deserializer)[source]

Bases: object

LoadBalancersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, load_balancer_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a load balancer.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • load_balancer_name (str) – The name of the load balancer.
  • parameters (LoadBalancer) – Parameters supplied to the create or update load balancer operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns LoadBalancer

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified load balancer.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • load_balancer_name (str) – The name of the load balancer.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, load_balancer_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified load balancer.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • load_balancer_name (str) – The name of the load balancer.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

LoadBalancer

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all the load balancers in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

LoadBalancerPaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all the load balancers in a subscription.

Parameters:
Return type:

LoadBalancerPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.NetworkInterfacesOperations(client, config, serializer, deserializer)[source]

Bases: object

NetworkInterfacesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, network_interface_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a network interface.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_interface_name (str) – The name of the network interface.
  • parameters (NetworkInterface) – Parameters supplied to the create or update network interface operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns NetworkInterface

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified network interface.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_interface_name (str) – The name of the network interface.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, network_interface_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the specified network interface.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_interface_name (str) – The name of the network interface.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkInterface

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_effective_route_table(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all route tables applied to a network interface.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_interface_name (str) – The name of the network interface.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns EffectiveRouteListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_virtual_machine_scale_set_network_interface(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get the specified network interface in a virtual machine scale set.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
  • virtualmachine_index (str) – The virtual machine index.
  • network_interface_name (str) – The name of the network interface.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkInterface

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all network interfaces in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkInterfacePaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all network interfaces in a subscription.

Parameters:
Return type:

NetworkInterfacePaged

Raises:

CloudError

list_effective_network_security_groups(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all network security groups applied to a network interface.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_interface_name (str) – The name of the network interface.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns EffectiveNetworkSecurityGroupListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_virtual_machine_scale_set_network_interfaces(resource_group_name, virtual_machine_scale_set_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all network interfaces in a virtual machine scale set.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkInterfacePaged

Raises:

CloudError

list_virtual_machine_scale_set_vm_network_interfaces(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, custom_headers=None, raw=False, **operation_config)[source]

Gets information about all network interfaces in a virtual machine in a virtual machine scale set.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
  • virtualmachine_index (str) – The virtual machine index.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkInterfacePaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.NetworkSecurityGroupsOperations(client, config, serializer, deserializer)[source]

Bases: object

NetworkSecurityGroupsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, network_security_group_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a network security group in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_security_group_name (str) – The name of the network security group.
  • parameters (NetworkSecurityGroup) – Parameters supplied to the create or update network security group operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns NetworkSecurityGroup

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, network_security_group_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified network security group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_security_group_name (str) – The name of the network security group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, network_security_group_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified network security group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_security_group_name (str) – The name of the network security group.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkSecurityGroup

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all network security groups in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkSecurityGroupPaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all network security groups in a subscription.

Parameters:
Return type:

NetworkSecurityGroupPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.SecurityRulesOperations(client, config, serializer, deserializer)[source]

Bases: object

SecurityRulesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, network_security_group_name, security_rule_name, security_rule_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a security rule in the specified network security group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_security_group_name (str) – The name of the network security group.
  • security_rule_name (str) – The name of the security rule.
  • security_rule_parameters (SecurityRule) – Parameters supplied to the create or update network security rule operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns SecurityRule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, network_security_group_name, security_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified network security rule.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_security_group_name (str) – The name of the network security group.
  • security_rule_name (str) – The name of the security rule.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, network_security_group_name, security_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Get the specified network security rule.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_security_group_name (str) – The name of the network security group.
  • security_rule_name (str) – The name of the security rule.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SecurityRule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, network_security_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all security rules in a network security group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_security_group_name (str) – The name of the network security group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SecurityRulePaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.NetworkWatchersOperations(client, config, serializer, deserializer)[source]

Bases: object

NetworkWatchersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

check_connectivity(resource_group_name, network_watcher_name, source, destination, custom_headers=None, raw=False, **operation_config)[source]

Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.

Parameters:
  • resource_group_name (str) – The name of the network watcher resource group.
  • network_watcher_name (str) – The name of the network watcher resource.
  • source (ConnectivitySource) –
  • destination (ConnectivityDestination) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ConnectivityInformation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a network watcher in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • parameters (NetworkWatcher) – Parameters that define the network watcher resource.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkWatcher

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, network_watcher_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified network watcher resource.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, network_watcher_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified network watcher by resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkWatcher

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_flow_log_status(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, **operation_config)[source]

Queries status of flow log on a specified resource.

Parameters:
  • resource_group_name (str) – The name of the network watcher resource group.
  • network_watcher_name (str) – The name of the network watcher resource.
  • target_resource_id (str) – The target resource where getting the flow logging status.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns FlowLogInformation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_next_hop(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Gets the next hop from the specified VM.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • parameters (NextHopParameters) – Parameters that define the source and destination endpoint.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns NextHopResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_topology(resource_group_name, network_watcher_name, target_resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the current network topology by resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • target_resource_group_name (str) – The name of the target resource group to perform topology on.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Topology

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_troubleshooting(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Initiate troubleshooting on a specified resource.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher resource.
  • parameters (TroubleshootingParameters) – Parameters that define the resource to troubleshoot.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns TroubleshootingResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_troubleshooting_result(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, **operation_config)[source]

Get the last completed troubleshooting result on a specified resource.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher resource.
  • target_resource_id (str) – The target resource ID to query the troubleshooting result.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns TroubleshootingResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_vm_security_rules(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, **operation_config)[source]

Gets the configured and effective security group rules on the specified VM.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • target_resource_id (str) – ID of the target VM.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns SecurityGroupViewResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all network watchers by resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NetworkWatcherPaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all network watchers by subscription.

Parameters:
Return type:

NetworkWatcherPaged

Raises:

CloudError

set_flow_log_configuration(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Configures flow log on a specified resource.

Parameters:
  • resource_group_name (str) – The name of the network watcher resource group.
  • network_watcher_name (str) – The name of the network watcher resource.
  • parameters (FlowLogInformation) – Parameters that define the configuration of flow log.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns FlowLogInformation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

verify_ip_flow(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Verify IP flow from the specified VM to a location given the currently configured NSG rules.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • parameters (VerificationIPFlowParameters) – Parameters that define the IP flow to be verified.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns VerificationIPFlowResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.PacketCapturesOperations(client, config, serializer, deserializer)[source]

Bases: object

PacketCapturesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create and start a packet capture on the specified VM.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • packet_capture_name (str) – The name of the packet capture session.
  • parameters (PacketCapture) – Parameters that define the create packet capture operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns PacketCaptureResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified packet capture session.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • packet_capture_name (str) – The name of the packet capture session.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a packet capture session by name.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • packet_capture_name (str) – The name of the packet capture session.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

PacketCaptureResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_status(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, **operation_config)[source]

Query the status of a running packet capture session.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the Network Watcher resource.
  • packet_capture_name (str) – The name given to the packet capture session.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns PacketCaptureQueryStatusResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, network_watcher_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all packet capture sessions within the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the Network Watcher resource.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

PacketCaptureResultPaged

Raises:

CloudError

stop(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, **operation_config)[source]

Stops a specified packet capture session.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • network_watcher_name (str) – The name of the network watcher.
  • packet_capture_name (str) – The name of the packet capture session.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.PublicIPAddressesOperations(client, config, serializer, deserializer)[source]

Bases: object

PublicIPAddressesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, public_ip_address_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a static or dynamic public IP address.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • public_ip_address_name (str) – The name of the public IP address.
  • parameters (PublicIPAddress) – Parameters supplied to the create or update public IP address operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns PublicIPAddress

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, public_ip_address_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified public IP address.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • public_ip_address_name (str) – The name of the subnet.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, public_ip_address_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified public IP address in a specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • public_ip_address_name (str) – The name of the subnet.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

PublicIPAddress

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_virtual_machine_scale_set_public_ip_address(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, ip_configuration_name, public_ip_address_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get the specified public IP address in a virtual machine scale set.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
  • virtualmachine_index (str) – The virtual machine index.
  • network_interface_name (str) – The name of the network interface.
  • ip_configuration_name (str) – The name of the IP configuration.
  • public_ip_address_name (str) – The name of the public IP Address.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

PublicIPAddress

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all public IP addresses in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

PublicIPAddressPaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all the public IP addresses in a subscription.

Parameters:
Return type:

PublicIPAddressPaged

Raises:

CloudError

list_virtual_machine_scale_set_public_ip_addresses(resource_group_name, virtual_machine_scale_set_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about all public IP addresses on a virtual machine scale set level.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

PublicIPAddressPaged

Raises:

CloudError

list_virtual_machine_scale_set_vm_public_ip_addresses(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, ip_configuration_name, custom_headers=None, raw=False, **operation_config)[source]

Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
  • virtualmachine_index (str) – The virtual machine index.
  • network_interface_name (str) – The network interface name.
  • ip_configuration_name (str) – The IP configuration name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

PublicIPAddressPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.RouteFiltersOperations(client, config, serializer, deserializer)[source]

Bases: object

RouteFiltersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a route filter in a specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • route_filter_parameters (RouteFilter) – Parameters supplied to the create or update route filter operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns RouteFilter

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, route_filter_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified route filter.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, route_filter_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified route filter.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • expand (str) – Expands referenced express route bgp peering resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RouteFilter

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Gets all route filters in a subscription.

Parameters:
Return type:

RouteFilterPaged

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all route filters in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RouteFilterPaged

Raises:

CloudError

update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers=None, raw=False, **operation_config)[source]

Updates a route filter in a specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • route_filter_parameters (PatchRouteFilter) – Parameters supplied to the update route filter operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns RouteFilter

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.RouteFilterRulesOperations(client, config, serializer, deserializer)[source]

Bases: object

RouteFilterRulesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a route in the specified route filter.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • rule_name (str) – The name of the route filter rule.
  • route_filter_rule_parameters (RouteFilterRule) – Parameters supplied to the create or update route filter rule operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns RouteFilterRule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, route_filter_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified rule from a route filter.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • rule_name (str) – The name of the rule.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, route_filter_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified rule from a route filter.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • rule_name (str) – The name of the rule.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RouteFilterRule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_by_route_filter(resource_group_name, route_filter_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all RouteFilterRules in a route filter.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RouteFilterRulePaged

Raises:

CloudError

update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers=None, raw=False, **operation_config)[source]

Updates a route in the specified route filter.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_filter_name (str) – The name of the route filter.
  • rule_name (str) – The name of the route filter rule.
  • route_filter_rule_parameters (PatchRouteFilterRule) – Parameters supplied to the update route filter rule operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns RouteFilterRule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.RouteTablesOperations(client, config, serializer, deserializer)[source]

Bases: object

RouteTablesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, route_table_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create or updates a route table in a specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_table_name (str) – The name of the route table.
  • parameters (RouteTable) – Parameters supplied to the create or update route table operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns RouteTable

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, route_table_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified route table.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_table_name (str) – The name of the route table.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, route_table_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified route table.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_table_name (str) – The name of the route table.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RouteTable

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all route tables in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RouteTablePaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all route tables in a subscription.

Parameters:
Return type:

RouteTablePaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.RoutesOperations(client, config, serializer, deserializer)[source]

Bases: object

RoutesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, route_table_name, route_name, route_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a route in the specified route table.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_table_name (str) – The name of the route table.
  • route_name (str) – The name of the route.
  • route_parameters (Route) – Parameters supplied to the create or update route operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Route

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, route_table_name, route_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified route from a route table.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_table_name (str) – The name of the route table.
  • route_name (str) – The name of the route.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, route_table_name, route_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified route from a route table.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_table_name (str) – The name of the route table.
  • route_name (str) – The name of the route.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Route

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, route_table_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all routes in a route table.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • route_table_name (str) – The name of the route table.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RoutePaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.BgpServiceCommunitiesOperations(client, config, serializer, deserializer)[source]

Bases: object

BgpServiceCommunitiesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Gets all the available bgp service communities.

Parameters:
Return type:

BgpServiceCommunityPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.UsagesOperations(client, config, serializer, deserializer)[source]

Bases: object

UsagesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

list(location, custom_headers=None, raw=False, **operation_config)[source]

Lists compute usages for a subscription.

Parameters:
  • location (str) – The location where resource usage is queried.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

UsagePaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.VirtualNetworksOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualNetworksOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

check_ip_address_availability(resource_group_name, virtual_network_name, ip_address=None, custom_headers=None, raw=False, **operation_config)[source]

Checks whether a private IP address is available for use.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • ip_address (str) – The private IP address to be verified.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

IPAddressAvailabilityResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, virtual_network_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a virtual network in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • parameters (VirtualNetwork) – Parameters supplied to the create or update virtual network operation
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns VirtualNetwork

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified virtual network.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, virtual_network_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified virtual network by resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetwork

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all virtual networks in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkPaged

Raises:

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]

Gets all virtual networks in a subscription.

Parameters:
Return type:

VirtualNetworkPaged

Raises:

CloudError

list_usage(resource_group_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)[source]

Lists usage stats.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkUsagePaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.SubnetsOperations(client, config, serializer, deserializer)[source]

Bases: object

SubnetsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a subnet in the specified virtual network.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • subnet_name (str) – The name of the subnet.
  • subnet_parameters (Subnet) – Parameters supplied to the create or update subnet operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Subnet

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, virtual_network_name, subnet_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified subnet.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • subnet_name (str) – The name of the subnet.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, virtual_network_name, subnet_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified subnet by virtual network and resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • subnet_name (str) – The name of the subnet.
  • expand (str) – Expands referenced resources.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Subnet

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all subnets in a virtual network.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SubnetPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.VirtualNetworkPeeringsOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualNetworkPeeringsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, virtual_network_name, virtual_network_peering_name, virtual_network_peering_parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a peering in the specified virtual network.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • virtual_network_peering_name (str) – The name of the peering.
  • virtual_network_peering_parameters (VirtualNetworkPeering) – Parameters supplied to the create or update virtual network peering operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns VirtualNetworkPeering

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified virtual network peering.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • virtual_network_peering_name (str) – The name of the virtual network peering.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified virtual network peering.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • virtual_network_peering_name (str) – The name of the virtual network peering.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkPeering

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all virtual network peerings in a virtual network.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_name (str) – The name of the virtual network.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkPeeringPaged

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.VirtualNetworkGatewaysOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualNetworkGatewaysOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, virtual_network_gateway_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a virtual network gateway in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • parameters (VirtualNetworkGateway) – Parameters supplied to create or update virtual network gateway operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns VirtualNetworkGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified virtual network gateway.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

generatevpnclientpackage(resource_group_name, virtual_network_gateway_name, processor_architecture, custom_headers=None, raw=False, **operation_config)[source]

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • processor_architecture (str or ProcessorArchitecture) – VPN client Processor Architecture. Possible values are: ‘AMD64’ and ‘X86’. Possible values include: ‘Amd64’, ‘X86’
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

str

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified virtual network gateway by resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_advertised_routes(resource_group_name, virtual_network_gateway_name, peer, custom_headers=None, raw=False, **operation_config)[source]

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • peer (str) – The IP address of the peer
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns GatewayRouteListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_bgp_peer_status(resource_group_name, virtual_network_gateway_name, peer=None, custom_headers=None, raw=False, **operation_config)[source]

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • peer (str) – The IP address of the peer to retrieve the status of.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns BgpPeerStatusListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_learned_routes(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns GatewayRouteListResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all virtual network gateways by resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkGatewayPaged

Raises:

CloudError

reset(resource_group_name, virtual_network_gateway_name, gateway_vip=None, custom_headers=None, raw=False, **operation_config)[source]

Resets the primary of the virtual network gateway in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_name (str) – The name of the virtual network gateway.
  • gateway_vip (str) – Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns VirtualNetworkGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.VirtualNetworkGatewayConnectionsOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualNetworkGatewayConnectionsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, virtual_network_gateway_connection_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a virtual network gateway connection in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.
  • parameters (VirtualNetworkGatewayConnection) – Parameters supplied to the create or update virtual network gateway connection operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns VirtualNetworkGatewayConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, virtual_network_gateway_connection_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified virtual network Gateway connection.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, virtual_network_gateway_connection_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified virtual network gateway connection by resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkGatewayConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_shared_key(resource_group_name, virtual_network_gateway_connection_name, custom_headers=None, raw=False, **operation_config)[source]

The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_connection_name (str) – The virtual network gateway connection shared key name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ConnectionSharedKey

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VirtualNetworkGatewayConnectionPaged

Raises:

CloudError

reset_shared_key(resource_group_name, virtual_network_gateway_connection_name, key_length, custom_headers=None, raw=False, **operation_config)[source]

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:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_connection_name (str) – The virtual network gateway connection reset shared key Name.
  • key_length (int) – The virtual network connection reset shared key length, should between 1 and 128.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ConnectionResetSharedKey

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

set_shared_key(resource_group_name, virtual_network_gateway_connection_name, value, custom_headers=None, raw=False, **operation_config)[source]

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:
  • resource_group_name (str) – The name of the resource group.
  • virtual_network_gateway_connection_name (str) – The virtual network gateway connection name.
  • value (str) – The virtual network connection shared key value.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns ConnectionSharedKey

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.network.v2017_03_01.operations.LocalNetworkGatewaysOperations(client, config, serializer, deserializer)[source]

Bases: object

LocalNetworkGatewaysOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2017-03-01”.

create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a local network gateway in the specified resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • local_network_gateway_name (str) – The name of the local network gateway.
  • parameters (LocalNetworkGateway) – Parameters supplied to the create or update local network gateway operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns LocalNetworkGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, local_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified local network gateway.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • local_network_gateway_name (str) – The name of the local network gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, local_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified local network gateway in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • local_network_gateway_name (str) – The name of the local network gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

LocalNetworkGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all the local network gateways in a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

LocalNetworkGatewayPaged

Raises:

CloudError