azure.mgmt.network.v2019_02_01.operations module¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- Raises
-
begin_backend_health_on_demand
(resource_group_name: str, application_gateway_name: str, probe_request: ‘models.ApplicationGatewayOnDemandProbe’, expand: Optional[str] = None, **kwargs: Any) → LROPoller[source]¶ Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param application_gateway_name
The name of the application gateway.
- type application_gateway_name
str
- param probe_request
Request body for on-demand test probe operation.
- type probe_request
~azure.mgmt.network.v2019_02_01.models.ApplicationGatewayOnDemandProbe
- param expand
Expands BackendAddressPool and BackendHttpSettings referenced in backend health.
- type expand
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 ApplicationGatewayBackendHealthOnDemand or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ApplicationGatewayBackendHealthOnDemand]
- raises ~azure.core.exceptions.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
- Raises
-
begin_delete
(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified application gateway.
- Parameters
- 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
- Raises
-
begin_start
(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Starts the specified application gateway.
- Parameters
- 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
- Raises
-
begin_stop
(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Stops the specified application gateway in a resource group.
- Parameters
- 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
- Raises
Updates the specified application gateway tags.
- Parameters
resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.
parameters (TagsObject) – Parameters supplied to update application gateway tags.
- 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
- Raises
-
get
(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → ’models.ApplicationGateway’[source]¶ Gets the specified application gateway.
- Parameters
- 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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_available_request_headers
(**kwargs: Any) → List[str][source]¶ Lists all available request headers.
-
list_available_response_headers
(**kwargs: Any) → List[str][source]¶ Lists all available response headers.
-
list_available_server_variables
(**kwargs: Any) → List[str][source]¶ Lists all available server variables.
-
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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ApplicationSecurityGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ApplicationSecurityGroupsOperations 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, application_security_group_name: str, parameters: ‘models.ApplicationSecurityGroup’, **kwargs: Any) → LROPoller[source]¶ Creates or updates an application security group.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param application_security_group_name
The name of the application security group.
- type application_security_group_name
str
- param parameters
Parameters supplied to the create or update ApplicationSecurityGroup
- operation.
- type parameters
~azure.mgmt.network.v2019_02_01.models.ApplicationSecurityGroup
- 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 ApplicationSecurityGroup or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ApplicationSecurityGroup]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, application_security_group_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified application security group.
- Parameters
- 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
- Raises
Updates an application security group’s tags.
- Parameters
resource_group_name (str) – The name of the resource group.
application_security_group_name (str) – The name of the application security group.
parameters (TagsObject) – Parameters supplied to update application security group tags.
- 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 ApplicationSecurityGroup or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, application_security_group_name: str, **kwargs: Any) → ’models.ApplicationSecurityGroup’[source]¶ Gets information about the specified application security group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ApplicationSecurityGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ApplicationSecurityGroupListResult’][source]¶ Gets all the application 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 ApplicationSecurityGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_all
(**kwargs: Any) → Iterable[‘models.ApplicationSecurityGroupListResult’][source]¶ Gets all application 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 ApplicationSecurityGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
AvailableDelegationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AvailableDelegationsOperations 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.AvailableDelegationsResult’][source]¶ Gets all of the available subnet delegations for this subscription in this region.
- Parameters
location (str) – The location of the subnet.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AvailableDelegationsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
AvailableResourceGroupDelegationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AvailableResourceGroupDelegationsOperations 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, resource_group_name: str, **kwargs: Any) → Iterable[‘models.AvailableDelegationsResult’][source]¶ Gets all of the available subnet delegations for this resource group in this region.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AvailableDelegationsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
AzureFirewallFqdnTagsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AzureFirewallFqdnTagsOperations 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_all
(**kwargs: Any) → Iterable[‘models.AzureFirewallFqdnTagListResult’][source]¶ Gets all the Azure Firewall FQDN Tags 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 AzureFirewallFqdnTagListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
AzureFirewallsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AzureFirewallsOperations 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, azure_firewall_name: str, parameters: ‘models.AzureFirewall’, **kwargs: Any) → LROPoller[source]¶ Creates or updates the specified Azure Firewall.
- Parameters
resource_group_name (str) – The name of the resource group.
azure_firewall_name (str) – The name of the Azure Firewall.
parameters (AzureFirewall) – Parameters supplied to the create or update Azure Firewall 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 AzureFirewall or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, azure_firewall_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified Azure Firewall.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, azure_firewall_name: str, **kwargs: Any) → ’models.AzureFirewall’[source]¶ Gets the specified Azure Firewall.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AzureFirewall, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.AzureFirewallListResult’][source]¶ Lists all Azure Firewalls 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 AzureFirewallListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_all
(**kwargs: Any) → Iterable[‘models.AzureFirewallListResult’][source]¶ Gets all the Azure Firewalls 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 AzureFirewallListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ConnectionMonitorsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ConnectionMonitorsOperations 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_watcher_name: str, connection_monitor_name: str, parameters: ‘models.ConnectionMonitor’, **kwargs: Any) → LROPoller[source]¶ Create or update a connection monitor.
- Parameters
resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
connection_monitor_name (str) – The name of the connection monitor.
parameters (ConnectionMonitor) – Parameters that define the operation to create a connection monitor.
- 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 ConnectionMonitorResult or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified connection monitor.
- Parameters
- 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
- Raises
-
begin_query
(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → LROPoller[source]¶ Query a snapshot of the most recent connection states.
- Parameters
- 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 ConnectionMonitorQueryResult or the result of cls(response)
- Return type
- Raises
-
begin_start
(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → LROPoller[source]¶ Starts the specified connection monitor.
- Parameters
- 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
- Raises
-
begin_stop
(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → LROPoller[source]¶ Stops the specified connection monitor.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → ’models.ConnectionMonitorResult’[source]¶ Gets a connection monitor by name.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ConnectionMonitorResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → Iterable[‘models.ConnectionMonitorListResult’][source]¶ Lists all connection monitors for the specified Network Watcher.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ConnectionMonitorListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
DdosCustomPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DdosCustomPoliciesOperations 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, ddos_custom_policy_name: str, parameters: ‘models.DdosCustomPolicy’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a DDoS custom policy.
- Parameters
resource_group_name (str) – The name of the resource group.
ddos_custom_policy_name (str) – The name of the DDoS custom policy.
parameters (DdosCustomPolicy) – Parameters supplied to the create or update 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 DdosCustomPolicy or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, ddos_custom_policy_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified DDoS custom policy.
- Parameters
- 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
- Raises
Update a DDoS custom policy tags.
- Parameters
resource_group_name (str) – The name of the resource group.
ddos_custom_policy_name (str) – The name of the DDoS custom policy.
parameters (TagsObject) – Parameters supplied to the update DDoS custom policy resource tags.
- 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 DdosCustomPolicy or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, ddos_custom_policy_name: str, **kwargs: Any) → ’models.DdosCustomPolicy’[source]¶ Gets information about the specified DDoS custom policy.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DdosCustomPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
DdosProtectionPlansOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DdosProtectionPlansOperations 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, ddos_protection_plan_name: str, parameters: ‘models.DdosProtectionPlan’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a DDoS protection plan.
- Parameters
resource_group_name (str) – The name of the resource group.
ddos_protection_plan_name (str) – The name of the DDoS protection plan.
parameters (DdosProtectionPlan) – Parameters supplied to the create or update 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 DdosProtectionPlan or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, ddos_protection_plan_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified DDoS protection plan.
- Parameters
- 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
- Raises
Update a DDoS protection plan tags.
- Parameters
resource_group_name (str) – The name of the resource group.
ddos_protection_plan_name (str) – The name of the DDoS protection plan.
parameters (TagsObject) – Parameters supplied to the update DDoS protection plan resource tags.
- 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 DdosProtectionPlan or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, ddos_protection_plan_name: str, **kwargs: Any) → ’models.DdosProtectionPlan’[source]¶ Gets information about the specified DDoS protection plan.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DdosProtectionPlan, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.DdosProtectionPlanListResult’][source]¶ Gets all DDoS protection plans 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 DdosProtectionPlanListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.DdosProtectionPlanListResult’][source]¶ Gets all the DDoS protection plans 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 DdosProtectionPlanListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRouteCircuitConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRouteCircuitConnectionsOperations 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, connection_name: str, express_route_circuit_connection_parameters: ‘models.ExpressRouteCircuitConnection’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a Express Route Circuit Connection 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 connection_name
The name of the express route circuit connection.
- type connection_name
str
- param express_route_circuit_connection_parameters
Parameters supplied to the create or update
- express route circuit connection operation.
- type express_route_circuit_connection_parameters
~azure.mgmt.network.v2019_02_01.models.ExpressRouteCircuitConnection
- 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 ExpressRouteCircuitConnection or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ExpressRouteCircuitConnection]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, circuit_name: str, peering_name: str, connection_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified Express Route Circuit Connection from 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 peering_name
The name of the peering.
- type peering_name
str
- param connection_name
The name of the express route circuit connection.
- type 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
-
get
(resource_group_name: str, circuit_name: str, peering_name: str, connection_name: str, **kwargs: Any) → ’models.ExpressRouteCircuitConnection’[source]¶ Gets the specified Express Route Circuit Connection from the specified express route circuit.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteCircuitConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → Iterable[‘models.ExpressRouteCircuitConnectionListResult’][source]¶ Gets all global reach connections associated with a private peering in an 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 circuit.
- type circuit_name
str
- param peering_name
The name of the peering.
- type peering_name
str
- keyword callable cls
A custom type or function that will be passed the direct response
- return
An iterator like instance of either ExpressRouteCircuitConnectionListResult or the result of cls(response)
- rtype
~azure.core.paging.ItemPaged[~azure.mgmt.network.v2019_02_01.models.ExpressRouteCircuitConnectionListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
get
(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → ’models.ExpressRouteCircuitPeering’[source]¶ Gets the specified peering for the express route circuit.
- Parameters
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, circuit_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified express route circuit.
- Parameters
- 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
- Raises
-
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.v2019_02_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.v2019_02_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.v2019_02_01.models.ExpressRouteCircuitsRoutesTableSummaryListResult]
- raises ~azure.core.exceptions.HttpResponseError
Updates an express route circuit tags.
- Parameters
resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the circuit.
parameters (TagsObject) – Parameters supplied to update express route circuit tags.
- 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
- Raises
-
get
(resource_group_name: str, circuit_name: str, **kwargs: Any) → ’models.ExpressRouteCircuit’[source]¶ Gets information about the specified express route circuit.
- Parameters
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRouteConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRouteConnectionsOperations 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, express_route_gateway_name: str, connection_name: str, put_express_route_connection_parameters: ‘models.ExpressRouteConnection’, **kwargs: Any) → LROPoller[source]¶ Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param express_route_gateway_name
The name of the ExpressRoute gateway.
- type express_route_gateway_name
str
- param connection_name
The name of the connection subresource.
- type connection_name
str
- param put_express_route_connection_parameters
Parameters required in an
- ExpressRouteConnection PUT operation.
- type put_express_route_connection_parameters
~azure.mgmt.network.v2019_02_01.models.ExpressRouteConnection
- 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 ExpressRouteConnection or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ExpressRouteConnection]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, express_route_gateway_name: str, connection_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a connection to a ExpressRoute circuit.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, express_route_gateway_name: str, connection_name: str, **kwargs: Any) → ’models.ExpressRouteConnection’[source]¶ Gets the specified ExpressRouteConnection.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, express_route_gateway_name: str, **kwargs: Any) → ’models.ExpressRouteConnectionList’[source]¶ Lists ExpressRouteConnections.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteConnectionList, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRouteCrossConnectionPeeringsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRouteCrossConnectionPeeringsOperations 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, cross_connection_name: str, peering_name: str, peering_parameters: ‘models.ExpressRouteCrossConnectionPeering’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a peering in the specified ExpressRouteCrossConnection.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param cross_connection_name
The name of the ExpressRouteCrossConnection.
- type cross_connection_name
str
- param peering_name
The name of the peering.
- type peering_name
str
- param peering_parameters
Parameters supplied to the create or update
- ExpressRouteCrossConnection peering operation.
- type peering_parameters
~azure.mgmt.network.v2019_02_01.models.ExpressRouteCrossConnectionPeering
- 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 ExpressRouteCrossConnectionPeering or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ExpressRouteCrossConnectionPeering]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, cross_connection_name: str, peering_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified peering from the ExpressRouteCrossConnection.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, cross_connection_name: str, peering_name: str, **kwargs: Any) → ’models.ExpressRouteCrossConnectionPeering’[source]¶ Gets the specified peering for the ExpressRouteCrossConnection.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteCrossConnectionPeering, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, cross_connection_name: str, **kwargs: Any) → Iterable[‘models.ExpressRouteCrossConnectionPeeringList’][source]¶ Gets all peerings in a specified ExpressRouteCrossConnection.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ExpressRouteCrossConnectionPeeringList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRouteCrossConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRouteCrossConnectionsOperations 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, cross_connection_name: str, parameters: ‘models.ExpressRouteCrossConnection’, **kwargs: Any) → LROPoller[source]¶ Update the specified ExpressRouteCrossConnection.
- Parameters
resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
parameters (ExpressRouteCrossConnection) – Parameters supplied to the update express route crossConnection 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 ExpressRouteCrossConnection or the result of cls(response)
- Return type
- Raises
-
begin_list_arp_table
(resource_group_name: str, cross_connection_name: str, peering_name: str, device_path: str, **kwargs: Any) → LROPoller[source]¶ Gets the currently advertised ARP table associated with the express route cross connection in a resource group.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param cross_connection_name
The name of the ExpressRouteCrossConnection.
- type cross_connection_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.v2019_02_01.models.ExpressRouteCircuitsArpTableListResult]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_list_routes_table
(resource_group_name: str, cross_connection_name: str, peering_name: str, device_path: str, **kwargs: Any) → LROPoller[source]¶ Gets the currently advertised routes table associated with the express route cross connection in a resource group.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param cross_connection_name
The name of the ExpressRouteCrossConnection.
- type cross_connection_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.v2019_02_01.models.ExpressRouteCircuitsRoutesTableListResult]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_list_routes_table_summary
(resource_group_name: str, cross_connection_name: str, peering_name: str, device_path: str, **kwargs: Any) → LROPoller[source]¶ Gets the route table summary associated with the express route cross connection in a resource group.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param cross_connection_name
The name of the ExpressRouteCrossConnection.
- type cross_connection_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 ExpressRouteCrossConnectionsRoutesTableSummaryListResult or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ExpressRouteCrossConnectionsRoutesTableSummaryListResult]
- raises ~azure.core.exceptions.HttpResponseError
Updates an express route cross connection tags.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param cross_connection_name
The name of the cross connection.
- type cross_connection_name
str
- param cross_connection_parameters
Parameters supplied to update express route cross
- connection tags.
- type cross_connection_parameters
~azure.mgmt.network.v2019_02_01.models.TagsObject
- 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 ExpressRouteCrossConnection or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ExpressRouteCrossConnection]
- raises ~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, cross_connection_name: str, **kwargs: Any) → ’models.ExpressRouteCrossConnection’[source]¶ Gets details about the specified ExpressRouteCrossConnection.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteCrossConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ExpressRouteCrossConnectionListResult’][source]¶ Retrieves all the ExpressRouteCrossConnections 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 ExpressRouteCrossConnectionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ExpressRouteCrossConnectionListResult’][source]¶ Retrieves all the ExpressRouteCrossConnections 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 ExpressRouteCrossConnectionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRouteGatewaysOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRouteGatewaysOperations 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, express_route_gateway_name: str, put_express_route_gateway_parameters: ‘models.ExpressRouteGateway’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a ExpressRoute gateway in a specified resource group.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param express_route_gateway_name
The name of the ExpressRoute gateway.
- type express_route_gateway_name
str
- param put_express_route_gateway_parameters
Parameters required in an ExpressRoute gateway PUT
- operation.
- type put_express_route_gateway_parameters
~azure.mgmt.network.v2019_02_01.models.ExpressRouteGateway
- 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 ExpressRouteGateway or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ExpressRouteGateway]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, express_route_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param express_route_gateway_name
The name of the ExpressRoute gateway.
- type express_route_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 None or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[None]
- raises ~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, express_route_gateway_name: str, **kwargs: Any) → ’models.ExpressRouteGateway’[source]¶ Fetches the details of a ExpressRoute gateway in a resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteGateway, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → ’models.ExpressRouteGatewayList’[source]¶ Lists ExpressRoute gateways in a given resource group.
-
list_by_subscription
(**kwargs: Any) → ’models.ExpressRouteGatewayList’[source]¶ Lists ExpressRoute gateways under a given subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteGatewayList, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRouteLinksOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRouteLinksOperations 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, express_route_port_name: str, link_name: str, **kwargs: Any) → ’models.ExpressRouteLink’[source]¶ Retrieves the specified ExpressRouteLink resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRouteLink, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, express_route_port_name: str, **kwargs: Any) → Iterable[‘models.ExpressRouteLinkListResult’][source]¶ Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ExpressRouteLinkListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRoutePortsLocationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRoutePortsLocationsOperations 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
(location_name: str, **kwargs: Any) → ’models.ExpressRoutePortsLocation’[source]¶ Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.
- Parameters
location_name (str) – Name of the requested ExpressRoutePort peering location.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRoutePortsLocation, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ExpressRoutePortsLocationListResult’][source]¶ Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.
- keyword callable cls
A custom type or function that will be passed the direct response
- return
An iterator like instance of either ExpressRoutePortsLocationListResult or the result of cls(response)
- rtype
~azure.core.paging.ItemPaged[~azure.mgmt.network.v2019_02_01.models.ExpressRoutePortsLocationListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ExpressRoutePortsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExpressRoutePortsOperations 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, express_route_port_name: str, parameters: ‘models.ExpressRoutePort’, **kwargs: Any) → LROPoller[source]¶ Creates or updates the specified ExpressRoutePort resource.
- Parameters
resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of the ExpressRoutePort resource.
parameters (ExpressRoutePort) – Parameters supplied to the create ExpressRoutePort 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 ExpressRoutePort or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, express_route_port_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified ExpressRoutePort resource.
- Parameters
- 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
- Raises
Update ExpressRoutePort tags.
- Parameters
resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of the ExpressRoutePort resource.
parameters (TagsObject) – Parameters supplied to update ExpressRoutePort resource tags.
- 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 ExpressRoutePort or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, express_route_port_name: str, **kwargs: Any) → ’models.ExpressRoutePort’[source]¶ Retrieves the requested ExpressRoutePort resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ExpressRoutePort, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ExpressRoutePortListResult’][source]¶ List all the ExpressRoutePort resources in the specified subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ExpressRoutePortListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ExpressRoutePortListResult’][source]¶ List all the ExpressRoutePort resources in the specified 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 ExpressRoutePortListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
HubVirtualNetworkConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
HubVirtualNetworkConnectionsOperations 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, virtual_hub_name: str, connection_name: str, **kwargs: Any) → ’models.HubVirtualNetworkConnection’[source]¶ Retrieves the details of a HubVirtualNetworkConnection.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
HubVirtualNetworkConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) → Iterable[‘models.ListHubVirtualNetworkConnectionsResult’][source]¶ Retrieves the details of all HubVirtualNetworkConnections.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListHubVirtualNetworkConnectionsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
InterfaceEndpointsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
InterfaceEndpointsOperations 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, interface_endpoint_name: str, parameters: ‘models.InterfaceEndpoint’, **kwargs: Any) → LROPoller[source]¶ Creates or updates an interface endpoint in the specified resource group.
- Parameters
resource_group_name (str) – The name of the resource group.
interface_endpoint_name (str) – The name of the interface endpoint.
parameters (InterfaceEndpoint) – Parameters supplied to the create or update interface endpoint 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 InterfaceEndpoint or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, interface_endpoint_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified interface endpoint.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, interface_endpoint_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.InterfaceEndpoint’[source]¶ Gets the specified interface endpoint by resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
InterfaceEndpoint, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.InterfaceEndpointListResult’][source]¶ Gets all interface endpoints 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 InterfaceEndpointListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_subscription
(**kwargs: Any) → Iterable[‘models.InterfaceEndpointListResult’][source]¶ Gets all interface endpoints 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 InterfaceEndpointListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
LoadBalancerOutboundRulesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LoadBalancerOutboundRulesOperations 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, outbound_rule_name: str, **kwargs: Any) → ’models.OutboundRule’[source]¶ Gets the specified load balancer outbound rule.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
OutboundRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[‘models.LoadBalancerOutboundRuleListResult’][source]¶ Gets all the outbound rules in a load balancer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LoadBalancerOutboundRuleListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified load balancer.
- Parameters
- 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
- Raises
Updates a load balancer tags.
- Parameters
resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
parameters (TagsObject) – Parameters supplied to update load balancer tags.
- 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
- Raises
-
get
(resource_group_name: str, load_balancer_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.LoadBalancer’[source]¶ Gets the specified load balancer.
- Parameters
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, local_network_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified local network gateway.
- Parameters
- 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
- Raises
Updates a local network gateway tags.
- Parameters
resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.
parameters (TagsObject) – Parameters supplied to update local network gateway tags.
- 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
- Raises
-
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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
NatGatewaysOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
NatGatewaysOperations 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, nat_gateway_name: str, parameters: ‘models.NatGateway’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a nat gateway.
- Parameters
resource_group_name (str) – The name of the resource group.
nat_gateway_name (str) – The name of the nat gateway.
parameters (NatGateway) – Parameters supplied to the create or update nat 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 NatGateway or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, nat_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified nat gateway.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, nat_gateway_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.NatGateway’[source]¶ Gets the specified nat gateway in a specified resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NatGateway, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.NatGatewayListResult’][source]¶ Gets all nat 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 NatGatewayListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_all
(**kwargs: Any) → Iterable[‘models.NatGatewayListResult’][source]¶ Gets all the Nat 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 NatGatewayListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Updates nat gateway tags.
- Parameters
resource_group_name (str) – The name of the resource group.
nat_gateway_name (str) – The name of the nat gateway.
parameters (TagsObject) – Parameters supplied to update nat gateway tags.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NatGateway, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
NetworkInterfaceTapConfigurationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
NetworkInterfaceTapConfigurationsOperations 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, tap_configuration_name: str, tap_configuration_parameters: ‘models.NetworkInterfaceTapConfiguration’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a Tap configuration in the specified NetworkInterface.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param network_interface_name
The name of the network interface.
- type network_interface_name
str
- param tap_configuration_name
The name of the tap configuration.
- type tap_configuration_name
str
- param tap_configuration_parameters
Parameters supplied to the create or update tap
- configuration operation.
- type tap_configuration_parameters
~azure.mgmt.network.v2019_02_01.models.NetworkInterfaceTapConfiguration
- 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 NetworkInterfaceTapConfiguration or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.NetworkInterfaceTapConfiguration]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, network_interface_name: str, tap_configuration_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified tap configuration from the NetworkInterface.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, network_interface_name: str, tap_configuration_name: str, **kwargs: Any) → ’models.NetworkInterfaceTapConfiguration’[source]¶ Get the specified tap configuration on a network interface.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NetworkInterfaceTapConfiguration, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, network_interface_name: str, **kwargs: Any) → Iterable[‘models.NetworkInterfaceTapConfigurationListResult’][source]¶ Get all Tap configurations in a network interface.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either NetworkInterfaceTapConfigurationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, network_interface_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified network interface.
- Parameters
- 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
- Raises
-
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
- 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
- Raises
-
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
- 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
- Raises
Updates a network interface tags.
- Parameters
resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
parameters (TagsObject) – Parameters supplied to update network interface tags.
- 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
- Raises
-
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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get_virtual_machine_scale_set_ip_configuration
(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, ip_configuration_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.NetworkInterfaceIPConfiguration’[source]¶ Get the specified network interface ip configuration in a virtual machine scale set.
- Parameters
resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
ip_configuration_name (str) – The name of the ip configuration.
expand (str) – Expands referenced resources.
- 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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_virtual_machine_scale_set_ip_configurations
(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[‘models.NetworkInterfaceIPConfigurationListResult’][source]¶ Get the specified network interface ip configuration in a virtual machine scale set.
- Parameters
resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
expand (str) – Expands referenced resources.
- 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
- 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
- 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
- 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.v2019_02_01.models.NetworkInterfaceListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
supported_security_providers
(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → ’models.VirtualWanSecurityProviders’[source]¶ Gives the supported security providers for the virtual wan.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualWanSecurityProviders, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
-
class
azure.mgmt.network.v2019_02_01.operations.
NetworkProfilesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
NetworkProfilesOperations 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_delete
(resource_group_name: str, network_profile_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified network profile.
- Parameters
- 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
- Raises
-
create_or_update
(resource_group_name: str, network_profile_name: str, parameters: ‘models.NetworkProfile’, **kwargs: Any) → ’models.NetworkProfile’[source]¶ Creates or updates a network profile.
- Parameters
resource_group_name (str) – The name of the resource group.
network_profile_name (str) – The name of the network profile.
parameters (NetworkProfile) – Parameters supplied to the create or update network profile operation.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NetworkProfile, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, network_profile_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.NetworkProfile’[source]¶ Gets the specified network profile in a specified resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NetworkProfile, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.NetworkProfileListResult’][source]¶ Gets all network profiles 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 NetworkProfileListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_all
(**kwargs: Any) → Iterable[‘models.NetworkProfileListResult’][source]¶ Gets all the network profiles 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 NetworkProfileListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Updates network profile tags.
- Parameters
resource_group_name (str) – The name of the resource group.
network_profile_name (str) – The name of the network profile.
parameters (TagsObject) – Parameters supplied to update network profile tags.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NetworkProfile, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
Updates a network security group tags.
- Parameters
resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
parameters (TagsObject) – Parameters supplied to update network security group tags.
- 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 NetworkSecurityGroup or the result of cls(response)
- Return type
- Raises
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
begin_get_azure_reachability_report
(resource_group_name: str, network_watcher_name: str, parameters: ‘models.AzureReachabilityReportParameters’, **kwargs: Any) → LROPoller[source]¶ Gets the relative latency score for internet service providers from a specified location to Azure regions.
- 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 Azure reachability report configuration.
- type parameters
~azure.mgmt.network.v2019_02_01.models.AzureReachabilityReportParameters
- 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 AzureReachabilityReport or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.AzureReachabilityReport]
- raises ~azure.core.exceptions.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 and traffic analytics (optional) on a specified resource.
- 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 define a resource to query flow log and traffic analytics
- (optional) status.
- type parameters
~azure.mgmt.network.v2019_02_01.models.FlowLogStatusParameters
- 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 FlowLogInformation or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.FlowLogInformation]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_get_network_configuration_diagnostic
(resource_group_name: str, network_watcher_name: str, parameters: ‘models.NetworkConfigurationDiagnosticParameters’, **kwargs: Any) → LROPoller[source]¶ Get network configuration diagnostic.
- Parameters
resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (NetworkConfigurationDiagnosticParameters) – Parameters to get network configuration diagnostic.
- 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 NetworkConfigurationDiagnosticResponse or the result of cls(response)
- Return type
- Raises
-
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
- Raises
-
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
- Raises
-
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
- Raises
-
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
- Raises
-
begin_list_available_providers
(resource_group_name: str, network_watcher_name: str, parameters: ‘models.AvailableProvidersListParameters’, **kwargs: Any) → LROPoller[source]¶ Lists all available internet service providers for a specified Azure region.
- Parameters
resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (AvailableProvidersListParameters) – Parameters that scope the list of available providers.
- 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 AvailableProvidersList or the result of cls(response)
- Return type
- Raises
-
begin_set_flow_log_configuration
(resource_group_name: str, network_watcher_name: str, parameters: ‘models.FlowLogInformation’, **kwargs: Any) → LROPoller[source]¶ Configures flow log and traffic analytics (optional) 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
- Raises
-
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
- Raises
-
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
- 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
- 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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
Updates a network watcher tags.
- Parameters
resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (TagsObject) – Parameters supplied to update network watcher tags.
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations 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.OperationListResult’][source]¶ Lists all of the available Network Rest API operations.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either OperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
P2SVpnGatewaysOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
P2SVpnGatewaysOperations 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, gateway_name: str, p2_s_vpn_gateway_parameters: ‘models.P2SVpnGateway’, **kwargs: Any) → LROPoller[source]¶ Creates a virtual wan p2s vpn gateway if it doesn’t exist else updates the existing gateway.
- param resource_group_name
The resource group name of the P2SVpnGateway.
- type resource_group_name
str
- param gateway_name
The name of the gateway.
- type gateway_name
str
- param p2_s_vpn_gateway_parameters
Parameters supplied to create or Update a virtual wan p2s
- vpn gateway.
- type p2_s_vpn_gateway_parameters
~azure.mgmt.network.v2019_02_01.models.P2SVpnGateway
- 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 P2SVpnGateway or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.P2SVpnGateway]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a virtual wan p2s vpn gateway.
- Parameters
- 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
- Raises
-
begin_generate_vpn_profile
(resource_group_name: str, gateway_name: str, parameters: ‘models.P2SVpnProfileParameters’, **kwargs: Any) → LROPoller[source]¶ Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param gateway_name
The name of the P2SVpnGateway.
- type gateway_name
str
- param parameters
Parameters supplied to the generate P2SVpnGateway VPN client package
- operation.
- type parameters
~azure.mgmt.network.v2019_02_01.models.P2SVpnProfileParameters
- 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 VpnProfileResponse or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.VpnProfileResponse]
- raises ~azure.core.exceptions.HttpResponseError
Updates virtual wan p2s vpn gateway tags.
- param resource_group_name
The resource group name of the P2SVpnGateway.
- type resource_group_name
str
- param gateway_name
The name of the gateway.
- type gateway_name
str
- param p2_s_vpn_gateway_parameters
Parameters supplied to update a virtual wan p2s vpn gateway
- tags.
- type p2_s_vpn_gateway_parameters
~azure.mgmt.network.v2019_02_01.models.TagsObject
- 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 P2SVpnGateway or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.P2SVpnGateway]
- raises ~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, gateway_name: str, **kwargs: Any) → ’models.P2SVpnGateway’[source]¶ Retrieves the details of a virtual wan p2s vpn gateway.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
P2SVpnGateway, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ListP2SVpnGatewaysResult’][source]¶ Lists all the P2SVpnGateways 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 ListP2SVpnGatewaysResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ListP2SVpnGatewaysResult’][source]¶ Lists all the P2SVpnGateways in a resource group.
- Parameters
resource_group_name (str) – The resource group name of the P2SVpnGateway.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListP2SVpnGatewaysResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
P2SVpnServerConfigurationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
P2SVpnServerConfigurationsOperations 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_wan_name: str, p2_s_vpn_server_configuration_name: str, p2_s_vpn_server_configuration_parameters: ‘models.P2SVpnServerConfiguration’, **kwargs: Any) → LROPoller[source]¶ Creates a P2SVpnServerConfiguration to associate with a VirtualWan if it doesn’t exist else updates the existing P2SVpnServerConfiguration.
- param resource_group_name
The resource group name of the VirtualWan.
- type resource_group_name
str
- param virtual_wan_name
The name of the VirtualWan.
- type virtual_wan_name
str
- param p2_s_vpn_server_configuration_name
The name of the P2SVpnServerConfiguration.
- type p2_s_vpn_server_configuration_name
str
- param p2_s_vpn_server_configuration_parameters
Parameters supplied to create or Update a
- P2SVpnServerConfiguration.
- type p2_s_vpn_server_configuration_parameters
~azure.mgmt.network.v2019_02_01.models.P2SVpnServerConfiguration
- 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 P2SVpnServerConfiguration or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.P2SVpnServerConfiguration]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, virtual_wan_name: str, p2_s_vpn_server_configuration_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a P2SVpnServerConfiguration.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, virtual_wan_name: str, p2_s_vpn_server_configuration_name: str, **kwargs: Any) → ’models.P2SVpnServerConfiguration’[source]¶ Retrieves the details of a P2SVpnServerConfiguration.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
P2SVpnServerConfiguration, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_virtual_wan
(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → Iterable[‘models.ListP2SVpnServerConfigurationsResult’][source]¶ Retrieves all P2SVpnServerConfigurations for a particular VirtualWan.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListP2SVpnServerConfigurationsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
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
- 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
- Raises
-
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
- 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
- Raises
-
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
- 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
- Raises
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
PeerExpressRouteCircuitConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PeerExpressRouteCircuitConnectionsOperations 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, circuit_name: str, peering_name: str, connection_name: str, **kwargs: Any) → ’models.PeerExpressRouteCircuitConnection’[source]¶ Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PeerExpressRouteCircuitConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → Iterable[‘models.PeerExpressRouteCircuitConnectionListResult’][source]¶ Gets all global reach peer connections associated with a private peering in an 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 circuit.
- type circuit_name
str
- param peering_name
The name of the peering.
- type peering_name
str
- keyword callable cls
A custom type or function that will be passed the direct response
- return
An iterator like instance of either PeerExpressRouteCircuitConnectionListResult or the result of cls(response)
- rtype
~azure.core.paging.ItemPaged[~azure.mgmt.network.v2019_02_01.models.PeerExpressRouteCircuitConnectionListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, public_ip_address_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified public IP address.
- Parameters
- 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
- Raises
Updates public IP address tags.
- Parameters
resource_group_name (str) – The name of the resource group.
public_ip_address_name (str) – The name of the public IP address.
parameters (TagsObject) – Parameters supplied to update public IP address tags.
- 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
- Raises
-
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
- 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
- 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
- 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
- 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
- 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
- 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
- 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.v2019_02_01.models.PublicIPAddressListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
PublicIPPrefixesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PublicIPPrefixesOperations 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_prefix_name: str, parameters: ‘models.PublicIPPrefix’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a static or dynamic public IP prefix.
- Parameters
resource_group_name (str) – The name of the resource group.
public_ip_prefix_name (str) – The name of the public IP prefix.
parameters (PublicIPPrefix) – Parameters supplied to the create or update public IP prefix 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 PublicIPPrefix or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, public_ip_prefix_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified public IP prefix.
- Parameters
- 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
- Raises
Updates public IP prefix tags.
- Parameters
resource_group_name (str) – The name of the resource group.
public_ip_prefix_name (str) – The name of the public IP prefix.
parameters (TagsObject) – Parameters supplied to update public IP prefix tags.
- 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 PublicIPPrefix or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, public_ip_prefix_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.PublicIPPrefix’[source]¶ Gets the specified public IP prefix in a specified resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PublicIPPrefix, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.PublicIPPrefixListResult’][source]¶ Gets all public IP prefixes 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 PublicIPPrefixListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_all
(**kwargs: Any) → Iterable[‘models.PublicIPPrefixListResult’][source]¶ Gets all the public IP prefixes 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 PublicIPPrefixListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
Bases:
object
ResourceNavigationLinksOperations 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.
Gets a list of resource navigation links for a subnet.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ResourceNavigationLinksListResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
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.v2019_02_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.v2019_02_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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
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
- Raises
-
get
(resource_group_name: str, route_filter_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.RouteFilter’[source]¶ Gets the specified route filter.
- Parameters
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, route_table_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified route table.
- Parameters
- 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
- Raises
Updates a route table tags.
- Parameters
resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
parameters (TagsObject) – Parameters supplied to update route table tags.
- 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
- Raises
-
get
(resource_group_name: str, route_table_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.RouteTable’[source]¶ Gets the specified route table.
- Parameters
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- Raises
-
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
- 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
- Raises
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ServiceAssociationLinksOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServiceAssociationLinksOperations 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, virtual_network_name: str, subnet_name: str, **kwargs: Any) → ’models.ServiceAssociationLinksListResult’[source]¶ Gets a list of service association links for a subnet.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServiceAssociationLinksListResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ServiceEndpointPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServiceEndpointPoliciesOperations 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, service_endpoint_policy_name: str, parameters: ‘models.ServiceEndpointPolicy’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a service Endpoint Policies.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param service_endpoint_policy_name
The name of the service endpoint policy.
- type service_endpoint_policy_name
str
- param parameters
Parameters supplied to the create or update service endpoint policy
- operation.
- type parameters
~azure.mgmt.network.v2019_02_01.models.ServiceEndpointPolicy
- 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 ServiceEndpointPolicy or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ServiceEndpointPolicy]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, service_endpoint_policy_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified service endpoint policy.
- Parameters
- 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
- Raises
-
begin_update
(resource_group_name: str, service_endpoint_policy_name: str, parameters: ‘models.TagsObject’, **kwargs: Any) → LROPoller[source]¶ Updates service Endpoint Policies.
- Parameters
resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy.
parameters (TagsObject) – Parameters supplied to update service endpoint policy tags.
- 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 ServiceEndpointPolicy or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, service_endpoint_policy_name: str, expand: Optional[str] = None, **kwargs: Any) → ’models.ServiceEndpointPolicy’[source]¶ Gets the specified service Endpoint Policies in a specified resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServiceEndpointPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ServiceEndpointPolicyListResult’][source]¶ Gets all the service endpoint policies 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 ServiceEndpointPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ServiceEndpointPolicyListResult’][source]¶ Gets all service endpoint Policies 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 ServiceEndpointPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
ServiceEndpointPolicyDefinitionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServiceEndpointPolicyDefinitionsOperations 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, service_endpoint_policy_name: str, service_endpoint_policy_definition_name: str, service_endpoint_policy_definitions: ‘models.ServiceEndpointPolicyDefinition’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a service endpoint policy definition in the specified service endpoint policy.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param service_endpoint_policy_name
The name of the service endpoint policy.
- type service_endpoint_policy_name
str
- param service_endpoint_policy_definition_name
The name of the service endpoint policy
- definition name.
- type service_endpoint_policy_definition_name
str
- param service_endpoint_policy_definitions
Parameters supplied to the create or update service
- endpoint policy operation.
- type service_endpoint_policy_definitions
~azure.mgmt.network.v2019_02_01.models.ServiceEndpointPolicyDefinition
- 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 ServiceEndpointPolicyDefinition or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.ServiceEndpointPolicyDefinition]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, service_endpoint_policy_name: str, service_endpoint_policy_definition_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified ServiceEndpoint policy definitions.
- param resource_group_name
The name of the resource group.
- type resource_group_name
str
- param service_endpoint_policy_name
The name of the Service Endpoint Policy.
- type service_endpoint_policy_name
str
- param service_endpoint_policy_definition_name
The name of the service endpoint policy
- definition.
- type service_endpoint_policy_definition_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
-
get
(resource_group_name: str, service_endpoint_policy_name: str, service_endpoint_policy_definition_name: str, **kwargs: Any) → ’models.ServiceEndpointPolicyDefinition’[source]¶ Get the specified service endpoint policy definitions from service endpoint policy.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServiceEndpointPolicyDefinition, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, service_endpoint_policy_name: str, **kwargs: Any) → Iterable[‘models.ServiceEndpointPolicyDefinitionListResult’][source]¶ Gets all service endpoint policy definitions in a service end point policy.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ServiceEndpointPolicyDefinitionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- 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
- Raises
-
begin_delete
(resource_group_name: str, virtual_network_name: str, subnet_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified subnet.
- Parameters
- 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
- Raises
-
begin_prepare_network_policies
(resource_group_name: str, virtual_network_name: str, subnet_name: str, prepare_network_policies_request_parameters: ‘models.PrepareNetworkPoliciesRequest’, **kwargs: Any) → LROPoller[source]¶ Prepares a subnet by applying network intent policies.
- 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 subnet_name
The name of the subnet.
- type subnet_name
str
- param prepare_network_policies_request_parameters
Parameters supplied to prepare subnet by
- applying network intent policies.
- type prepare_network_policies_request_parameters
~azure.mgmt.network.v2019_02_01.models.PrepareNetworkPoliciesRequest
- 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
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
VirtualHubsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VirtualHubsOperations 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_hub_name: str, virtual_hub_parameters: ‘models.VirtualHub’, **kwargs: Any) → LROPoller[source]¶ Creates a VirtualHub resource if it doesn’t exist else updates the existing VirtualHub.
- Parameters
resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
virtual_hub_parameters (VirtualHub) – Parameters supplied to create or update VirtualHub.
- 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 VirtualHub or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a VirtualHub.
- Parameters
- 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
- Raises
Updates VirtualHub tags.
- Parameters
resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
virtual_hub_parameters (TagsObject) – Parameters supplied to update VirtualHub tags.
- 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 VirtualHub or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) → ’models.VirtualHub’[source]¶ Retrieves the details of a VirtualHub.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualHub, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ListVirtualHubsResult’][source]¶ Lists all the VirtualHubs 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 ListVirtualHubsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ListVirtualHubsResult’][source]¶ Lists all the VirtualHubs in a resource group.
- Parameters
resource_group_name (str) – The resource group name of the VirtualHub.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListVirtualHubsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
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.v2019_02_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.v2019_02_01.models.ConnectionResetSharedKey]
- raises ~azure.core.exceptions.HttpResponseError
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.v2019_02_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.v2019_02_01.models.ConnectionSharedKey]
- raises ~azure.core.exceptions.HttpResponseError
Updates a virtual network gateway connection tags.
- 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 update virtual network gateway connection tags.
- type parameters
~azure.mgmt.network.v2019_02_01.models.TagsObject
- 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.v2019_02_01.models.VirtualNetworkGatewayConnection]
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.
- Parameters
- 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
- 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.v2019_02_01.models.VirtualNetworkGatewayConnectionListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified virtual network gateway.
- Parameters
- 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
- Raises
-
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.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
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.v2019_02_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_get_vpnclient_ipsec_parameters
(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → LROPoller[source]¶ The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway 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_name
The virtual network gateway name.
- 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 VpnClientIPsecParameters or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.VpnClientIPsecParameters]
- 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.v2019_02_01.models.VirtualNetworkGateway]
- raises ~azure.core.exceptions.HttpResponseError
Resets the VPN client shared key 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
- 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_set_vpnclient_ipsec_parameters
(resource_group_name: str, virtual_network_gateway_name: str, vpnclient_ipsec_params: ‘models.VpnClientIPsecParameters’, **kwargs: Any) → LROPoller[source]¶ The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway 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_name
The name of the virtual network gateway.
- type virtual_network_gateway_name
str
- param vpnclient_ipsec_params
Parameters supplied to the Begin Set vpnclient ipsec parameters
- of Virtual Network Gateway P2S client operation through Network resource provider.
- type vpnclient_ipsec_params
~azure.mgmt.network.v2019_02_01.models.VpnClientIPsecParameters
- 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 VpnClientIPsecParameters or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.VpnClientIPsecParameters]
- raises ~azure.core.exceptions.HttpResponseError
Updates a virtual network gateway tags.
- Parameters
resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
parameters (TagsObject) – Parameters supplied to update virtual network gateway tags.
- 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
- Raises
-
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
- 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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
supported_vpn_devices
(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → str[source]¶ Gets a xml format representation for supported vpn devices.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
str, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
vpn_device_configuration_script
(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: ‘models.VpnDeviceScriptParameters’, **kwargs: Any) → str[source]¶ Gets a xml format representation for vpn device configuration script.
- Parameters
resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection for which the configuration script is generated.
parameters (VpnDeviceScriptParameters) – Parameters supplied to the generate vpn device script operation.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
str, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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.v2019_02_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.v2019_02_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
- 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
- Raises
-
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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
VirtualNetworkTapsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VirtualNetworkTapsOperations 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, tap_name: str, parameters: ‘models.VirtualNetworkTap’, **kwargs: Any) → LROPoller[source]¶ Creates or updates a Virtual Network Tap.
- Parameters
resource_group_name (str) – The name of the resource group.
tap_name (str) – The name of the virtual network tap.
parameters (VirtualNetworkTap) – Parameters supplied to the create or update virtual network tap 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 VirtualNetworkTap or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, tap_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified virtual network tap.
- Parameters
- 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
- Raises
Updates an VirtualNetworkTap tags.
- Parameters
resource_group_name (str) – The name of the resource group.
tap_name (str) – The name of the tap.
tap_parameters (TagsObject) – Parameters supplied to update VirtualNetworkTap tags.
- 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 VirtualNetworkTap or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, tap_name: str, **kwargs: Any) → ’models.VirtualNetworkTap’[source]¶ Gets information about the specified virtual network tap.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualNetworkTap, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_all
(**kwargs: Any) → Iterable[‘models.VirtualNetworkTapListResult’][source]¶ Gets all the VirtualNetworkTaps 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 VirtualNetworkTapListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.VirtualNetworkTapListResult’][source]¶ Gets all the VirtualNetworkTaps in a subscription.
- 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 VirtualNetworkTapListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_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
- Raises
-
begin_delete
(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes the specified virtual network.
- Parameters
- 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
- Raises
Updates a virtual network tags.
- Parameters
resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
parameters (TagsObject) – Parameters supplied to update virtual network tags.
- 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
- Raises
-
check_ip_address_availability
(resource_group_name: str, virtual_network_name: str, ip_address: str, **kwargs: Any) → ’models.IPAddressAvailabilityResult’[source]¶ Checks whether a private IP address is available for use.
- Parameters
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
VirtualWansOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VirtualWansOperations 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_wan_name: str, wan_parameters: ‘models.VirtualWAN’, **kwargs: Any) → LROPoller[source]¶ Creates a VirtualWAN resource if it doesn’t exist else updates the existing VirtualWAN.
- Parameters
resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWAN being created or updated.
wan_parameters (VirtualWAN) – Parameters supplied to create or update VirtualWAN.
- 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 VirtualWAN or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a VirtualWAN.
- Parameters
- 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
- Raises
Updates a VirtualWAN tags.
- Parameters
resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWAN being updated.
wan_parameters (TagsObject) – Parameters supplied to Update VirtualWAN tags.
- 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 VirtualWAN or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → ’models.VirtualWAN’[source]¶ Retrieves the details of a VirtualWAN.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualWAN, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ListVirtualWANsResult’][source]¶ Lists all the VirtualWANs 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 ListVirtualWANsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ListVirtualWANsResult’][source]¶ Lists all the VirtualWANs in a resource group.
- Parameters
resource_group_name (str) – The resource group name of the VirtualWan.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListVirtualWANsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
VpnConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VpnConnectionsOperations 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, gateway_name: str, connection_name: str, vpn_connection_parameters: ‘models.VpnConnection’, **kwargs: Any) → LROPoller[source]¶ Creates a vpn connection to a scalable vpn gateway if it doesn’t exist else updates the existing connection.
- param resource_group_name
The resource group name of the VpnGateway.
- type resource_group_name
str
- param gateway_name
The name of the gateway.
- type gateway_name
str
- param connection_name
The name of the connection.
- type connection_name
str
- param vpn_connection_parameters
Parameters supplied to create or Update a VPN Connection.
- type vpn_connection_parameters
~azure.mgmt.network.v2019_02_01.models.VpnConnection
- 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 VpnConnection or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.VpnConnection]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a vpn connection.
- Parameters
- 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
- Raises
-
get
(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs: Any) → ’models.VpnConnection’[source]¶ Retrieves the details of a vpn connection.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VpnConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_vpn_gateway
(resource_group_name: str, gateway_name: str, **kwargs: Any) → Iterable[‘models.ListVpnConnectionsResult’][source]¶ Retrieves all vpn connections for a particular virtual wan vpn gateway.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListVpnConnectionsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
VpnGatewaysOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VpnGatewaysOperations 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, gateway_name: str, vpn_gateway_parameters: ‘models.VpnGateway’, **kwargs: Any) → LROPoller[source]¶ Creates a virtual wan vpn gateway if it doesn’t exist else updates the existing gateway.
- param resource_group_name
The resource group name of the VpnGateway.
- type resource_group_name
str
- param gateway_name
The name of the gateway.
- type gateway_name
str
- param vpn_gateway_parameters
Parameters supplied to create or Update a virtual wan vpn
- gateway.
- type vpn_gateway_parameters
~azure.mgmt.network.v2019_02_01.models.VpnGateway
- 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 VpnGateway or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.network.v2019_02_01.models.VpnGateway]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, gateway_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a virtual wan vpn gateway.
- Parameters
- 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
- Raises
Updates virtual wan vpn gateway tags.
- Parameters
resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
vpn_gateway_parameters (TagsObject) – Parameters supplied to update a virtual wan vpn gateway tags.
- 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 VpnGateway or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, gateway_name: str, **kwargs: Any) → ’models.VpnGateway’[source]¶ Retrieves the details of a virtual wan vpn gateway.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VpnGateway, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ListVpnGatewaysResult’][source]¶ Lists all the VpnGateways 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 ListVpnGatewaysResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ListVpnGatewaysResult’][source]¶ Lists all the VpnGateways in a resource group.
- Parameters
resource_group_name (str) – The resource group name of the VpnGateway.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListVpnGatewaysResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
VpnSitesConfigurationOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VpnSitesConfigurationOperations 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_download
(resource_group_name: str, virtual_wan_name: str, request: ‘models.GetVpnSitesConfigurationRequest’, **kwargs: Any) → LROPoller[source]¶ Gives the sas-url to download the configurations for vpn-sites in a resource group.
- param resource_group_name
The resource group name.
- type resource_group_name
str
- param virtual_wan_name
The name of the VirtualWAN for which configuration of all vpn-sites is
- needed.
- type virtual_wan_name
str
- param request
Parameters supplied to download vpn-sites configuration.
- type request
~azure.mgmt.network.v2019_02_01.models.GetVpnSitesConfigurationRequest
- 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
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
VpnSitesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VpnSitesOperations 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, vpn_site_name: str, vpn_site_parameters: ‘models.VpnSite’, **kwargs: Any) → LROPoller[source]¶ Creates a VpnSite resource if it doesn’t exist else updates the existing VpnSite.
- Parameters
- 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 VpnSite or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, vpn_site_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes a VpnSite.
- Parameters
- 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
- Raises
Updates VpnSite tags.
- Parameters
resource_group_name (str) – The resource group name of the VpnSite.
vpn_site_name (str) – The name of the VpnSite being updated.
vpn_site_parameters (TagsObject) – Parameters supplied to update VpnSite tags.
- 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 VpnSite or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, vpn_site_name: str, **kwargs: Any) → ’models.VpnSite’[source]¶ Retrieves the details of a VPN site.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VpnSite, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[‘models.ListVpnSitesResult’][source]¶ Lists all the VpnSites 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 ListVpnSitesResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.ListVpnSitesResult’][source]¶ Lists all the vpnSites in a resource group.
- Parameters
resource_group_name (str) – The resource group name of the VpnSite.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListVpnSitesResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.network.v2019_02_01.operations.
WebApplicationFirewallPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
WebApplicationFirewallPoliciesOperations 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_delete
(resource_group_name: str, policy_name: str, **kwargs: Any) → LROPoller[source]¶ Deletes Policy.
- Parameters
- 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
- Raises
-
create_or_update
(resource_group_name: str, policy_name: str, parameters: ‘models.WebApplicationFirewallPolicy’, **kwargs: Any) → ’models.WebApplicationFirewallPolicy’[source]¶ Creates or update policy with specified rule set name within a resource group.
- Parameters
resource_group_name (str) – The name of the resource group.
policy_name (str) – The name of the policy.
parameters (WebApplicationFirewallPolicy) – Policy to be created.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
WebApplicationFirewallPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, policy_name: str, **kwargs: Any) → ’models.WebApplicationFirewallPolicy’[source]¶ Retrieve protection policy with specified name within a resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
WebApplicationFirewallPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, **kwargs: Any) → Iterable[‘models.WebApplicationFirewallPolicyListResult’][source]¶ Lists all of the protection policies within 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 WebApplicationFirewallPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_all
(**kwargs: Any) → Iterable[‘models.WebApplicationFirewallPolicyListResult’][source]¶ Gets all the WAF policies 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 WebApplicationFirewallPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.network.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶