azure.mgmt.network.v2017_09_01.operations module

class azure.mgmt.network.v2017_09_01.operations.ApplicationGatewaysOperations(client, config, serializer, deserializer)

Bases: object

ApplicationGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

backend_health(resource_group_name, application_gateway_name, expand=None, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationGatewayBackendHealth or ClientRawResponse<ApplicationGatewayBackendHealth> if raw==True

Return type

AzureOperationPoller[ApplicationGatewayBackendHealth] or AzureOperationPoller[ClientRawResponse[ApplicationGatewayBackendHealth]]

Raises

CloudError

create_or_update(resource_group_name, application_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationGateway or ClientRawResponse<ApplicationGateway> if raw==True

Return type

AzureOperationPoller[ApplicationGateway] or AzureOperationPoller[ClientRawResponse[ApplicationGateway]]

Raises

CloudError

delete(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

ApplicationGateway or ClientRawResponse if raw=true

Return type

ApplicationGateway or ClientRawResponse

Raises

CloudError

get_ssl_predefined_policy(predefined_policy_name, custom_headers=None, raw=False, **operation_config)

Gets Ssl predefined policy with the specified policy name.

Parameters

• predefined_policy_name (str) – Name of Ssl predefined policy.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ApplicationGatewaySslPredefinedPolicy or ClientRawResponse if raw=true

Return type

ApplicationGatewaySslPredefinedPolicy or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationGateway

Return type

ApplicationGatewayPaged[ApplicationGateway]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all the application gateways in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationGateway

Return type

ApplicationGatewayPaged[ApplicationGateway]

Raises

CloudError

list_available_ssl_options(custom_headers=None, raw=False, **operation_config)

Lists available Ssl options for configuring Ssl policy.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ApplicationGatewayAvailableSslOptions or ClientRawResponse if raw=true

Return type

ApplicationGatewayAvailableSslOptions or ClientRawResponse

Raises

CloudError

list_available_ssl_predefined_policies(custom_headers=None, raw=False, **operation_config)

Lists all SSL predefined policies for configuring Ssl policy.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationGatewaySslPredefinedPolicy

Return type

ApplicationGatewaySslPredefinedPolicyPaged[ApplicationGatewaySslPredefinedPolicy]

Raises

CloudError

list_available_waf_rule_sets(custom_headers=None, raw=False, **operation_config)

Lists all available web application firewall rule sets.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ApplicationGatewayAvailableWafRuleSetsResult or ClientRawResponse if raw=true

Return type

ApplicationGatewayAvailableWafRuleSetsResult or ClientRawResponse

Raises

CloudError

start(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

stop(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

update_tags(resource_group_name, application_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates the specified application gateway tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• application_gateway_name (str) – The name of the application gateway.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationGateway or ClientRawResponse<ApplicationGateway> if raw==True

Return type

AzureOperationPoller[ApplicationGateway] or AzureOperationPoller[ClientRawResponse[ApplicationGateway]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.ApplicationSecurityGroupsOperations(client, config, serializer, deserializer)

Bases: object

ApplicationSecurityGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, application_security_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Creates or updates an application security group.

Parameters

• resource_group_name (str) – The name of the resource group.

• application_security_group_name (str) – The name of the application security group.

• parameters (ApplicationSecurityGroup) – Parameters supplied to the create or update ApplicationSecurityGroup operation.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationSecurityGroup or ClientRawResponse<ApplicationSecurityGroup> if raw==True

Return type

AzureOperationPoller[ApplicationSecurityGroup] or AzureOperationPoller[ClientRawResponse[ApplicationSecurityGroup]]

Raises

CloudError

delete(resource_group_name, application_security_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the specified application security group.

Parameters

• resource_group_name (str) – The name of the resource group.

• application_security_group_name (str) – The name of the application security group.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, application_security_group_name, custom_headers=None, raw=False, **operation_config)

Gets information about the specified application security group.

Parameters

• resource_group_name (str) – The name of the resource group.

• application_security_group_name (str) – The name of the application security group.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ApplicationSecurityGroup or ClientRawResponse if raw=true

Return type

ApplicationSecurityGroup or ClientRawResponse

Raises

CloudError

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

Gets all the application 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_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationSecurityGroup

Return type

ApplicationSecurityGroupPaged[ApplicationSecurityGroup]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all application security groups in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationSecurityGroup

Return type

ApplicationSecurityGroupPaged[ApplicationSecurityGroup]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.AvailableEndpointServicesOperations(client, config, serializer, deserializer)

Bases: object

AvailableEndpointServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

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

List what values of endpoint services are available for use.

Parameters

• location (str) – The location to check available endpoint services.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of EndpointServiceResult

Return type

EndpointServiceResultPaged[EndpointServiceResult]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.BgpServiceCommunitiesOperations(client, config, serializer, deserializer)

Bases: object

BgpServiceCommunitiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

list(custom_headers=None, raw=False, **operation_config)

Gets all the available bgp service communities.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of BgpServiceCommunity

Return type

BgpServiceCommunityPaged[BgpServiceCommunity]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.DefaultSecurityRulesOperations(client, config, serializer, deserializer)

Bases: object

DefaultSecurityRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

get(resource_group_name, network_security_group_name, default_security_rule_name, custom_headers=None, raw=False, **operation_config)

Get the specified default 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.

• default_security_rule_name (str) – The name of the default security rule.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SecurityRule or ClientRawResponse if raw=true

Return type

SecurityRule or ClientRawResponse

Raises

CloudError

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

Gets all default 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_config – Operation configuration overrides.

Returns

An iterator like instance of SecurityRule

Return type

SecurityRulePaged[SecurityRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.ExpressRouteCircuitAuthorizationsOperations(client, config, serializer, deserializer)

Bases: object

ExpressRouteCircuitAuthorizationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, circuit_name, authorization_name, authorization_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitAuthorization or ClientRawResponse<ExpressRouteCircuitAuthorization> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitAuthorization] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitAuthorization]]

Raises

CloudError

delete(resource_group_name, circuit_name, authorization_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

ExpressRouteCircuitAuthorization or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitAuthorization or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuitAuthorization

Return type

ExpressRouteCircuitAuthorizationPaged[ExpressRouteCircuitAuthorization]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.ExpressRouteCircuitPeeringsOperations(client, config, serializer, deserializer)

Bases: object

ExpressRouteCircuitPeeringsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, circuit_name, peering_name, peering_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitPeering or ClientRawResponse<ExpressRouteCircuitPeering> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitPeering] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitPeering]]

Raises

CloudError

delete(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

ExpressRouteCircuitPeering or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitPeering or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuitPeering

Return type

ExpressRouteCircuitPeeringPaged[ExpressRouteCircuitPeering]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.ExpressRouteCircuitsOperations(client, config, serializer, deserializer)

Bases: object

ExpressRouteCircuitsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, circuit_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuit or ClientRawResponse<ExpressRouteCircuit> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuit] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuit]]

Raises

CloudError

delete(resource_group_name, circuit_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

ExpressRouteCircuit or ClientRawResponse if raw=true

Return type

ExpressRouteCircuit or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

ExpressRouteCircuitStats or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitStats or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

ExpressRouteCircuitStats or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitStats or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuit

Return type

ExpressRouteCircuitPaged[ExpressRouteCircuit]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all the express route circuits in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuit

Return type

ExpressRouteCircuitPaged[ExpressRouteCircuit]

Raises

CloudError

list_arp_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsArpTableListResult or ClientRawResponse<ExpressRouteCircuitsArpTableListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsArpTableListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsArpTableListResult]]

Raises

CloudError

list_routes_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsRoutesTableListResult or ClientRawResponse<ExpressRouteCircuitsRoutesTableListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsRoutesTableListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsRoutesTableListResult]]

Raises

CloudError

list_routes_table_summary(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsRoutesTableSummaryListResult or ClientRawResponse<ExpressRouteCircuitsRoutesTableSummaryListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsRoutesTableSummaryListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsRoutesTableSummaryListResult]]

Raises

CloudError

update_tags(resource_group_name, circuit_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates an express route circuit tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• circuit_name (str) – The name of the circuit.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuit or ClientRawResponse<ExpressRouteCircuit> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuit] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuit]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.ExpressRouteServiceProvidersOperations(client, config, serializer, deserializer)

Bases: object

ExpressRouteServiceProvidersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

list(custom_headers=None, raw=False, **operation_config)

Gets all the available express route service providers.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteServiceProvider

Return type

ExpressRouteServiceProviderPaged[ExpressRouteServiceProvider]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.InboundNatRulesOperations(client, config, serializer, deserializer)

Bases: object

InboundNatRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, load_balancer_name, inbound_nat_rule_name, inbound_nat_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Creates or updates a load balancer inbound nat rule.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• inbound_nat_rule_name (str) – The name of the inbound nat rule.

• inbound_nat_rule_parameters (InboundNatRule) – Parameters supplied to the create or update inbound nat rule operation.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InboundNatRule or ClientRawResponse<InboundNatRule> if raw==True

Return type

AzureOperationPoller[InboundNatRule] or AzureOperationPoller[ClientRawResponse[InboundNatRule]]

Raises

CloudError

delete(resource_group_name, load_balancer_name, inbound_nat_rule_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the specified load balancer inbound nat rule.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• inbound_nat_rule_name (str) – The name of the inbound nat rule.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, load_balancer_name, inbound_nat_rule_name, expand=None, custom_headers=None, raw=False, **operation_config)

Gets the specified load balancer inbound nat rule.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• inbound_nat_rule_name (str) – The name of the inbound nat rule.

• 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_config – Operation configuration overrides.

Returns

InboundNatRule or ClientRawResponse if raw=true

Return type

InboundNatRule or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)

Gets all the inbound nat rules in a 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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of InboundNatRule

Return type

InboundNatRulePaged[InboundNatRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.LoadBalancerBackendAddressPoolsOperations(client, config, serializer, deserializer)

Bases: object

LoadBalancerBackendAddressPoolsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

get(resource_group_name, load_balancer_name, backend_address_pool_name, custom_headers=None, raw=False, **operation_config)

Gets load balancer backend address pool.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• backend_address_pool_name (str) – The name of the backend address pool.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackendAddressPool or ClientRawResponse if raw=true

Return type

BackendAddressPool or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)

Gets all the load balancer backed address pools.

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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of BackendAddressPool

Return type

BackendAddressPoolPaged[BackendAddressPool]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.LoadBalancerFrontendIPConfigurationsOperations(client, config, serializer, deserializer)

Bases: object

LoadBalancerFrontendIPConfigurationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

get(resource_group_name, load_balancer_name, frontend_ip_configuration_name, custom_headers=None, raw=False, **operation_config)

Gets load balancer frontend IP configuration.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• frontend_ip_configuration_name (str) – The name of the frontend IP configuration.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

FrontendIPConfiguration or ClientRawResponse if raw=true

Return type

FrontendIPConfiguration or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)

Gets all the load balancer frontend IP configurations.

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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of FrontendIPConfiguration

Return type

FrontendIPConfigurationPaged[FrontendIPConfiguration]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.LoadBalancerLoadBalancingRulesOperations(client, config, serializer, deserializer)

Bases: object

LoadBalancerLoadBalancingRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

get(resource_group_name, load_balancer_name, load_balancing_rule_name, custom_headers=None, raw=False, **operation_config)

Gets the specified load balancer load balancing rule.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• load_balancing_rule_name (str) – The name of the load balancing rule.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

LoadBalancingRule or ClientRawResponse if raw=true

Return type

LoadBalancingRule or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)

Gets all the load balancing rules in a 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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancingRule

Return type

LoadBalancingRulePaged[LoadBalancingRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.LoadBalancerNetworkInterfacesOperations(client, config, serializer, deserializer)

Bases: object

LoadBalancerNetworkInterfacesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)

Gets associated load balancer network interfaces.

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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

NetworkInterfacePaged[NetworkInterface]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.LoadBalancerProbesOperations(client, config, serializer, deserializer)

Bases: object

LoadBalancerProbesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

get(resource_group_name, load_balancer_name, probe_name, custom_headers=None, raw=False, **operation_config)

Gets load balancer probe.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• probe_name (str) – The name of the probe.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Probe or ClientRawResponse if raw=true

Return type

Probe or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)

Gets all the load balancer probes.

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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Probe

Return type

ProbePaged[Probe]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.LoadBalancersOperations(client, config, serializer, deserializer)

Bases: object

LoadBalancersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, load_balancer_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LoadBalancer or ClientRawResponse<LoadBalancer> if raw==True

Return type

AzureOperationPoller[LoadBalancer] or AzureOperationPoller[ClientRawResponse[LoadBalancer]]

Raises

CloudError

delete(resource_group_name, load_balancer_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

LoadBalancer or ClientRawResponse if raw=true

Return type

LoadBalancer or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancer

Return type

LoadBalancerPaged[LoadBalancer]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all the load balancers in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancer

Return type

LoadBalancerPaged[LoadBalancer]

Raises

CloudError

update_tags(resource_group_name, load_balancer_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a load balancer tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• load_balancer_name (str) – The name of the load balancer.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LoadBalancer or ClientRawResponse<LoadBalancer> if raw==True

Return type

AzureOperationPoller[LoadBalancer] or AzureOperationPoller[ClientRawResponse[LoadBalancer]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.LocalNetworkGatewaysOperations(client, config, serializer, deserializer)

Bases: object

LocalNetworkGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LocalNetworkGateway or ClientRawResponse<LocalNetworkGateway> if raw==True

Return type

AzureOperationPoller[LocalNetworkGateway] or AzureOperationPoller[ClientRawResponse[LocalNetworkGateway]]

Raises

CloudError

delete(resource_group_name, local_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

LocalNetworkGateway or ClientRawResponse if raw=true

Return type

LocalNetworkGateway or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of LocalNetworkGateway

Return type

LocalNetworkGatewayPaged[LocalNetworkGateway]

Raises

CloudError

update_tags(resource_group_name, local_network_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a local network gateway tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• local_network_gateway_name (str) – The name of the local network gateway.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LocalNetworkGateway or ClientRawResponse<LocalNetworkGateway> if raw==True

Return type

AzureOperationPoller[LocalNetworkGateway] or AzureOperationPoller[ClientRawResponse[LocalNetworkGateway]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.NetworkInterfaceIPConfigurationsOperations(client, config, serializer, deserializer)

Bases: object

NetworkInterfaceIPConfigurationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

get(resource_group_name, network_interface_name, ip_configuration_name, custom_headers=None, raw=False, **operation_config)

Gets the specified network interface ip configuration.

Parameters

• resource_group_name (str) – The name of the resource group.

• network_interface_name (str) – The name of the network interface.

• ip_configuration_name (str) – The name of 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_config – Operation configuration overrides.

Returns

NetworkInterfaceIPConfiguration or ClientRawResponse if raw=true

Return type

NetworkInterfaceIPConfiguration or ClientRawResponse

Raises

CloudError

list(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)

Get all ip configurations in 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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterfaceIPConfiguration

Return type

NetworkInterfaceIPConfigurationPaged[NetworkInterfaceIPConfiguration]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.NetworkInterfaceLoadBalancersOperations(client, config, serializer, deserializer)

Bases: object

NetworkInterfaceLoadBalancersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

list(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)

List all load balancers in 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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancer

Return type

LoadBalancerPaged[LoadBalancer]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.NetworkInterfacesOperations(client, config, serializer, deserializer)

Bases: object

NetworkInterfacesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name, network_interface_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkInterface or ClientRawResponse<NetworkInterface> if raw==True

Return type

AzureOperationPoller[NetworkInterface] or AzureOperationPoller[ClientRawResponse[NetworkInterface]]

Raises

CloudError

delete(resource_group_name, network_interface_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

NetworkInterface or ClientRawResponse if raw=true

Return type

NetworkInterface or ClientRawResponse

Raises

CloudError

get_effective_route_table(resource_group_name, network_interface_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns EffectiveRouteListResult or ClientRawResponse<EffectiveRouteListResult> if raw==True

Return type

AzureOperationPoller[EffectiveRouteListResult] or AzureOperationPoller[ClientRawResponse[EffectiveRouteListResult]]

Raises

CloudError

get_virtual_machine_scale_set_ip_configuration(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, ip_configuration_name, expand=None, custom_headers=None, raw=False, **operation_config)

Get the specified network interface 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 name of the network interface.

• ip_configuration_name (str) – The name of the ip configuration.

• 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_config – Operation configuration overrides.

Returns

NetworkInterfaceIPConfiguration or ClientRawResponse if raw=true

Return type

NetworkInterfaceIPConfiguration or ClientRawResponse

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)

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_config – Operation configuration overrides.

Returns

NetworkInterface or ClientRawResponse if raw=true

Return type

NetworkInterface or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

NetworkInterfacePaged[NetworkInterface]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all network interfaces in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

NetworkInterfacePaged[NetworkInterface]

Raises

CloudError

list_effective_network_security_groups(resource_group_name, network_interface_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns EffectiveNetworkSecurityGroupListResult or ClientRawResponse<EffectiveNetworkSecurityGroupListResult> if raw==True

Return type

AzureOperationPoller[EffectiveNetworkSecurityGroupListResult] or AzureOperationPoller[ClientRawResponse[EffectiveNetworkSecurityGroupListResult]]

Raises

CloudError

list_virtual_machine_scale_set_ip_configurations(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, expand=None, custom_headers=None, raw=False, **operation_config)

Get the specified network interface 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 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_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterfaceIPConfiguration

Return type

NetworkInterfaceIPConfigurationPaged[NetworkInterfaceIPConfiguration]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

NetworkInterfacePaged[NetworkInterface]

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)

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_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

NetworkInterfacePaged[NetworkInterface]

Raises

CloudError

update_tags(resource_group_name, network_interface_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a network interface tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• network_interface_name (str) – The name of the network interface.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkInterface or ClientRawResponse<NetworkInterface> if raw==True

Return type

AzureOperationPoller[NetworkInterface] or AzureOperationPoller[ClientRawResponse[NetworkInterface]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.NetworkManagementClientOperationsMixin

Bases: object

check_dns_name_availability(location, domain_name_label, custom_headers=None, raw=False, **operation_config)

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

Parameters

• location (str) – The location of the domain name.

• domain_name_label (str) – The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DnsNameAvailabilityResult or ClientRawResponse if raw=true

Return type

DnsNameAvailabilityResult or ClientRawResponse

Raises

CloudError

class azure.mgmt.network.v2017_09_01.operations.NetworkSecurityGroupsOperations(client, config, serializer, deserializer)

Bases: object

NetworkSecurityGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, network_security_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkSecurityGroup or ClientRawResponse<NetworkSecurityGroup> if raw==True

Return type

AzureOperationPoller[NetworkSecurityGroup] or AzureOperationPoller[ClientRawResponse[NetworkSecurityGroup]]

Raises

CloudError

delete(resource_group_name, network_security_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

NetworkSecurityGroup or ClientRawResponse if raw=true

Return type

NetworkSecurityGroup or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkSecurityGroup

Return type

NetworkSecurityGroupPaged[NetworkSecurityGroup]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all network security groups in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkSecurityGroup

Return type

NetworkSecurityGroupPaged[NetworkSecurityGroup]

Raises

CloudError

update_tags(resource_group_name, network_security_group_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a network security group tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• network_security_group_name (str) – The name of the network security group.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkSecurityGroup or ClientRawResponse<NetworkSecurityGroup> if raw==True

Return type

AzureOperationPoller[NetworkSecurityGroup] or AzureOperationPoller[ClientRawResponse[NetworkSecurityGroup]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.NetworkWatchersOperations(client, config, serializer, deserializer)

Bases: object

NetworkWatchersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

check_connectivity(resource_group_name, network_watcher_name, source, destination, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectivityInformation or ClientRawResponse<ConnectivityInformation> if raw==True

Return type

AzureOperationPoller[ConnectivityInformation] or AzureOperationPoller[ClientRawResponse[ConnectivityInformation]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

NetworkWatcher or ClientRawResponse if raw=true

Return type

NetworkWatcher or ClientRawResponse

Raises

CloudError

delete(resource_group_name, network_watcher_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

NetworkWatcher or ClientRawResponse if raw=true

Return type

NetworkWatcher or ClientRawResponse

Raises

CloudError

get_azure_reachability_report(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Gets the relative latency score for internet service providers from a specified location to Azure regions.

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 (AzureReachabilityReportParameters) – Parameters that determine Azure reachability report configuration.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AzureReachabilityReport or ClientRawResponse<AzureReachabilityReport> if raw==True

Return type

AzureOperationPoller[AzureReachabilityReport] or AzureOperationPoller[ClientRawResponse[AzureReachabilityReport]]

Raises

CloudError

get_flow_log_status(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FlowLogInformation or ClientRawResponse<FlowLogInformation> if raw==True

Return type

AzureOperationPoller[FlowLogInformation] or AzureOperationPoller[ClientRawResponse[FlowLogInformation]]

Raises

CloudError

get_next_hop(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NextHopResult or ClientRawResponse<NextHopResult> if raw==True

Return type

AzureOperationPoller[NextHopResult] or AzureOperationPoller[ClientRawResponse[NextHopResult]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

Topology or ClientRawResponse if raw=true

Return type

Topology or ClientRawResponse

Raises

CloudError

get_troubleshooting(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns TroubleshootingResult or ClientRawResponse<TroubleshootingResult> if raw==True

Return type

AzureOperationPoller[TroubleshootingResult] or AzureOperationPoller[ClientRawResponse[TroubleshootingResult]]

Raises

CloudError

get_troubleshooting_result(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns TroubleshootingResult or ClientRawResponse<TroubleshootingResult> if raw==True

Return type

AzureOperationPoller[TroubleshootingResult] or AzureOperationPoller[ClientRawResponse[TroubleshootingResult]]

Raises

CloudError

get_vm_security_rules(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SecurityGroupViewResult or ClientRawResponse<SecurityGroupViewResult> if raw==True

Return type

AzureOperationPoller[SecurityGroupViewResult] or AzureOperationPoller[ClientRawResponse[SecurityGroupViewResult]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkWatcher

Return type

NetworkWatcherPaged[NetworkWatcher]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all network watchers by subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkWatcher

Return type

NetworkWatcherPaged[NetworkWatcher]

Raises

CloudError

list_available_providers(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Lists all available internet service providers for a specified Azure region.

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 (AvailableProvidersListParameters) – Parameters that scope the list of available providers.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AvailableProvidersList or ClientRawResponse<AvailableProvidersList> if raw==True

Return type

AzureOperationPoller[AvailableProvidersList] or AzureOperationPoller[ClientRawResponse[AvailableProvidersList]]

Raises

CloudError

set_flow_log_configuration(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FlowLogInformation or ClientRawResponse<FlowLogInformation> if raw==True

Return type

AzureOperationPoller[FlowLogInformation] or AzureOperationPoller[ClientRawResponse[FlowLogInformation]]

Raises

CloudError

update_tags(resource_group_name, network_watcher_name, tags=None, custom_headers=None, raw=False, **operation_config)

Updates a network watcher tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• network_watcher_name (str) – The name of the network watcher.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

NetworkWatcher or ClientRawResponse if raw=true

Return type

NetworkWatcher or ClientRawResponse

Raises

CloudError

verify_ip_flow(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VerificationIPFlowResult or ClientRawResponse<VerificationIPFlowResult> if raw==True

Return type

AzureOperationPoller[VerificationIPFlowResult] or AzureOperationPoller[ClientRawResponse[VerificationIPFlowResult]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.Operations(client, config, serializer, deserializer)

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

list(custom_headers=None, raw=False, **operation_config)

Lists all of the available Network Rest API operations.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.PacketCapturesOperations(client, config, serializer, deserializer)

Bases: object

PacketCapturesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PacketCaptureResult or ClientRawResponse<PacketCaptureResult> if raw==True

Return type

AzureOperationPoller[PacketCaptureResult] or AzureOperationPoller[ClientRawResponse[PacketCaptureResult]]

Raises

CloudError

delete(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

PacketCaptureResult or ClientRawResponse if raw=true

Return type

PacketCaptureResult or ClientRawResponse

Raises

CloudError

get_status(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PacketCaptureQueryStatusResult or ClientRawResponse<PacketCaptureQueryStatusResult> if raw==True

Return type

AzureOperationPoller[PacketCaptureQueryStatusResult] or AzureOperationPoller[ClientRawResponse[PacketCaptureQueryStatusResult]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of PacketCaptureResult

Return type

PacketCaptureResultPaged[PacketCaptureResult]

Raises

CloudError

stop(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.PublicIPAddressesOperations(client, config, serializer, deserializer)

Bases: object

PublicIPAddressesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name, public_ip_address_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PublicIPAddress or ClientRawResponse<PublicIPAddress> if raw==True

Return type

AzureOperationPoller[PublicIPAddress] or AzureOperationPoller[ClientRawResponse[PublicIPAddress]]

Raises

CloudError

delete(resource_group_name, public_ip_address_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

PublicIPAddress or ClientRawResponse if raw=true

Return type

PublicIPAddress or ClientRawResponse

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)

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_config – Operation configuration overrides.

Returns

PublicIPAddress or ClientRawResponse if raw=true

Return type

PublicIPAddress or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

PublicIPAddressPaged[PublicIPAddress]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all the public IP addresses in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

PublicIPAddressPaged[PublicIPAddress]

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)

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_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

PublicIPAddressPaged[PublicIPAddress]

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)

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_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

PublicIPAddressPaged[PublicIPAddress]

Raises

CloudError

update_tags(resource_group_name, public_ip_address_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates public IP address tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• public_ip_address_name (str) – The name of the public IP address.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PublicIPAddress or ClientRawResponse<PublicIPAddress> if raw==True

Return type

AzureOperationPoller[PublicIPAddress] or AzureOperationPoller[ClientRawResponse[PublicIPAddress]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.RouteFilterRulesOperations(client, config, serializer, deserializer)

Bases: object

RouteFilterRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilterRule or ClientRawResponse<RouteFilterRule> if raw==True

Return type

AzureOperationPoller[RouteFilterRule] or AzureOperationPoller[ClientRawResponse[RouteFilterRule]]

Raises

CloudError

delete(resource_group_name, route_filter_name, rule_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

RouteFilterRule or ClientRawResponse if raw=true

Return type

RouteFilterRule or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of RouteFilterRule

Return type

RouteFilterRulePaged[RouteFilterRule]

Raises

CloudError

update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilterRule or ClientRawResponse<RouteFilterRule> if raw==True

Return type

AzureOperationPoller[RouteFilterRule] or AzureOperationPoller[ClientRawResponse[RouteFilterRule]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.RouteFiltersOperations(client, config, serializer, deserializer)

Bases: object

RouteFiltersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilter or ClientRawResponse<RouteFilter> if raw==True

Return type

AzureOperationPoller[RouteFilter] or AzureOperationPoller[ClientRawResponse[RouteFilter]]

Raises

CloudError

delete(resource_group_name, route_filter_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

RouteFilter or ClientRawResponse if raw=true

Return type

RouteFilter or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)

Gets all route filters in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of RouteFilter

Return type

RouteFilterPaged[RouteFilter]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of RouteFilter

Return type

RouteFilterPaged[RouteFilter]

Raises

CloudError

update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilter or ClientRawResponse<RouteFilter> if raw==True

Return type

AzureOperationPoller[RouteFilter] or AzureOperationPoller[ClientRawResponse[RouteFilter]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.RouteTablesOperations(client, config, serializer, deserializer)

Bases: object

RouteTablesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, route_table_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteTable or ClientRawResponse<RouteTable> if raw==True

Return type

AzureOperationPoller[RouteTable] or AzureOperationPoller[ClientRawResponse[RouteTable]]

Raises

CloudError

delete(resource_group_name, route_table_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

RouteTable or ClientRawResponse if raw=true

Return type

RouteTable or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of RouteTable

Return type

RouteTablePaged[RouteTable]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all route tables in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of RouteTable

Return type

RouteTablePaged[RouteTable]

Raises

CloudError

update_tags(resource_group_name, route_table_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a route table tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• route_table_name (str) – The name of the route table.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteTable or ClientRawResponse<RouteTable> if raw==True

Return type

AzureOperationPoller[RouteTable] or AzureOperationPoller[ClientRawResponse[RouteTable]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.RoutesOperations(client, config, serializer, deserializer)

Bases: object

RoutesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, route_table_name, route_name, route_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Route or ClientRawResponse<Route> if raw==True

Return type

AzureOperationPoller[Route] or AzureOperationPoller[ClientRawResponse[Route]]

Raises

CloudError

delete(resource_group_name, route_table_name, route_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

Route or ClientRawResponse if raw=true

Return type

Route or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of Route

Return type

RoutePaged[Route]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.SecurityRulesOperations(client, config, serializer, deserializer)

Bases: object

SecurityRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, network_security_group_name, security_rule_name, security_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SecurityRule or ClientRawResponse<SecurityRule> if raw==True

Return type

AzureOperationPoller[SecurityRule] or AzureOperationPoller[ClientRawResponse[SecurityRule]]

Raises

CloudError

delete(resource_group_name, network_security_group_name, security_rule_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

SecurityRule or ClientRawResponse if raw=true

Return type

SecurityRule or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of SecurityRule

Return type

SecurityRulePaged[SecurityRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.SubnetsOperations(client, config, serializer, deserializer)

Bases: object

SubnetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Subnet or ClientRawResponse<Subnet> if raw==True

Return type

AzureOperationPoller[Subnet] or AzureOperationPoller[ClientRawResponse[Subnet]]

Raises

CloudError

delete(resource_group_name, virtual_network_name, subnet_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

Subnet or ClientRawResponse if raw=true

Return type

Subnet or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of Subnet

Return type

SubnetPaged[Subnet]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.UsagesOperations(client, config, serializer, deserializer)

Bases: object

UsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

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

List network 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_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.VirtualNetworkGatewayConnectionsOperations(client, config, serializer, deserializer)

Bases: object

VirtualNetworkGatewayConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, virtual_network_gateway_connection_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGatewayConnection or ClientRawResponse<VirtualNetworkGatewayConnection> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGatewayConnection] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGatewayConnection]]

Raises

CloudError

delete(resource_group_name, virtual_network_gateway_connection_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

VirtualNetworkGatewayConnection or ClientRawResponse if raw=true

Return type

VirtualNetworkGatewayConnection or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

ConnectionSharedKey or ClientRawResponse if raw=true

Return type

ConnectionSharedKey or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkGatewayConnection

Return type

VirtualNetworkGatewayConnectionPaged[VirtualNetworkGatewayConnection]

Raises

CloudError

reset_shared_key(resource_group_name, virtual_network_gateway_connection_name, key_length, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectionResetSharedKey or ClientRawResponse<ConnectionResetSharedKey> if raw==True

Return type

AzureOperationPoller[ConnectionResetSharedKey] or AzureOperationPoller[ClientRawResponse[ConnectionResetSharedKey]]

Raises

CloudError

set_shared_key(resource_group_name, virtual_network_gateway_connection_name, value, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectionSharedKey or ClientRawResponse<ConnectionSharedKey> if raw==True

Return type

AzureOperationPoller[ConnectionSharedKey] or AzureOperationPoller[ClientRawResponse[ConnectionSharedKey]]

Raises

CloudError

update_tags(resource_group_name, virtual_network_gateway_connection_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a virtual network gateway connection tags.

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.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGatewayConnectionListEntity or ClientRawResponse<VirtualNetworkGatewayConnectionListEntity> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGatewayConnectionListEntity] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGatewayConnectionListEntity]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.VirtualNetworkGatewaysOperations(client, config, serializer, deserializer)

Bases: object

VirtualNetworkGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, virtual_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGateway or ClientRawResponse<VirtualNetworkGateway> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGateway] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGateway]]

Raises

CloudError

delete(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

generate_vpn_profile(resource_group_name, virtual_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

Parameters

• resource_group_name (str) – The name of the resource group.

• virtual_network_gateway_name (str) – The name of the virtual network gateway.

• parameters (VpnClientParameters) – Parameters supplied to the generate virtual network gateway VPN client package operation.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns str or ClientRawResponse<str> if raw==True

Return type

AzureOperationPoller[str] or AzureOperationPoller[ClientRawResponse[str]]

Raises

CloudError

generatevpnclientpackage(resource_group_name, virtual_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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.

• parameters (VpnClientParameters) – Parameters supplied to the generate virtual network gateway VPN client package operation.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns str or ClientRawResponse<str> if raw==True

Return type

AzureOperationPoller[str] or AzureOperationPoller[ClientRawResponse[str]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

VirtualNetworkGateway or ClientRawResponse if raw=true

Return type

VirtualNetworkGateway or ClientRawResponse

Raises

CloudError

get_advertised_routes(resource_group_name, virtual_network_gateway_name, peer, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns GatewayRouteListResult or ClientRawResponse<GatewayRouteListResult> if raw==True

Return type

AzureOperationPoller[GatewayRouteListResult] or AzureOperationPoller[ClientRawResponse[GatewayRouteListResult]]

Raises

CloudError

get_bgp_peer_status(resource_group_name, virtual_network_gateway_name, peer=None, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BgpPeerStatusListResult or ClientRawResponse<BgpPeerStatusListResult> if raw==True

Return type

AzureOperationPoller[BgpPeerStatusListResult] or AzureOperationPoller[ClientRawResponse[BgpPeerStatusListResult]]

Raises

CloudError

get_learned_routes(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns GatewayRouteListResult or ClientRawResponse<GatewayRouteListResult> if raw==True

Return type

AzureOperationPoller[GatewayRouteListResult] or AzureOperationPoller[ClientRawResponse[GatewayRouteListResult]]

Raises

CloudError

get_vpn_profile_package_url(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns str or ClientRawResponse<str> if raw==True

Return type

AzureOperationPoller[str] or AzureOperationPoller[ClientRawResponse[str]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkGateway

Return type

VirtualNetworkGatewayPaged[VirtualNetworkGateway]

Raises

CloudError

list_connections(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)

Gets all the connections in a 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

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkGatewayConnectionListEntity

Return type

VirtualNetworkGatewayConnectionListEntityPaged[VirtualNetworkGatewayConnectionListEntity]

Raises

CloudError

reset(resource_group_name, virtual_network_gateway_name, gateway_vip=None, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGateway or ClientRawResponse<VirtualNetworkGateway> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGateway] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGateway]]

Raises

CloudError

supported_vpn_devices(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)

Gets a xml format representation for supported vpn devices.

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_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

update_tags(resource_group_name, virtual_network_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a virtual network gateway tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• virtual_network_gateway_name (str) – The name of the virtual network gateway.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGateway or ClientRawResponse<VirtualNetworkGateway> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGateway] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGateway]]

Raises

CloudError

vpn_device_configuration_script(resource_group_name, virtual_network_gateway_connection_name, parameters, custom_headers=None, raw=False, **operation_config)

Gets a xml format representation for vpn device configuration script.

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 for which the configuration script is generated.

• parameters (VpnDeviceScriptParameters) – Parameters supplied to the generate vpn device script operation.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.VirtualNetworkPeeringsOperations(client, config, serializer, deserializer)

Bases: object

VirtualNetworkPeeringsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

create_or_update(resource_group_name, virtual_network_name, virtual_network_peering_name, virtual_network_peering_parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkPeering or ClientRawResponse<VirtualNetworkPeering> if raw==True

Return type

AzureOperationPoller[VirtualNetworkPeering] or AzureOperationPoller[ClientRawResponse[VirtualNetworkPeering]]

Raises

CloudError

delete(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

VirtualNetworkPeering or ClientRawResponse if raw=true

Return type

VirtualNetworkPeering or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkPeering

Return type

VirtualNetworkPeeringPaged[VirtualNetworkPeering]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>

class azure.mgmt.network.v2017_09_01.operations.VirtualNetworksOperations(client, config, serializer, deserializer)

Bases: object

VirtualNetworksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

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

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

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_config – Operation configuration overrides.

Returns

IPAddressAvailabilityResult or ClientRawResponse if raw=true

Return type

IPAddressAvailabilityResult or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, virtual_network_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetwork or ClientRawResponse<VirtualNetwork> if raw==True

Return type

AzureOperationPoller[VirtualNetwork] or AzureOperationPoller[ClientRawResponse[VirtualNetwork]]

Raises

CloudError

delete(resource_group_name, virtual_network_name, custom_headers=None, raw=False, polling=True, **operation_config)

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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

VirtualNetwork or ClientRawResponse if raw=true

Return type

VirtualNetwork or ClientRawResponse

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetwork

Return type

VirtualNetworkPaged[VirtualNetwork]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)

Gets all virtual networks in a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetwork

Return type

VirtualNetworkPaged[VirtualNetwork]

Raises

CloudError

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

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_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkUsage

Return type

VirtualNetworkUsagePaged[VirtualNetworkUsage]

Raises

CloudError

update_tags(resource_group_name, virtual_network_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)

Updates a virtual network tags.

Parameters

• resource_group_name (str) – The name of the resource group.

• virtual_network_name (str) – The name of the virtual network.

• tags (dict[str, str]) – Resource tags.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetwork or ClientRawResponse<VirtualNetwork> if raw==True

Return type

AzureOperationPoller[VirtualNetwork] or AzureOperationPoller[ClientRawResponse[VirtualNetwork]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2017_09_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2017_09_01/models/__init__.py'>