azure.mgmt.network.v2017_08_01.operations module¶

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

Bases: object

ApplicationGatewaysOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_backend_health(resource_group_name: str, application_gateway_name: str, expand: Optional[str] = None, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.
expand (str) – Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApplicationGatewayBackendHealth or the result of cls(response)

Return type

LROPoller[ApplicationGatewayBackendHealth]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, application_gateway_name: str, parameters: ‘models.ApplicationGateway’, **kwargs: Any) → LROPoller[source]¶

Creates or updates the specified application gateway.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.
parameters (ApplicationGateway) – Parameters supplied to the create or update application gateway operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApplicationGateway or the result of cls(response)

Return type

LROPoller[ApplicationGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified application gateway.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_start(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → LROPoller[source]¶

Starts the specified application gateway.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_stop(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → LROPoller[source]¶

Stops the specified application gateway in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → ’models.ApplicationGateway’[source]¶

Gets the specified application gateway.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApplicationGateway, or the result of cls(response)

Return type

ApplicationGateway

Raises

~azure.core.exceptions.HttpResponseError

get_ssl_predefined_policy(predefined_policy_name: str, **kwargs: Any) → ’models.ApplicationGatewaySslPredefinedPolicy’[source]¶

Gets Ssl predefined policy with the specified policy name.

Parameters: predefined_policy_name (str) – Name of Ssl predefined policy.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ApplicationGatewaySslPredefinedPolicy, or the result of cls(response)
Return type: ApplicationGatewaySslPredefinedPolicy
Raises: ~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ApplicationGatewayListResult’][source]¶

Lists all application gateways in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ApplicationGatewayListResult or the result of cls(response)
Return type: ItemPaged[ApplicationGatewayListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.ApplicationGatewayListResult’][source]¶

Gets all the application gateways in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ApplicationGatewayListResult or the result of cls(response)
Return type: ItemPaged[ApplicationGatewayListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_available_ssl_options(**kwargs: Any) → ’models.ApplicationGatewayAvailableSslOptions’[source]¶

Lists available Ssl options for configuring Ssl policy.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ApplicationGatewayAvailableSslOptions, or the result of cls(response)
Return type: ApplicationGatewayAvailableSslOptions
Raises: ~azure.core.exceptions.HttpResponseError

list_available_ssl_predefined_policies(**kwargs: Any) → Iterable[‘models.ApplicationGatewayAvailableSslPredefinedPolicies’][source]¶

Lists all SSL predefined policies for configuring Ssl policy.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ApplicationGatewayAvailableSslPredefinedPolicies or the result of cls(response)
Return type: ItemPaged[ApplicationGatewayAvailableSslPredefinedPolicies]
Raises: ~azure.core.exceptions.HttpResponseError

list_available_waf_rule_sets(**kwargs: Any) → ’models.ApplicationGatewayAvailableWafRuleSetsResult’[source]¶

Lists all available web application firewall rule sets.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ApplicationGatewayAvailableWafRuleSetsResult, or the result of cls(response)
Return type: ApplicationGatewayAvailableWafRuleSetsResult
Raises: ~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.AvailableEndpointServicesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AvailableEndpointServicesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(location: str, **kwargs: Any) → Iterable[‘models.EndpointServicesListResult’][source]¶

List what values of endpoint services are available for use.

Parameters: location (str) – The location to check available endpoint services.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either EndpointServicesListResult or the result of cls(response)
Return type: ItemPaged[EndpointServicesListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

BgpServiceCommunitiesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘models.BgpServiceCommunityListResult’][source]¶

Gets all the available bgp service communities.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either BgpServiceCommunityListResult or the result of cls(response)
Return type: ItemPaged[BgpServiceCommunityListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.DefaultSecurityRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DefaultSecurityRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, network_security_group_name: str, default_security_rule_name: str, **kwargs: Any) → ’models.SecurityRule’[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityRule, or the result of cls(response)

Return type

SecurityRule

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, network_security_group_name: str, **kwargs: Any) → Iterable[‘models.SecurityRuleListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SecurityRuleListResult or the result of cls(response)

Return type

ItemPaged[SecurityRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

ExpressRouteCircuitAuthorizationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, circuit_name: str, authorization_name: str, authorization_parameters: ‘models.ExpressRouteCircuitAuthorization’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param circuit_name

The name of the express route circuit.

type circuit_name

str

param authorization_name

The name of the authorization.

type authorization_name

str

param authorization_parameters

Parameters supplied to the create or update express route

circuit authorization operation.

type authorization_parameters: ~azure.mgmt.network.v2017_08_01.models.ExpressRouteCircuitAuthorization
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either ExpressRouteCircuitAuthorization or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ExpressRouteCircuitAuthorization]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, circuit_name: str, authorization_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified authorization from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
authorization_name (str) – The name of the authorization.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, circuit_name: str, authorization_name: str, **kwargs: Any) → ’models.ExpressRouteCircuitAuthorization’[source]¶

Gets the specified authorization from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
authorization_name (str) – The name of the authorization.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuitAuthorization, or the result of cls(response)

Return type

ExpressRouteCircuitAuthorization

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, circuit_name: str, **kwargs: Any) → Iterable[‘models.AuthorizationListResult’][source]¶

Gets all authorizations in an express route circuit.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AuthorizationListResult or the result of cls(response)

Return type

ItemPaged[AuthorizationListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

ExpressRouteCircuitPeeringsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, circuit_name: str, peering_name: str, peering_parameters: ‘models.ExpressRouteCircuitPeering’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param circuit_name

The name of the express route circuit.

type circuit_name

str

param peering_name

The name of the peering.

type peering_name

str

param peering_parameters

Parameters supplied to the create or update express route circuit

peering operation.

type peering_parameters: ~azure.mgmt.network.v2017_08_01.models.ExpressRouteCircuitPeering
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either ExpressRouteCircuitPeering or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ExpressRouteCircuitPeering]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified peering from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → ’models.ExpressRouteCircuitPeering’[source]¶

Gets the specified authorization from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuitPeering, or the result of cls(response)

Return type

ExpressRouteCircuitPeering

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, circuit_name: str, **kwargs: Any) → Iterable[‘models.ExpressRouteCircuitPeeringListResult’][source]¶

Gets all peerings in a specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ExpressRouteCircuitPeeringListResult or the result of cls(response)

Return type

ItemPaged[ExpressRouteCircuitPeeringListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

ExpressRouteCircuitsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, circuit_name: str, parameters: ‘models.ExpressRouteCircuit’, **kwargs: Any) → LROPoller[source]¶

Creates or updates an express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the circuit.
parameters (ExpressRouteCircuit) – Parameters supplied to the create or update express route circuit operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ExpressRouteCircuit or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuit]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, circuit_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_list_arp_table(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param circuit_name

The name of the express route circuit.

type circuit_name

str

param peering_name

The name of the peering.

type peering_name

str

param device_path

The path of the device.

type device_path

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either ExpressRouteCircuitsArpTableListResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ExpressRouteCircuitsArpTableListResult]

raises ~azure.core.exceptions.HttpResponseError

begin_list_routes_table(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param circuit_name

The name of the express route circuit.

type circuit_name

str

param peering_name

The name of the peering.

type peering_name

str

param device_path

The path of the device.

type device_path

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either ExpressRouteCircuitsRoutesTableListResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ExpressRouteCircuitsRoutesTableListResult]

raises ~azure.core.exceptions.HttpResponseError

begin_list_routes_table_summary(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param circuit_name

The name of the express route circuit.

type circuit_name

str

param peering_name

The name of the peering.

type peering_name

str

param device_path

The path of the device.

type device_path

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either ExpressRouteCircuitsRoutesTableSummaryListResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ExpressRouteCircuitsRoutesTableSummaryListResult]

raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, circuit_name: str, **kwargs: Any) → ’models.ExpressRouteCircuit’[source]¶

Gets information about the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of express route circuit.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuit, or the result of cls(response)

Return type

ExpressRouteCircuit

Raises

~azure.core.exceptions.HttpResponseError

get_peering_stats(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → ’models.ExpressRouteCircuitStats’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuitStats, or the result of cls(response)

Return type

ExpressRouteCircuitStats

Raises

~azure.core.exceptions.HttpResponseError

get_stats(resource_group_name: str, circuit_name: str, **kwargs: Any) → ’models.ExpressRouteCircuitStats’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuitStats, or the result of cls(response)

Return type

ExpressRouteCircuitStats

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ExpressRouteCircuitListResult’][source]¶

Gets all the express route circuits in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ExpressRouteCircuitListResult or the result of cls(response)
Return type: ItemPaged[ExpressRouteCircuitListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.ExpressRouteCircuitListResult’][source]¶

Gets all the express route circuits in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ExpressRouteCircuitListResult or the result of cls(response)
Return type: ItemPaged[ExpressRouteCircuitListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

ExpressRouteServiceProvidersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘models.ExpressRouteServiceProviderListResult’][source]¶

Gets all the available express route service providers.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ExpressRouteServiceProviderListResult or the result of cls(response)
Return type: ItemPaged[ExpressRouteServiceProviderListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.InboundNatRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

InboundNatRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, load_balancer_name: str, inbound_nat_rule_name: str, inbound_nat_rule_parameters: ‘models.InboundNatRule’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a load balancer inbound nat rule.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param load_balancer_name

The name of the load balancer.

type load_balancer_name

str

param inbound_nat_rule_name

The name of the inbound nat rule.

type inbound_nat_rule_name

str

param inbound_nat_rule_parameters

Parameters supplied to the create or update inbound nat

rule operation.

type inbound_nat_rule_parameters: ~azure.mgmt.network.v2017_08_01.models.InboundNatRule
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either InboundNatRule or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.InboundNatRule]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, load_balancer_name: str, inbound_nat_rule_name: str, **kwargs: Any) → LROPoller[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, load_balancer_name: str, inbound_nat_rule_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.InboundNatRule’[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

InboundNatRule, or the result of cls(response)

Return type

InboundNatRule

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[‘models.InboundNatRuleListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either InboundNatRuleListResult or the result of cls(response)

Return type

ItemPaged[InboundNatRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.LoadBalancerBackendAddressPoolsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerBackendAddressPoolsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, load_balancer_name: str, backend_address_pool_name: str, **kwargs: Any) → ’models.BackendAddressPool’[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BackendAddressPool, or the result of cls(response)

Return type

BackendAddressPool

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[‘models.LoadBalancerBackendAddressPoolListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LoadBalancerBackendAddressPoolListResult or the result of cls(response)

Return type

ItemPaged[LoadBalancerBackendAddressPoolListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.LoadBalancerFrontendIPConfigurationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerFrontendIPConfigurationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, load_balancer_name: str, frontend_ip_configuration_name: str, **kwargs: Any) → ’models.FrontendIPConfiguration’[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FrontendIPConfiguration, or the result of cls(response)

Return type

FrontendIPConfiguration

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[‘models.LoadBalancerFrontendIPConfigurationListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LoadBalancerFrontendIPConfigurationListResult or the result of cls(response)

Return type

ItemPaged[LoadBalancerFrontendIPConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.LoadBalancerLoadBalancingRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerLoadBalancingRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, load_balancer_name: str, load_balancing_rule_name: str, **kwargs: Any) → ’models.LoadBalancingRule’[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LoadBalancingRule, or the result of cls(response)

Return type

LoadBalancingRule

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[‘models.LoadBalancerLoadBalancingRuleListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LoadBalancerLoadBalancingRuleListResult or the result of cls(response)

Return type

ItemPaged[LoadBalancerLoadBalancingRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.LoadBalancerNetworkInterfacesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerNetworkInterfacesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[‘models.NetworkInterfaceListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NetworkInterfaceListResult or the result of cls(response)

Return type

ItemPaged[NetworkInterfaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.LoadBalancerProbesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerProbesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, load_balancer_name: str, probe_name: str, **kwargs: Any) → ’models.Probe’[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Probe, or the result of cls(response)

Return type

Probe

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[‘models.LoadBalancerProbeListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LoadBalancerProbeListResult or the result of cls(response)

Return type

ItemPaged[LoadBalancerProbeListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

LoadBalancersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, load_balancer_name: str, parameters: ‘models.LoadBalancer’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
parameters (LoadBalancer) – Parameters supplied to the create or update load balancer operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LoadBalancer or the result of cls(response)

Return type

LROPoller[LoadBalancer]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, load_balancer_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.LoadBalancer’[source]¶

Gets the specified load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LoadBalancer, or the result of cls(response)

Return type

LoadBalancer

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.LoadBalancerListResult’][source]¶

Gets all the load balancers in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LoadBalancerListResult or the result of cls(response)
Return type: ItemPaged[LoadBalancerListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.LoadBalancerListResult’][source]¶

Gets all the load balancers in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LoadBalancerListResult or the result of cls(response)
Return type: ItemPaged[LoadBalancerListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

LocalNetworkGatewaysOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, local_network_gateway_name: str, parameters: ‘models.LocalNetworkGateway’, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.
parameters (LocalNetworkGateway) – Parameters supplied to the create or update local network gateway operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LocalNetworkGateway or the result of cls(response)

Return type

LROPoller[LocalNetworkGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, local_network_gateway_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified local network gateway.

Parameters

resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, local_network_gateway_name: str, **kwargs: Any) → ’models.LocalNetworkGateway’[source]¶

Gets the specified local network gateway in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LocalNetworkGateway, or the result of cls(response)

Return type

LocalNetworkGateway

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.LocalNetworkGatewayListResult’][source]¶

Gets all the local network gateways in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LocalNetworkGatewayListResult or the result of cls(response)
Return type: ItemPaged[LocalNetworkGatewayListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.NetworkInterfaceIPConfigurationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkInterfaceIPConfigurationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, network_interface_name: str, ip_configuration_name: str, **kwargs: Any) → ’models.NetworkInterfaceIPConfiguration’[source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkInterfaceIPConfiguration, or the result of cls(response)

Return type

NetworkInterfaceIPConfiguration

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, network_interface_name: str, **kwargs: Any) → Iterable[‘models.NetworkInterfaceIPConfigurationListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NetworkInterfaceIPConfigurationListResult or the result of cls(response)

Return type

ItemPaged[NetworkInterfaceIPConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.NetworkInterfaceLoadBalancersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkInterfaceLoadBalancersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(resource_group_name: str, network_interface_name: str, **kwargs: Any) → Iterable[‘models.NetworkInterfaceLoadBalancerListResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NetworkInterfaceLoadBalancerListResult or the result of cls(response)

Return type

ItemPaged[NetworkInterfaceLoadBalancerListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

NetworkInterfacesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, network_interface_name: str, parameters: ‘models.NetworkInterface’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
parameters (NetworkInterface) – Parameters supplied to the create or update network interface operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either NetworkInterface or the result of cls(response)

Return type

LROPoller[NetworkInterface]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_interface_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_get_effective_route_table(resource_group_name: str, network_interface_name: str, **kwargs: Any) → LROPoller[source]¶

Gets all route tables applied to a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either EffectiveRouteListResult or the result of cls(response)

Return type

LROPoller[EffectiveRouteListResult]

Raises

HttpResponseError –

begin_list_effective_network_security_groups(resource_group_name: str, network_interface_name: str, **kwargs: Any) → LROPoller[source]¶

Gets all network security groups applied to a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either EffectiveNetworkSecurityGroupListResult or the result of cls(response)

Return type

LROPoller[EffectiveNetworkSecurityGroupListResult]

Raises

HttpResponseError –

get(resource_group_name: str, network_interface_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.NetworkInterface’[source]¶

Gets information about the specified network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkInterface, or the result of cls(response)

Return type

NetworkInterface

Raises

~azure.core.exceptions.HttpResponseError

get_virtual_machine_scale_set_network_interface(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.NetworkInterface’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkInterface, or the result of cls(response)

Return type

NetworkInterface

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.NetworkInterfaceListResult’][source]¶

Gets all network interfaces in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NetworkInterfaceListResult or the result of cls(response)
Return type: ItemPaged[NetworkInterfaceListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.NetworkInterfaceListResult’][source]¶

Gets all network interfaces in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NetworkInterfaceListResult or the result of cls(response)
Return type: ItemPaged[NetworkInterfaceListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_virtual_machine_scale_set_network_interfaces(resource_group_name: str, virtual_machine_scale_set_name: str, **kwargs: Any) → Iterable[‘models.NetworkInterfaceListResult’][source]¶

Gets all network interfaces in a virtual machine scale set.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NetworkInterfaceListResult or the result of cls(response)

Return type

ItemPaged[NetworkInterfaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_virtual_machine_scale_set_vm_network_interfaces(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, **kwargs: Any) → Iterable[‘models.NetworkInterfaceListResult’][source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_machine_scale_set_name

The name of the virtual machine scale set.

type virtual_machine_scale_set_name

str

param virtualmachine_index

The virtual machine index.

type virtualmachine_index

str

keyword callable cls

A custom type or function that will be passed the direct response

return

An iterator like instance of either NetworkInterfaceListResult or the result of cls(response)

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.network.v2017_08_01.models.NetworkInterfaceListResult]

raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.network.v2017_08_01.operations.NetworkManagementClientOperationsMixin[source]¶

Bases: object

check_dns_name_availability(location: str, domain_name_label: str, **kwargs: Any) → ’models.DnsNameAvailabilityResult’[source]¶

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]$.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DnsNameAvailabilityResult, or the result of cls(response)

Return type

DnsNameAvailabilityResult

Raises

~azure.core.exceptions.HttpResponseError

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

Bases: object

NetworkSecurityGroupsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, network_security_group_name: str, parameters: ‘models.NetworkSecurityGroup’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param network_security_group_name

The name of the network security group.

type network_security_group_name

str

param parameters

Parameters supplied to the create or update network security group

operation.

type parameters: ~azure.mgmt.network.v2017_08_01.models.NetworkSecurityGroup
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either NetworkSecurityGroup or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.NetworkSecurityGroup]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, network_security_group_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified network security group.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, network_security_group_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.NetworkSecurityGroup’[source]¶

Gets the specified network security group.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkSecurityGroup, or the result of cls(response)

Return type

NetworkSecurityGroup

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.NetworkSecurityGroupListResult’][source]¶

Gets all network security groups in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NetworkSecurityGroupListResult or the result of cls(response)
Return type: ItemPaged[NetworkSecurityGroupListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.NetworkSecurityGroupListResult’][source]¶

Gets all network security groups in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NetworkSecurityGroupListResult or the result of cls(response)
Return type: ItemPaged[NetworkSecurityGroupListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

NetworkWatchersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_check_connectivity(resource_group_name: str, network_watcher_name: str, parameters: ‘models.ConnectivityParameters’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the network watcher resource group.

type resource_group_name

str

param network_watcher_name

The name of the network watcher resource.

type network_watcher_name

str

param parameters

Parameters that determine how the connectivity check will be performed.

type parameters

~azure.mgmt.network.v2017_08_01.models.ConnectivityParameters

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either ConnectivityInformation or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ConnectivityInformation]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified network watcher resource.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_get_flow_log_status(resource_group_name: str, network_watcher_name: str, parameters: ‘models.FlowLogStatusParameters’, **kwargs: Any) → LROPoller[source]¶

Queries status of flow log on a specified resource.

Parameters

resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (FlowLogStatusParameters) – Parameters that define a resource to query flow log status.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FlowLogInformation or the result of cls(response)

Return type

LROPoller[FlowLogInformation]

Raises

HttpResponseError –

begin_get_next_hop(resource_group_name: str, network_watcher_name: str, parameters: ‘models.NextHopParameters’, **kwargs: Any) → LROPoller[source]¶

Gets the next hop from the specified VM.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (NextHopParameters) – Parameters that define the source and destination endpoint.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either NextHopResult or the result of cls(response)

Return type

LROPoller[NextHopResult]

Raises

HttpResponseError –

begin_get_troubleshooting(resource_group_name: str, network_watcher_name: str, parameters: ‘models.TroubleshootingParameters’, **kwargs: Any) → LROPoller[source]¶

Initiate troubleshooting on a specified resource.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (TroubleshootingParameters) – Parameters that define the resource to troubleshoot.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either TroubleshootingResult or the result of cls(response)

Return type

LROPoller[TroubleshootingResult]

Raises

HttpResponseError –

begin_get_troubleshooting_result(resource_group_name: str, network_watcher_name: str, parameters: ‘models.QueryTroubleshootingParameters’, **kwargs: Any) → LROPoller[source]¶

Get the last completed troubleshooting result on a specified resource.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (QueryTroubleshootingParameters) – Parameters that define the resource to query the troubleshooting result.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either TroubleshootingResult or the result of cls(response)

Return type

LROPoller[TroubleshootingResult]

Raises

HttpResponseError –

begin_get_vm_security_rules(resource_group_name: str, network_watcher_name: str, parameters: ‘models.SecurityGroupViewParameters’, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (SecurityGroupViewParameters) – Parameters that define the VM to check security groups for.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SecurityGroupViewResult or the result of cls(response)

Return type

LROPoller[SecurityGroupViewResult]

Raises

HttpResponseError –

begin_set_flow_log_configuration(resource_group_name: str, network_watcher_name: str, parameters: ‘models.FlowLogInformation’, **kwargs: Any) → LROPoller[source]¶

Configures flow log on a specified resource.

Parameters

resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (FlowLogInformation) – Parameters that define the configuration of flow log.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FlowLogInformation or the result of cls(response)

Return type

LROPoller[FlowLogInformation]

Raises

HttpResponseError –

begin_verify_ip_flow(resource_group_name: str, network_watcher_name: str, parameters: ‘models.VerificationIPFlowParameters’, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (VerificationIPFlowParameters) – Parameters that define the IP flow to be verified.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VerificationIPFlowResult or the result of cls(response)

Return type

LROPoller[VerificationIPFlowResult]

Raises

HttpResponseError –

create_or_update(resource_group_name: str, network_watcher_name: str, parameters: ‘models.NetworkWatcher’, **kwargs: Any) → ’models.NetworkWatcher’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (NetworkWatcher) – Parameters that define the network watcher resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkWatcher, or the result of cls(response)

Return type

NetworkWatcher

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → ’models.NetworkWatcher’[source]¶

Gets the specified network watcher by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkWatcher, or the result of cls(response)

Return type

NetworkWatcher

Raises

~azure.core.exceptions.HttpResponseError

get_topology(resource_group_name: str, network_watcher_name: str, parameters: ‘models.TopologyParameters’, **kwargs: Any) → ’models.Topology’[source]¶

Gets the current network topology by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (TopologyParameters) – Parameters that define the representation of topology.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Topology, or the result of cls(response)

Return type

Topology

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.NetworkWatcherListResult’][source]¶

Gets all network watchers by resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NetworkWatcherListResult or the result of cls(response)
Return type: ItemPaged[NetworkWatcherListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.NetworkWatcherListResult’][source]¶

Gets all network watchers by subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NetworkWatcherListResult or the result of cls(response)
Return type: ItemPaged[NetworkWatcherListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

PacketCapturesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, parameters: ‘models.PacketCapture’, **kwargs: Any) → LROPoller[source]¶

Create and start a packet capture on the specified VM.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.
parameters (PacketCapture) – Parameters that define the create packet capture operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PacketCaptureResult or the result of cls(response)

Return type

LROPoller[PacketCaptureResult]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified packet capture session.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_get_status(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → LROPoller[source]¶

Query the status of a running packet capture session.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the Network Watcher resource.
packet_capture_name (str) – The name given to the packet capture session.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PacketCaptureQueryStatusResult or the result of cls(response)

Return type

LROPoller[PacketCaptureQueryStatusResult]

Raises

HttpResponseError –

begin_stop(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → LROPoller[source]¶

Stops a specified packet capture session.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → ’models.PacketCaptureResult’[source]¶

Gets a packet capture session by name.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PacketCaptureResult, or the result of cls(response)

Return type

PacketCaptureResult

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → Iterable[‘models.PacketCaptureListResult’][source]¶

Lists all packet capture sessions within the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the Network Watcher resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PacketCaptureListResult or the result of cls(response)

Return type

ItemPaged[PacketCaptureListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

PublicIPAddressesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, public_ip_address_name: str, parameters: ‘models.PublicIPAddress’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a static or dynamic public IP address.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_address_name (str) – The name of the public IP address.
parameters (PublicIPAddress) – Parameters supplied to the create or update public IP address operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PublicIPAddress or the result of cls(response)

Return type

LROPoller[PublicIPAddress]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, public_ip_address_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified public IP address.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, public_ip_address_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.PublicIPAddress’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_address_name (str) – The name of the subnet.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PublicIPAddress, or the result of cls(response)

Return type

PublicIPAddress

Raises

~azure.core.exceptions.HttpResponseError

get_virtual_machine_scale_set_public_ip_address(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, ip_configuration_name: str, public_ip_address_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.PublicIPAddress’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
ip_configuration_name (str) – The name of the IP configuration.
public_ip_address_name (str) – The name of the public IP Address.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PublicIPAddress, or the result of cls(response)

Return type

PublicIPAddress

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.PublicIPAddressListResult’][source]¶

Gets all public IP addresses in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either PublicIPAddressListResult or the result of cls(response)
Return type: ItemPaged[PublicIPAddressListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.PublicIPAddressListResult’][source]¶

Gets all the public IP addresses in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either PublicIPAddressListResult or the result of cls(response)
Return type: ItemPaged[PublicIPAddressListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_virtual_machine_scale_set_public_ip_addresses(resource_group_name: str, virtual_machine_scale_set_name: str, **kwargs: Any) → Iterable[‘models.PublicIPAddressListResult’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublicIPAddressListResult or the result of cls(response)

Return type

ItemPaged[PublicIPAddressListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_virtual_machine_scale_set_vm_public_ip_addresses(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, ip_configuration_name: str, **kwargs: Any) → Iterable[‘models.PublicIPAddressListResult’][source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_machine_scale_set_name

The name of the virtual machine scale set.

type virtual_machine_scale_set_name

str

param virtualmachine_index

The virtual machine index.

type virtualmachine_index

str

param network_interface_name

The network interface name.

type network_interface_name

str

param ip_configuration_name

The IP configuration name.

type ip_configuration_name

str

keyword callable cls

A custom type or function that will be passed the direct response

return

An iterator like instance of either PublicIPAddressListResult or the result of cls(response)

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.network.v2017_08_01.models.PublicIPAddressListResult]

raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

RouteFilterRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, route_filter_name: str, rule_name: str, route_filter_rule_parameters: ‘models.RouteFilterRule’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a route in the specified route filter.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param route_filter_name

The name of the route filter.

type route_filter_name

str

param rule_name

The name of the route filter rule.

type rule_name

str

param route_filter_rule_parameters

Parameters supplied to the create or update route filter

rule operation.

type route_filter_rule_parameters: ~azure.mgmt.network.v2017_08_01.models.RouteFilterRule
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either RouteFilterRule or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.RouteFilterRule]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, route_filter_name: str, rule_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified rule from a route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
rule_name (str) – The name of the rule.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, route_filter_name: str, rule_name: str, route_filter_rule_parameters: ‘models.PatchRouteFilterRule’, **kwargs: Any) → LROPoller[source]¶

Updates a route in the specified route filter.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param route_filter_name

The name of the route filter.

type route_filter_name

str

param rule_name

The name of the route filter rule.

type rule_name

str

param route_filter_rule_parameters

Parameters supplied to the update route filter rule

operation.

type route_filter_rule_parameters: ~azure.mgmt.network.v2017_08_01.models.PatchRouteFilterRule
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either RouteFilterRule or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.RouteFilterRule]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, route_filter_name: str, rule_name: str, **kwargs: Any) → ’models.RouteFilterRule’[source]¶

Gets the specified rule from a route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
rule_name (str) – The name of the rule.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RouteFilterRule, or the result of cls(response)

Return type

RouteFilterRule

Raises

~azure.core.exceptions.HttpResponseError

list_by_route_filter(resource_group_name: str, route_filter_name: str, **kwargs: Any) → Iterable[‘models.RouteFilterRuleListResult’][source]¶

Gets all RouteFilterRules in a route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RouteFilterRuleListResult or the result of cls(response)

Return type

ItemPaged[RouteFilterRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

RouteFiltersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, route_filter_name: str, route_filter_parameters: ‘models.RouteFilter’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param route_filter_name

The name of the route filter.

type route_filter_name

str

param route_filter_parameters

Parameters supplied to the create or update route filter

operation.

type route_filter_parameters: ~azure.mgmt.network.v2017_08_01.models.RouteFilter
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either RouteFilter or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.RouteFilter]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, route_filter_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, route_filter_name: str, route_filter_parameters: ‘models.PatchRouteFilter’, **kwargs: Any) → LROPoller[source]¶

Updates a route filter in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
route_filter_parameters (PatchRouteFilter) – Parameters supplied to the update route filter operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either RouteFilter or the result of cls(response)

Return type

LROPoller[RouteFilter]

Raises

HttpResponseError –

get(resource_group_name: str, route_filter_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.RouteFilter’[source]¶

Gets the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
expand (str) – Expands referenced express route bgp peering resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RouteFilter, or the result of cls(response)

Return type

RouteFilter

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.RouteFilterListResult’][source]¶

Gets all route filters in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RouteFilterListResult or the result of cls(response)
Return type: ItemPaged[RouteFilterListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.RouteFilterListResult’][source]¶

Gets all route filters in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RouteFilterListResult or the result of cls(response)
Return type: ItemPaged[RouteFilterListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

RouteTablesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, route_table_name: str, parameters: ‘models.RouteTable’, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
parameters (RouteTable) – Parameters supplied to the create or update route table operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either RouteTable or the result of cls(response)

Return type

LROPoller[RouteTable]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, route_table_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, route_table_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.RouteTable’[source]¶

Gets the specified route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RouteTable, or the result of cls(response)

Return type

RouteTable

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.RouteTableListResult’][source]¶

Gets all route tables in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RouteTableListResult or the result of cls(response)
Return type: ItemPaged[RouteTableListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.RouteTableListResult’][source]¶

Gets all route tables in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RouteTableListResult or the result of cls(response)
Return type: ItemPaged[RouteTableListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

RoutesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, route_table_name: str, route_name: str, route_parameters: ‘models.Route’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a route in the specified route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
route_name (str) – The name of the route.
route_parameters (Route) – Parameters supplied to the create or update route operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Route or the result of cls(response)

Return type

LROPoller[Route]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, route_table_name: str, route_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified route from a route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
route_name (str) – The name of the route.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, route_table_name: str, route_name: str, **kwargs: Any) → ’models.Route’[source]¶

Gets the specified route from a route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
route_name (str) – The name of the route.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Route, or the result of cls(response)

Return type

Route

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, route_table_name: str, **kwargs: Any) → Iterable[‘models.RouteListResult’][source]¶

Gets all routes in a route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RouteListResult or the result of cls(response)

Return type

ItemPaged[RouteListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

SecurityRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, network_security_group_name: str, security_rule_name: str, security_rule_parameters: ‘models.SecurityRule’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param network_security_group_name

The name of the network security group.

type network_security_group_name

str

param security_rule_name

The name of the security rule.

type security_rule_name

str

param security_rule_parameters

Parameters supplied to the create or update network security

rule operation.

type security_rule_parameters: ~azure.mgmt.network.v2017_08_01.models.SecurityRule
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either SecurityRule or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.SecurityRule]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, network_security_group_name: str, security_rule_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified network security rule.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
security_rule_name (str) – The name of the security rule.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, network_security_group_name: str, security_rule_name: str, **kwargs: Any) → ’models.SecurityRule’[source]¶

Get the specified network security rule.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
security_rule_name (str) – The name of the security rule.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityRule, or the result of cls(response)

Return type

SecurityRule

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, network_security_group_name: str, **kwargs: Any) → Iterable[‘models.SecurityRuleListResult’][source]¶

Gets all security rules in a network security group.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SecurityRuleListResult or the result of cls(response)

Return type

ItemPaged[SecurityRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

SubnetsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, subnet_name: str, subnet_parameters: ‘models.Subnet’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a subnet in the specified virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
subnet_name (str) – The name of the subnet.
subnet_parameters (Subnet) – Parameters supplied to the create or update subnet operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Subnet or the result of cls(response)

Return type

LROPoller[Subnet]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_name: str, subnet_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified subnet.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
subnet_name (str) – The name of the subnet.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_network_name: str, subnet_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.Subnet’[source]¶

Gets the specified subnet by virtual network and resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
subnet_name (str) – The name of the subnet.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Subnet, or the result of cls(response)

Return type

Subnet

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → Iterable[‘models.SubnetListResult’][source]¶

Gets all subnets in a virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SubnetListResult or the result of cls(response)

Return type

ItemPaged[SubnetListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

UsagesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(location: str, **kwargs: Any) → Iterable[‘models.UsagesListResult’][source]¶

List network usages for a subscription.

Parameters: location (str) – The location where resource usage is queried.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either UsagesListResult or the result of cls(response)
Return type: ItemPaged[UsagesListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

Bases: object

VirtualNetworkGatewayConnectionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: ‘models.VirtualNetworkGatewayConnection’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_connection_name

The name of the virtual network gateway

connection.

type virtual_network_gateway_connection_name: str
param parameters: Parameters supplied to the create or update virtual network gateway

connection operation.

type parameters: ~azure.mgmt.network.v2017_08_01.models.VirtualNetworkGatewayConnection
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either VirtualNetworkGatewayConnection or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.VirtualNetworkGatewayConnection]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified virtual network Gateway connection.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_connection_name

The name of the virtual network gateway

connection.

type virtual_network_gateway_connection_name: str
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either None or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[None]
raises ~azure.core.exceptions.HttpResponseError

begin_reset_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: ‘models.ConnectionResetSharedKey’, **kwargs: Any) → LROPoller[source]¶

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_connection_name

The virtual network gateway connection reset

shared key Name.

type virtual_network_gateway_connection_name

str

param parameters

Parameters supplied to the begin reset virtual network gateway connection

shared key operation through network resource provider.

type parameters

~azure.mgmt.network.v2017_08_01.models.ConnectionResetSharedKey

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either ConnectionResetSharedKey or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ConnectionResetSharedKey]

raises ~azure.core.exceptions.HttpResponseError

begin_set_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: ‘models.ConnectionSharedKey’, **kwargs: Any) → LROPoller[source]¶

The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_connection_name

The virtual network gateway connection name.

type virtual_network_gateway_connection_name

str

param parameters

Parameters supplied to the Begin Set Virtual Network Gateway connection

Shared key operation throughNetwork resource provider.

type parameters

~azure.mgmt.network.v2017_08_01.models.ConnectionSharedKey

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either ConnectionSharedKey or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.ConnectionSharedKey]

raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) → ’models.VirtualNetworkGatewayConnection’[source]¶

Gets the specified virtual network gateway connection by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetworkGatewayConnection, or the result of cls(response)

Return type

VirtualNetworkGatewayConnection

Raises

~azure.core.exceptions.HttpResponseError

get_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) → ’models.ConnectionSharedKey’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The virtual network gateway connection shared key name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ConnectionSharedKey, or the result of cls(response)

Return type

ConnectionSharedKey

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.VirtualNetworkGatewayConnectionListResult’][source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

keyword callable cls

A custom type or function that will be passed the direct response

return

An iterator like instance of either VirtualNetworkGatewayConnectionListResult or the result of cls(response)

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.network.v2017_08_01.models.VirtualNetworkGatewayConnectionListResult]

raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

VirtualNetworkGatewaysOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, virtual_network_gateway_name: str, parameters: ‘models.VirtualNetworkGateway’, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
parameters (VirtualNetworkGateway) – Parameters supplied to create or update virtual network gateway operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VirtualNetworkGateway or the result of cls(response)

Return type

LROPoller[VirtualNetworkGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified virtual network gateway.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_generate_vpn_profile(resource_group_name: str, virtual_network_gateway_name: str, parameters: ‘models.VpnClientParameters’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_name

The name of the virtual network gateway.

type virtual_network_gateway_name

str

param parameters

Parameters supplied to the generate virtual network gateway VPN client

package operation.

type parameters

~azure.mgmt.network.v2017_08_01.models.VpnClientParameters

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either str or the result of cls(response)

rtype

~azure.core.polling.LROPoller[str]

raises ~azure.core.exceptions.HttpResponseError

begin_generatevpnclientpackage(resource_group_name: str, virtual_network_gateway_name: str, parameters: ‘models.VpnClientParameters’, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_name

The name of the virtual network gateway.

type virtual_network_gateway_name

str

param parameters

Parameters supplied to the generate virtual network gateway VPN client

package operation.

type parameters

~azure.mgmt.network.v2017_08_01.models.VpnClientParameters

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either str or the result of cls(response)

rtype

~azure.core.polling.LROPoller[str]

raises ~azure.core.exceptions.HttpResponseError

begin_get_advertised_routes(resource_group_name: str, virtual_network_gateway_name: str, peer: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_name

The name of the virtual network gateway.

type virtual_network_gateway_name

str

param peer

The IP address of the peer.

type peer

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either GatewayRouteListResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.GatewayRouteListResult]

raises ~azure.core.exceptions.HttpResponseError

begin_get_bgp_peer_status(resource_group_name: str, virtual_network_gateway_name: str, peer: Optional[str] = None, **kwargs: Any) → LROPoller[source]¶

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
peer (str) – The IP address of the peer to retrieve the status of.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either BgpPeerStatusListResult or the result of cls(response)

Return type

LROPoller[BgpPeerStatusListResult]

Raises

HttpResponseError –

begin_get_learned_routes(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_name

The name of the virtual network gateway.

type virtual_network_gateway_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either GatewayRouteListResult or the result of cls(response)

rtype

~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.GatewayRouteListResult]

raises ~azure.core.exceptions.HttpResponseError

begin_get_vpn_profile_package_url(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → LROPoller[source]¶

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.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_name

The name of the virtual network gateway.

type virtual_network_gateway_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

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

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

An instance of LROPoller that returns either str or the result of cls(response)

rtype

~azure.core.polling.LROPoller[str]

raises ~azure.core.exceptions.HttpResponseError

begin_reset(resource_group_name: str, virtual_network_gateway_name: str, gateway_vip: Optional[str] = None, **kwargs: Any) → LROPoller[source]¶

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

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_gateway_name

The name of the virtual network gateway.

type virtual_network_gateway_name

str

param gateway_vip

Virtual network gateway vip address supplied to the begin reset of the

active-active feature enabled gateway.

type gateway_vip: str
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either VirtualNetworkGateway or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.VirtualNetworkGateway]
raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → ’models.VirtualNetworkGateway’[source]¶

Gets the specified virtual network gateway by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetworkGateway, or the result of cls(response)

Return type

VirtualNetworkGateway

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.VirtualNetworkGatewayListResult’][source]¶

Gets all virtual network gateways by resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either VirtualNetworkGatewayListResult or the result of cls(response)
Return type: ItemPaged[VirtualNetworkGatewayListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_connections(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → Iterable[‘models.VirtualNetworkGatewayListConnectionsResult’][source]¶

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VirtualNetworkGatewayListConnectionsResult or the result of cls(response)

Return type

ItemPaged[VirtualNetworkGatewayListConnectionsResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

VirtualNetworkPeeringsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, virtual_network_peering_parameters: ‘models.VirtualNetworkPeering’, **kwargs: Any) → LROPoller[source]¶

Creates or updates a peering in the specified virtual network.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param virtual_network_name

The name of the virtual network.

type virtual_network_name

str

param virtual_network_peering_name

The name of the peering.

type virtual_network_peering_name

str

param virtual_network_peering_parameters

Parameters supplied to the create or update virtual

network peering operation.

type virtual_network_peering_parameters: ~azure.mgmt.network.v2017_08_01.models.VirtualNetworkPeering
keyword callable cls: A custom type or function that will be passed the direct response
keyword str continuation_token: A continuation token to restart a poller from a saved state.
keyword polling: True for ARMPolling, False for no polling, or a polling object for personal polling strategy
paramtype polling: bool or ~azure.core.polling.PollingMethod
keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
return: An instance of LROPoller that returns either VirtualNetworkPeering or the result of cls(response)
rtype: ~azure.core.polling.LROPoller[~azure.mgmt.network.v2017_08_01.models.VirtualNetworkPeering]
raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified virtual network peering.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
virtual_network_peering_name (str) – The name of the virtual network peering.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, **kwargs: Any) → ’models.VirtualNetworkPeering’[source]¶

Gets the specified virtual network peering.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
virtual_network_peering_name (str) – The name of the virtual network peering.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetworkPeering, or the result of cls(response)

Return type

VirtualNetworkPeering

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → Iterable[‘models.VirtualNetworkPeeringListResult’][source]¶

Gets all virtual network peerings in a virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VirtualNetworkPeeringListResult or the result of cls(response)

Return type

ItemPaged[VirtualNetworkPeeringListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Bases: object

VirtualNetworksOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, parameters: ‘models.VirtualNetwork’, **kwargs: Any) → LROPoller[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
parameters (VirtualNetwork) – Parameters supplied to the create or update virtual network operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VirtualNetwork or the result of cls(response)

Return type

LROPoller[VirtualNetwork]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → LROPoller[source]¶

Deletes the specified virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

check_ip_address_availability(resource_group_name: str, virtual_network_name: str, ip_address: Optional[str] = None, **kwargs: Any) → ’models.IPAddressAvailabilityResult’[source]¶

Checks whether a private IP address is available for use.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
ip_address (str) – The private IP address to be verified.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IPAddressAvailabilityResult, or the result of cls(response)

Return type

IPAddressAvailabilityResult

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, virtual_network_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.VirtualNetwork’[source]¶

Gets the specified virtual network by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
expand (str) – Expands referenced resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetwork, or the result of cls(response)

Return type

VirtualNetwork

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, **kwargs: Any) → Iterable[‘models.VirtualNetworkListResult’][source]¶

Gets all virtual networks in a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either VirtualNetworkListResult or the result of cls(response)
Return type: ItemPaged[VirtualNetworkListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_all(**kwargs: Any) → Iterable[‘models.VirtualNetworkListResult’][source]¶

Gets all virtual networks in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either VirtualNetworkListResult or the result of cls(response)
Return type: ItemPaged[VirtualNetworkListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_usage(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → Iterable[‘models.VirtualNetworkListUsageResult’][source]¶

Lists usage stats.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VirtualNetworkListUsageResult or the result of cls(response)

Return type

ItemPaged[VirtualNetworkListUsageResult]

Raises

~azure.core.exceptions.HttpResponseError

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