azure.mgmt.network.v2019_02_01.operations module¶

class azure.mgmt.network.v2019_02_01.operations.ApplicationGatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s application_gateways attribute.

begin_backend_health(resource_group_name: str, application_gateway_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGatewayBackendHealth][source]¶

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

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApplicationGatewayBackendHealth]

Raises

HttpResponseError –

begin_backend_health_on_demand(resource_group_name: str, application_gateway_name: str, probe_request: _models.ApplicationGatewayOnDemandProbe, expand: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationGatewayBackendHealthOnDemand][source]¶

begin_backend_health_on_demand(resource_group_name: str, application_gateway_name: str, probe_request: IO, expand: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationGatewayBackendHealthOnDemand]

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
application_gateway_name (str) – The name of the application gateway. Required.
probe_request (ApplicationGatewayOnDemandProbe or IO) – Request body for on-demand test probe operation. Is either a model type or a IO type. Required.
expand (str) – Expands BackendAddressPool and BackendHttpSettings referenced in backend health. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ApplicationGatewayBackendHealthOnDemand or the result of cls(response)

Return type

LROPoller[ApplicationGatewayBackendHealthOnDemand]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, application_gateway_name: str, parameters: _models.ApplicationGateway, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationGateway][source]¶

begin_create_or_update(resource_group_name: str, application_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationGateway]

Creates or updates the specified application gateway.

Parameters

resource_group_name (str) – The name of the resource group. Required.
application_gateway_name (str) – The name of the application gateway. Required.
parameters (ApplicationGateway or IO) – Parameters supplied to the create or update application gateway operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApplicationGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified application gateway.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_start(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Starts the specified application gateway.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_stop(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Stops the specified application gateway in a resource group.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, application_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationGateway][source]¶

begin_update_tags(resource_group_name: str, application_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationGateway]

Updates the specified application gateway tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
application_gateway_name (str) – The name of the application gateway. Required.
parameters (TagsObject or IO) – Parameters supplied to update application gateway tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApplicationGateway]

Raises

HttpResponseError –

get(resource_group_name: str, application_gateway_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGateway[source]¶

Gets the specified application gateway.

Parameters

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

Keyword Arguments

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

Returns

ApplicationGateway or the result of cls(response)

Return type

ApplicationGateway

Raises

HttpResponseError –

get_ssl_predefined_policy(predefined_policy_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGatewaySslPredefinedPolicy[source]¶

Gets Ssl predefined policy with the specified policy name.

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

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGateway][source]¶

Lists all application gateways in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGateway][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 ApplicationGateway or the result of cls(response)
Return type: ItemPaged[ApplicationGateway]
Raises: HttpResponseError –

list_available_request_headers(**kwargs: Any) → List[str][source]¶

Lists all available request headers.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: list of str or the result of cls(response)
Return type: list[str]
Raises: HttpResponseError –

list_available_response_headers(**kwargs: Any) → List[str][source]¶

Lists all available response headers.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: list of str or the result of cls(response)
Return type: list[str]
Raises: HttpResponseError –

list_available_server_variables(**kwargs: Any) → List[str][source]¶

Lists all available server variables.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: list of str or the result of cls(response)
Return type: list[str]
Raises: HttpResponseError –

list_available_ssl_options(**kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGatewayAvailableSslOptions[source]¶

Lists available Ssl options for configuring Ssl policy.

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

list_available_ssl_predefined_policies(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGatewaySslPredefinedPolicy][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 ApplicationGatewaySslPredefinedPolicy or the result of cls(response)
Return type: ItemPaged[ApplicationGatewaySslPredefinedPolicy]
Raises: HttpResponseError –

list_available_waf_rule_sets(**kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationGatewayAvailableWafRuleSetsResult[source]¶

Lists all available web application firewall rule sets.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ApplicationSecurityGroupsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s application_security_groups attribute.

begin_create_or_update(resource_group_name: str, application_security_group_name: str, parameters: _models.ApplicationSecurityGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationSecurityGroup][source]¶

begin_create_or_update(resource_group_name: str, application_security_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationSecurityGroup]

Creates or updates an application security group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
application_security_group_name (str) – The name of the application security group. Required.
parameters (ApplicationSecurityGroup or IO) – Parameters supplied to the create or update ApplicationSecurityGroup operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ApplicationSecurityGroup]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, application_security_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified application security group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
application_security_group_name (str) – The name of the application security group. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, application_security_group_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationSecurityGroup][source]¶

begin_update_tags(resource_group_name: str, application_security_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApplicationSecurityGroup]

Updates an application security group’s tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
application_security_group_name (str) – The name of the application security group. Required.
parameters (TagsObject or IO) – Parameters supplied to update application security group tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ApplicationSecurityGroup]

Raises

HttpResponseError –

get(resource_group_name: str, application_security_group_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationSecurityGroup[source]¶

Gets information about the specified application security group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
application_security_group_name (str) – The name of the application security group. Required.

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

ApplicationSecurityGroup

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationSecurityGroup][source]¶

Gets all the application security groups in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ApplicationSecurityGroup][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 ApplicationSecurityGroup or the result of cls(response)
Return type: ItemPaged[ApplicationSecurityGroup]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.AvailableDelegationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s available_delegations attribute.

list(location: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.AvailableDelegation][source]¶

Gets all of the available subnet delegations for this subscription in this region.

Parameters: location (str) – The location of the subnet. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AvailableDelegation or the result of cls(response)
Return type: ItemPaged[AvailableDelegation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.AvailableEndpointServicesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s available_endpoint_services attribute.

list(location: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.EndpointServiceResult][source]¶

List what values of endpoint services are available for use.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.AvailableResourceGroupDelegationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s available_resource_group_delegations attribute.

list(location: str, resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.AvailableDelegation][source]¶

Gets all of the available subnet delegations for this resource group in this region.

Parameters

location (str) – The location of the domain name. Required.
resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[AvailableDelegation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.AzureFirewallFqdnTagsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s azure_firewall_fqdn_tags attribute.

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.AzureFirewallFqdnTag][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 AzureFirewallFqdnTag or the result of cls(response)
Return type: ItemPaged[AzureFirewallFqdnTag]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.AzureFirewallsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s azure_firewalls attribute.

begin_create_or_update(resource_group_name: str, azure_firewall_name: str, parameters: _models.AzureFirewall, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AzureFirewall][source]¶

begin_create_or_update(resource_group_name: str, azure_firewall_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AzureFirewall]

Creates or updates the specified Azure Firewall.

Parameters

resource_group_name (str) – The name of the resource group. Required.
azure_firewall_name (str) – The name of the Azure Firewall. Required.
parameters (AzureFirewall or IO) – Parameters supplied to the create or update Azure Firewall operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[AzureFirewall]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, azure_firewall_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified Azure Firewall.

Parameters

resource_group_name (str) – The name of the resource group. Required.
azure_firewall_name (str) – The name of the Azure Firewall. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, azure_firewall_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.AzureFirewall[source]¶

Gets the specified Azure Firewall.

Parameters

resource_group_name (str) – The name of the resource group. Required.
azure_firewall_name (str) – The name of the Azure Firewall. Required.

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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.AzureFirewall][source]¶

Lists all Azure Firewalls in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.AzureFirewall][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 AzureFirewall or the result of cls(response)
Return type: ItemPaged[AzureFirewall]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.BgpServiceCommunitiesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s bgp_service_communities attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.BgpServiceCommunity][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 BgpServiceCommunity or the result of cls(response)
Return type: ItemPaged[BgpServiceCommunity]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ConnectionMonitorsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s connection_monitors attribute.

begin_create_or_update(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, parameters: _models.ConnectionMonitor, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectionMonitorResult][source]¶

begin_create_or_update(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectionMonitorResult]

Create or update a connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher. Required.
network_watcher_name (str) – The name of the Network Watcher resource. Required.
connection_monitor_name (str) – The name of the connection monitor. Required.
parameters (ConnectionMonitor or IO) – Parameters that define the operation to create a connection monitor. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ConnectionMonitorResult]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher. Required.
network_watcher_name (str) – The name of the Network Watcher resource. Required.
connection_monitor_name (str) – The name of the connection monitor. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_query(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ConnectionMonitorQueryResult][source]¶

Query a snapshot of the most recent connection states.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher. Required.
network_watcher_name (str) – The name of the Network Watcher resource. Required.
connection_monitor_name (str) – The name given to the connection monitor. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ConnectionMonitorQueryResult]

Raises

HttpResponseError –

begin_start(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Starts the specified connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher. Required.
network_watcher_name (str) – The name of the Network Watcher resource. Required.
connection_monitor_name (str) – The name of the connection monitor. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_stop(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Stops the specified connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher. Required.
network_watcher_name (str) – The name of the Network Watcher resource. Required.
connection_monitor_name (str) – The name of the connection monitor. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ConnectionMonitorResult[source]¶

Gets a connection monitor by name.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher. Required.
network_watcher_name (str) – The name of the Network Watcher resource. Required.
connection_monitor_name (str) – The name of the connection monitor. Required.

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

ConnectionMonitorResult

Raises

HttpResponseError –

list(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ConnectionMonitorResult][source]¶

Lists all connection monitors for the specified Network Watcher.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ConnectionMonitorResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.DdosCustomPoliciesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s ddos_custom_policies attribute.

begin_create_or_update(resource_group_name: str, ddos_custom_policy_name: str, parameters: _models.DdosCustomPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosCustomPolicy][source]¶

begin_create_or_update(resource_group_name: str, ddos_custom_policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosCustomPolicy]

Creates or updates a DDoS custom policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_custom_policy_name (str) – The name of the DDoS custom policy. Required.
parameters (DdosCustomPolicy or IO) – Parameters supplied to the create or update operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[DdosCustomPolicy]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, ddos_custom_policy_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified DDoS custom policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_custom_policy_name (str) – The name of the DDoS custom policy. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, ddos_custom_policy_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosCustomPolicy][source]¶

begin_update_tags(resource_group_name: str, ddos_custom_policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosCustomPolicy]

Update a DDoS custom policy tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_custom_policy_name (str) – The name of the DDoS custom policy. Required.
parameters (TagsObject or IO) – Parameters supplied to the update DDoS custom policy resource tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[DdosCustomPolicy]

Raises

HttpResponseError –

get(resource_group_name: str, ddos_custom_policy_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.DdosCustomPolicy[source]¶

Gets information about the specified DDoS custom policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_custom_policy_name (str) – The name of the DDoS custom policy. Required.

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

DdosCustomPolicy

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.DdosProtectionPlansOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s ddos_protection_plans attribute.

begin_create_or_update(resource_group_name: str, ddos_protection_plan_name: str, parameters: _models.DdosProtectionPlan, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosProtectionPlan][source]¶

begin_create_or_update(resource_group_name: str, ddos_protection_plan_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosProtectionPlan]

Creates or updates a DDoS protection plan.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_protection_plan_name (str) – The name of the DDoS protection plan. Required.
parameters (DdosProtectionPlan or IO) – Parameters supplied to the create or update operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[DdosProtectionPlan]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, ddos_protection_plan_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified DDoS protection plan.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_protection_plan_name (str) – The name of the DDoS protection plan. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, ddos_protection_plan_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosProtectionPlan][source]¶

begin_update_tags(resource_group_name: str, ddos_protection_plan_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DdosProtectionPlan]

Update a DDoS protection plan tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_protection_plan_name (str) – The name of the DDoS protection plan. Required.
parameters (TagsObject or IO) – Parameters supplied to the update DDoS protection plan resource tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[DdosProtectionPlan]

Raises

HttpResponseError –

get(resource_group_name: str, ddos_protection_plan_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.DdosProtectionPlan[source]¶

Gets information about the specified DDoS protection plan.

Parameters

resource_group_name (str) – The name of the resource group. Required.
ddos_protection_plan_name (str) – The name of the DDoS protection plan. Required.

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

DdosProtectionPlan

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.DdosProtectionPlan][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 DdosProtectionPlan or the result of cls(response)
Return type: ItemPaged[DdosProtectionPlan]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.DdosProtectionPlan][source]¶

Gets all the DDoS protection plans in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.DefaultSecurityRulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s default_security_rules attribute.

get(resource_group_name: str, network_security_group_name: str, default_security_rule_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.SecurityRule[source]¶

Get the specified default network security rule.

Parameters

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

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

HttpResponseError –

list(resource_group_name: str, network_security_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.SecurityRule][source]¶

Gets all default security rules in a network security group.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SecurityRule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteCircuitAuthorizationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_circuit_authorizations attribute.

begin_create_or_update(resource_group_name: str, circuit_name: str, authorization_name: str, authorization_parameters: _models.ExpressRouteCircuitAuthorization, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuitAuthorization][source]¶

begin_create_or_update(resource_group_name: str, circuit_name: str, authorization_name: str, authorization_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuitAuthorization]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
circuit_name (str) – The name of the express route circuit. Required.
authorization_name (str) – The name of the authorization. Required.
authorization_parameters (ExpressRouteCircuitAuthorization or IO) – Parameters supplied to the create or update express route circuit authorization operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitAuthorization or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitAuthorization]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, circuit_name: str, authorization_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified authorization from the specified express route circuit.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, circuit_name: str, authorization_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitAuthorization[source]¶

Gets the specified authorization from the specified express route circuit.

Parameters

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

Keyword Arguments

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

Returns

ExpressRouteCircuitAuthorization or the result of cls(response)

Return type

ExpressRouteCircuitAuthorization

Raises

HttpResponseError –

list(resource_group_name: str, circuit_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitAuthorization][source]¶

Gets all authorizations in an express route circuit.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ExpressRouteCircuitAuthorization]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteCircuitConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_circuit_connections attribute.

begin_create_or_update(resource_group_name: str, circuit_name: str, peering_name: str, connection_name: str, express_route_circuit_connection_parameters: _models.ExpressRouteCircuitConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuitConnection][source]¶

begin_create_or_update(resource_group_name: str, circuit_name: str, peering_name: str, connection_name: str, express_route_circuit_connection_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuitConnection]

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

Parameters

resource_group_name (str) – The name of the resource group. Required.
circuit_name (str) – The name of the express route circuit. Required.
peering_name (str) – The name of the peering. Required.
connection_name (str) – The name of the express route circuit connection. Required.
express_route_circuit_connection_parameters (ExpressRouteCircuitConnection or IO) – Parameters supplied to the create or update express route circuit connection operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitConnection or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitConnection]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, circuit_name: str, peering_name: str, connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified Express Route Circuit Connection from the specified express route circuit.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, circuit_name: str, peering_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitConnection[source]¶

Gets the specified Express Route Circuit Connection from the specified express route circuit.

Parameters

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

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

ExpressRouteCircuitConnection

Raises

HttpResponseError –

list(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitConnection][source]¶

Gets all global reach connections associated with a private peering in an express route circuit.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ExpressRouteCircuitConnection]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteCircuitPeeringsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_circuit_peerings attribute.

begin_create_or_update(resource_group_name: str, circuit_name: str, peering_name: str, peering_parameters: _models.ExpressRouteCircuitPeering, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuitPeering][source]¶

begin_create_or_update(resource_group_name: str, circuit_name: str, peering_name: str, peering_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuitPeering]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
circuit_name (str) – The name of the express route circuit. Required.
peering_name (str) – The name of the peering. Required.
peering_parameters (ExpressRouteCircuitPeering or IO) – Parameters supplied to the create or update express route circuit peering operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitPeering or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitPeering]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified peering from the specified express route circuit.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitPeering[source]¶

Gets the specified peering for the express route circuit.

Parameters

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

Keyword Arguments

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

Returns

ExpressRouteCircuitPeering or the result of cls(response)

Return type

ExpressRouteCircuitPeering

Raises

HttpResponseError –

list(resource_group_name: str, circuit_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitPeering][source]¶

Gets all peerings in a specified express route circuit.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ExpressRouteCircuitPeering]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteCircuitsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_circuits attribute.

begin_create_or_update(resource_group_name: str, circuit_name: str, parameters: _models.ExpressRouteCircuit, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuit][source]¶

begin_create_or_update(resource_group_name: str, circuit_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuit]

Creates or updates an express route circuit.

Parameters

resource_group_name (str) – The name of the resource group. Required.
circuit_name (str) – The name of the circuit. Required.
parameters (ExpressRouteCircuit or IO) – Parameters supplied to the create or update express route circuit operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ExpressRouteCircuit]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, circuit_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified express route circuit.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_list_arp_table(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitsArpTableListResult][source]¶

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

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitsArpTableListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsArpTableListResult]

Raises

HttpResponseError –

begin_list_routes_table(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitsRoutesTableListResult][source]¶

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

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitsRoutesTableListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsRoutesTableListResult]

Raises

HttpResponseError –

begin_list_routes_table_summary(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitsRoutesTableSummaryListResult][source]¶

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

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitsRoutesTableSummaryListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsRoutesTableSummaryListResult]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, circuit_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuit][source]¶

begin_update_tags(resource_group_name: str, circuit_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCircuit]

Updates an express route circuit tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
circuit_name (str) – The name of the circuit. Required.
parameters (TagsObject or IO) – Parameters supplied to update express route circuit tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ExpressRouteCircuit]

Raises

HttpResponseError –

get(resource_group_name: str, circuit_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuit[source]¶

Gets information about the specified express route circuit.

Parameters

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

Keyword Arguments

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

Returns

ExpressRouteCircuit or the result of cls(response)

Return type

ExpressRouteCircuit

Raises

HttpResponseError –

get_peering_stats(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitStats[source]¶

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

Parameters

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

Keyword Arguments

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

Returns

ExpressRouteCircuitStats or the result of cls(response)

Return type

ExpressRouteCircuitStats

Raises

HttpResponseError –

get_stats(resource_group_name: str, circuit_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitStats[source]¶

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

Parameters

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

Keyword Arguments

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

Returns

ExpressRouteCircuitStats or the result of cls(response)

Return type

ExpressRouteCircuitStats

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuit][source]¶

Gets all the express route circuits in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuit][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 ExpressRouteCircuit or the result of cls(response)
Return type: ItemPaged[ExpressRouteCircuit]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_connections attribute.

begin_create_or_update(resource_group_name: str, express_route_gateway_name: str, connection_name: str, put_express_route_connection_parameters: _models.ExpressRouteConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteConnection][source]¶

begin_create_or_update(resource_group_name: str, express_route_gateway_name: str, connection_name: str, put_express_route_connection_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteConnection]

Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_gateway_name (str) – The name of the ExpressRoute gateway. Required.
connection_name (str) – The name of the connection subresource. Required.
put_express_route_connection_parameters (ExpressRouteConnection or IO) – Parameters required in an ExpressRouteConnection PUT operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteConnection or the result of cls(response)

Return type

LROPoller[ExpressRouteConnection]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, express_route_gateway_name: str, connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a connection to a ExpressRoute circuit.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_gateway_name (str) – The name of the ExpressRoute gateway. Required.
connection_name (str) – The name of the connection subresource. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, express_route_gateway_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteConnection[source]¶

Gets the specified ExpressRouteConnection.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_gateway_name (str) – The name of the ExpressRoute gateway. Required.
connection_name (str) – The name of the ExpressRoute connection. Required.

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

ExpressRouteConnection

Raises

HttpResponseError –

list(resource_group_name: str, express_route_gateway_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteConnectionList[source]¶

Lists ExpressRouteConnections.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_gateway_name (str) – The name of the ExpressRoute gateway. Required.

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

ExpressRouteConnectionList

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteCrossConnectionPeeringsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_cross_connection_peerings attribute.

begin_create_or_update(resource_group_name: str, cross_connection_name: str, peering_name: str, peering_parameters: _models.ExpressRouteCrossConnectionPeering, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCrossConnectionPeering][source]¶

begin_create_or_update(resource_group_name: str, cross_connection_name: str, peering_name: str, peering_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCrossConnectionPeering]

Creates or updates a peering in the specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.
peering_name (str) – The name of the peering. Required.
peering_parameters (ExpressRouteCrossConnectionPeering or IO) – Parameters supplied to the create or update ExpressRouteCrossConnection peering operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCrossConnectionPeering or the result of cls(response)

Return type

LROPoller[ExpressRouteCrossConnectionPeering]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, cross_connection_name: str, peering_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified peering from the ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.
peering_name (str) – The name of the peering. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, cross_connection_name: str, peering_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCrossConnectionPeering[source]¶

Gets the specified peering for the ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.
peering_name (str) – The name of the peering. Required.

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

ExpressRouteCrossConnectionPeering

Raises

HttpResponseError –

list(resource_group_name: str, cross_connection_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCrossConnectionPeering][source]¶

Gets all peerings in a specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ExpressRouteCrossConnectionPeering]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteCrossConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_cross_connections attribute.

begin_create_or_update(resource_group_name: str, cross_connection_name: str, parameters: _models.ExpressRouteCrossConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCrossConnection][source]¶

begin_create_or_update(resource_group_name: str, cross_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCrossConnection]

Update the specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.
parameters (ExpressRouteCrossConnection or IO) – Parameters supplied to the update express route crossConnection operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ExpressRouteCrossConnection]

Raises

HttpResponseError –

begin_list_arp_table(resource_group_name: str, cross_connection_name: str, peering_name: str, device_path: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitsArpTableListResult][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.
peering_name (str) – The name of the peering. Required.
device_path (str) – The path of the device. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitsArpTableListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsArpTableListResult]

Raises

HttpResponseError –

begin_list_routes_table(resource_group_name: str, cross_connection_name: str, peering_name: str, device_path: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCircuitsRoutesTableListResult][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.
peering_name (str) – The name of the peering. Required.
device_path (str) – The path of the device. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCircuitsRoutesTableListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsRoutesTableListResult]

Raises

HttpResponseError –

begin_list_routes_table_summary(resource_group_name: str, cross_connection_name: str, peering_name: str, device_path: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCrossConnectionsRoutesTableSummaryListResult][source]¶

Gets the route table summary associated with the express route cross connection in a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection. Required.
peering_name (str) – The name of the peering. Required.
device_path (str) – The path of the device. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteCrossConnectionsRoutesTableSummaryListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCrossConnectionsRoutesTableSummaryListResult]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, cross_connection_name: str, cross_connection_parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCrossConnection][source]¶

begin_update_tags(resource_group_name: str, cross_connection_name: str, cross_connection_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteCrossConnection]

Updates an express route cross connection tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
cross_connection_name (str) – The name of the cross connection. Required.
cross_connection_parameters (TagsObject or IO) – Parameters supplied to update express route cross connection tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ExpressRouteCrossConnection]

Raises

HttpResponseError –

get(resource_group_name: str, cross_connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCrossConnection[source]¶

Gets details about the specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group (peering location of the circuit). Required.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection (service key of the circuit). Required.

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

ExpressRouteCrossConnection

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCrossConnection][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 ExpressRouteCrossConnection or the result of cls(response)
Return type: ItemPaged[ExpressRouteCrossConnection]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteCrossConnection][source]¶

Retrieves all the ExpressRouteCrossConnections in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteGatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_gateways attribute.

begin_create_or_update(resource_group_name: str, express_route_gateway_name: str, put_express_route_gateway_parameters: _models.ExpressRouteGateway, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteGateway][source]¶

begin_create_or_update(resource_group_name: str, express_route_gateway_name: str, put_express_route_gateway_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRouteGateway]

Creates or updates a ExpressRoute gateway in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_gateway_name (str) – The name of the ExpressRoute gateway. Required.
put_express_route_gateway_parameters (ExpressRouteGateway or IO) – Parameters required in an ExpressRoute gateway PUT operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ExpressRouteGateway or the result of cls(response)

Return type

LROPoller[ExpressRouteGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, express_route_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_gateway_name (str) – The name of the ExpressRoute gateway. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, express_route_gateway_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteGateway[source]¶

Fetches the details of a ExpressRoute gateway in a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_gateway_name (str) – The name of the ExpressRoute gateway. Required.

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

ExpressRouteGateway

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteGatewayList[source]¶

Lists ExpressRoute gateways in a given resource group.

Parameters: resource_group_name (str) – The name of the resource group. Required.
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: ExpressRouteGatewayList
Raises: HttpResponseError –

list_by_subscription(**kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.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: ExpressRouteGatewayList
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteLinksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_links attribute.

get(resource_group_name: str, express_route_port_name: str, link_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteLink[source]¶

Retrieves the specified ExpressRouteLink resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_port_name (str) – The name of the ExpressRoutePort resource. Required.
link_name (str) – The name of the ExpressRouteLink resource. Required.

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

ExpressRouteLink

Raises

HttpResponseError –

list(resource_group_name: str, express_route_port_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteLink][source]¶

Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_port_name (str) – The name of the ExpressRoutePort resource. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ExpressRouteLink]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRoutePortsLocationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_ports_locations attribute.

get(location_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.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. Required.
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: ExpressRoutePortsLocation
Raises: HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRoutePortsLocation][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 Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ExpressRoutePortsLocation or the result of cls(response)
Return type: ItemPaged[ExpressRoutePortsLocation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRoutePortsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_ports attribute.

begin_create_or_update(resource_group_name: str, express_route_port_name: str, parameters: _models.ExpressRoutePort, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRoutePort][source]¶

begin_create_or_update(resource_group_name: str, express_route_port_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRoutePort]

Creates or updates the specified ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_port_name (str) – The name of the ExpressRoutePort resource. Required.
parameters (ExpressRoutePort or IO) – Parameters supplied to the create ExpressRoutePort operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ExpressRoutePort]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, express_route_port_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_port_name (str) – The name of the ExpressRoutePort resource. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, express_route_port_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRoutePort][source]¶

begin_update_tags(resource_group_name: str, express_route_port_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExpressRoutePort]

Update ExpressRoutePort tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_port_name (str) – The name of the ExpressRoutePort resource. Required.
parameters (TagsObject or IO) – Parameters supplied to update ExpressRoutePort resource tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ExpressRoutePort]

Raises

HttpResponseError –

get(resource_group_name: str, express_route_port_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRoutePort[source]¶

Retrieves the requested ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
express_route_port_name (str) – The name of ExpressRoutePort. Required.

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

ExpressRoutePort

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRoutePort][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 ExpressRoutePort or the result of cls(response)
Return type: ItemPaged[ExpressRoutePort]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRoutePort][source]¶

List all the ExpressRoutePort resources in the specified resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ExpressRouteServiceProvidersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s express_route_service_providers attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ExpressRouteServiceProvider][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 ExpressRouteServiceProvider or the result of cls(response)
Return type: ItemPaged[ExpressRouteServiceProvider]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.HubVirtualNetworkConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s hub_virtual_network_connections attribute.

get(resource_group_name: str, virtual_hub_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.HubVirtualNetworkConnection[source]¶

Retrieves the details of a HubVirtualNetworkConnection.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub. Required.
virtual_hub_name (str) – The name of the VirtualHub. Required.
connection_name (str) – The name of the vpn connection. Required.

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

HubVirtualNetworkConnection

Raises

HttpResponseError –

list(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.HubVirtualNetworkConnection][source]¶

Retrieves the details of all HubVirtualNetworkConnections.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub. Required.
virtual_hub_name (str) – The name of the VirtualHub. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[HubVirtualNetworkConnection]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.InboundNatRulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s inbound_nat_rules attribute.

begin_create_or_update(resource_group_name: str, load_balancer_name: str, inbound_nat_rule_name: str, inbound_nat_rule_parameters: _models.InboundNatRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InboundNatRule][source]¶

begin_create_or_update(resource_group_name: str, load_balancer_name: str, inbound_nat_rule_name: str, inbound_nat_rule_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InboundNatRule]

Creates or updates a load balancer inbound nat rule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
inbound_nat_rule_name (str) – The name of the inbound nat rule. Required.
inbound_nat_rule_parameters (InboundNatRule or IO) – Parameters supplied to the create or update inbound nat rule operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 InboundNatRule or the result of cls(response)

Return type

LROPoller[InboundNatRule]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, load_balancer_name: str, inbound_nat_rule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified load balancer inbound nat rule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
inbound_nat_rule_name (str) – The name of the inbound nat rule. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

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

Gets the specified load balancer inbound nat rule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
inbound_nat_rule_name (str) – The name of the inbound nat rule. Required.
expand (str) – Expands referenced resources. Default value is None.

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

HttpResponseError –

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.InboundNatRule][source]¶

Gets all the inbound nat rules in a load balancer.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[InboundNatRule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.InterfaceEndpointsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s interface_endpoints attribute.

begin_create_or_update(resource_group_name: str, interface_endpoint_name: str, parameters: _models.InterfaceEndpoint, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InterfaceEndpoint][source]¶

begin_create_or_update(resource_group_name: str, interface_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InterfaceEndpoint]

Creates or updates an interface endpoint in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
interface_endpoint_name (str) – The name of the interface endpoint. Required.
parameters (InterfaceEndpoint or IO) – Parameters supplied to the create or update interface endpoint operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[InterfaceEndpoint]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, interface_endpoint_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified interface endpoint.

Parameters

resource_group_name (str) – The name of the resource group. Required.
interface_endpoint_name (str) – The name of the interface endpoint. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, interface_endpoint_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.InterfaceEndpoint[source]¶

Gets the specified interface endpoint by resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
interface_endpoint_name (str) – The name of the interface endpoint. Required.
expand (str) – Expands referenced resources. Default value is None.

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

InterfaceEndpoint

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.InterfaceEndpoint][source]¶

Gets all interface endpoints in a resource group.

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

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.InterfaceEndpoint][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 InterfaceEndpoint or the result of cls(response)
Return type: ItemPaged[InterfaceEndpoint]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LoadBalancerBackendAddressPoolsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s load_balancer_backend_address_pools attribute.

get(resource_group_name: str, load_balancer_name: str, backend_address_pool_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.BackendAddressPool[source]¶

Gets load balancer backend address pool.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
backend_address_pool_name (str) – The name of the backend address pool. Required.

Keyword Arguments

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

Returns

BackendAddressPool or the result of cls(response)

Return type

BackendAddressPool

Raises

HttpResponseError –

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.BackendAddressPool][source]¶

Gets all the load balancer backed address pools.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[BackendAddressPool]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LoadBalancerFrontendIPConfigurationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s load_balancer_frontend_ip_configurations attribute.

get(resource_group_name: str, load_balancer_name: str, frontend_ip_configuration_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.FrontendIPConfiguration[source]¶

Gets load balancer frontend IP configuration.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
frontend_ip_configuration_name (str) – The name of the frontend IP configuration. Required.

Keyword Arguments

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

Returns

FrontendIPConfiguration or the result of cls(response)

Return type

FrontendIPConfiguration

Raises

HttpResponseError –

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.FrontendIPConfiguration][source]¶

Gets all the load balancer frontend IP configurations.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[FrontendIPConfiguration]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LoadBalancerLoadBalancingRulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s load_balancer_load_balancing_rules attribute.

get(resource_group_name: str, load_balancer_name: str, load_balancing_rule_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.LoadBalancingRule[source]¶

Gets the specified load balancer load balancing rule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
load_balancing_rule_name (str) – The name of the load balancing rule. Required.

Keyword Arguments

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

Returns

LoadBalancingRule or the result of cls(response)

Return type

LoadBalancingRule

Raises

HttpResponseError –

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.LoadBalancingRule][source]¶

Gets all the load balancing rules in a load balancer.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LoadBalancingRule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LoadBalancerNetworkInterfacesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s load_balancer_network_interfaces attribute.

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterface][source]¶

Gets associated load balancer network interfaces.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NetworkInterface]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LoadBalancerOutboundRulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s load_balancer_outbound_rules attribute.

get(resource_group_name: str, load_balancer_name: str, outbound_rule_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.OutboundRule[source]¶

Gets the specified load balancer outbound rule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
outbound_rule_name (str) – The name of the outbound rule. Required.

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

HttpResponseError –

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.OutboundRule][source]¶

Gets all the outbound rules in a load balancer.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[OutboundRule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LoadBalancerProbesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s load_balancer_probes attribute.

get(resource_group_name: str, load_balancer_name: str, probe_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.Probe[source]¶

Gets load balancer probe.

Parameters

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

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

HttpResponseError –

list(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.Probe][source]¶

Gets all the load balancer probes.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Probe]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LoadBalancersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s load_balancers attribute.

begin_create_or_update(resource_group_name: str, load_balancer_name: str, parameters: _models.LoadBalancer, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LoadBalancer][source]¶

begin_create_or_update(resource_group_name: str, load_balancer_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LoadBalancer]

Creates or updates a load balancer.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
parameters (LoadBalancer or IO) – Parameters supplied to the create or update load balancer operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[LoadBalancer]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, load_balancer_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified load balancer.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, load_balancer_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LoadBalancer][source]¶

begin_update_tags(resource_group_name: str, load_balancer_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LoadBalancer]

Updates a load balancer tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
parameters (TagsObject or IO) – Parameters supplied to update load balancer tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[LoadBalancer]

Raises

HttpResponseError –

get(resource_group_name: str, load_balancer_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.LoadBalancer[source]¶

Gets the specified load balancer.

Parameters

resource_group_name (str) – The name of the resource group. Required.
load_balancer_name (str) – The name of the load balancer. Required.
expand (str) – Expands referenced resources. Default value is None.

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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.LoadBalancer][source]¶

Gets all the load balancers in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.LoadBalancer][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 LoadBalancer or the result of cls(response)
Return type: ItemPaged[LoadBalancer]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.LocalNetworkGatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s local_network_gateways attribute.

begin_create_or_update(resource_group_name: str, local_network_gateway_name: str, parameters: _models.LocalNetworkGateway, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LocalNetworkGateway][source]¶

begin_create_or_update(resource_group_name: str, local_network_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LocalNetworkGateway]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
local_network_gateway_name (str) – The name of the local network gateway. Required.
parameters (LocalNetworkGateway or IO) – Parameters supplied to the create or update local network gateway operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[LocalNetworkGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, local_network_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified local network gateway.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, local_network_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LocalNetworkGateway][source]¶

begin_update_tags(resource_group_name: str, local_network_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LocalNetworkGateway]

Updates a local network gateway tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
local_network_gateway_name (str) – The name of the local network gateway. Required.
parameters (TagsObject or IO) – Parameters supplied to update local network gateway tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[LocalNetworkGateway]

Raises

HttpResponseError –

get(resource_group_name: str, local_network_gateway_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.LocalNetworkGateway[source]¶

Gets the specified local network gateway in a resource group.

Parameters

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

Keyword Arguments

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

Returns

LocalNetworkGateway or the result of cls(response)

Return type

LocalNetworkGateway

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.LocalNetworkGateway][source]¶

Gets all the local network gateways in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.NatGatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s nat_gateways attribute.

begin_create_or_update(resource_group_name: str, nat_gateway_name: str, parameters: _models.NatGateway, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NatGateway][source]¶

begin_create_or_update(resource_group_name: str, nat_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NatGateway]

Creates or updates a nat gateway.

Parameters

resource_group_name (str) – The name of the resource group. Required.
nat_gateway_name (str) – The name of the nat gateway. Required.
parameters (NatGateway or IO) – Parameters supplied to the create or update nat gateway operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[NatGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, nat_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified nat gateway.

Parameters

resource_group_name (str) – The name of the resource group. Required.
nat_gateway_name (str) – The name of the nat gateway. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, nat_gateway_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.NatGateway[source]¶

Gets the specified nat gateway in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
nat_gateway_name (str) – The name of the nat gateway. Required.
expand (str) – Expands referenced resources. Default value is None.

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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NatGateway][source]¶

Gets all nat gateways in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NatGateway][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 NatGateway or the result of cls(response)
Return type: ItemPaged[NatGateway]
Raises: HttpResponseError –

update_tags(resource_group_name: str, nat_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NatGateway[source]¶

update_tags(resource_group_name: str, nat_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NatGateway

Updates nat gateway tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
nat_gateway_name (str) – The name of the nat gateway. Required.
parameters (TagsObject or IO) – Parameters supplied to update nat gateway tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.NetworkInterfaceIPConfigurationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s network_interface_ip_configurations attribute.

get(resource_group_name: str, network_interface_name: str, ip_configuration_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterfaceIPConfiguration[source]¶

Gets the specified network interface ip configuration.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_interface_name (str) – The name of the network interface. Required.
ip_configuration_name (str) – The name of the ip configuration name. Required.

Keyword Arguments

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

Returns

NetworkInterfaceIPConfiguration or the result of cls(response)

Return type

NetworkInterfaceIPConfiguration

Raises

HttpResponseError –

list(resource_group_name: str, network_interface_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterfaceIPConfiguration][source]¶

Get all ip configurations in a network interface.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NetworkInterfaceIPConfiguration]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.NetworkInterfaceLoadBalancersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s network_interface_load_balancers attribute.

list(resource_group_name: str, network_interface_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.LoadBalancer][source]¶

List all load balancers in a network interface.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LoadBalancer]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.NetworkInterfaceTapConfigurationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s network_interface_tap_configurations attribute.

begin_create_or_update(resource_group_name: str, network_interface_name: str, tap_configuration_name: str, tap_configuration_parameters: _models.NetworkInterfaceTapConfiguration, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkInterfaceTapConfiguration][source]¶

begin_create_or_update(resource_group_name: str, network_interface_name: str, tap_configuration_name: str, tap_configuration_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkInterfaceTapConfiguration]

Creates or updates a Tap configuration in the specified NetworkInterface.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_interface_name (str) – The name of the network interface. Required.
tap_configuration_name (str) – The name of the tap configuration. Required.
tap_configuration_parameters (NetworkInterfaceTapConfiguration or IO) – Parameters supplied to the create or update tap configuration operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 NetworkInterfaceTapConfiguration or the result of cls(response)

Return type

LROPoller[NetworkInterfaceTapConfiguration]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_interface_name: str, tap_configuration_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified tap configuration from the NetworkInterface.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_interface_name (str) – The name of the network interface. Required.
tap_configuration_name (str) – The name of the tap configuration. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, network_interface_name: str, tap_configuration_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterfaceTapConfiguration[source]¶

Get the specified tap configuration on a network interface.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_interface_name (str) – The name of the network interface. Required.
tap_configuration_name (str) – The name of the tap configuration. Required.

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

NetworkInterfaceTapConfiguration

Raises

HttpResponseError –

list(resource_group_name: str, network_interface_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterfaceTapConfiguration][source]¶

Get all Tap configurations in a network interface.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NetworkInterfaceTapConfiguration]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.NetworkInterfacesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s network_interfaces attribute.

begin_create_or_update(resource_group_name: str, network_interface_name: str, parameters: _models.NetworkInterface, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkInterface][source]¶

begin_create_or_update(resource_group_name: str, network_interface_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkInterface]

Creates or updates a network interface.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_interface_name (str) – The name of the network interface. Required.
parameters (NetworkInterface or IO) – Parameters supplied to the create or update network interface operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NetworkInterface]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_interface_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified network interface.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_get_effective_route_table(resource_group_name: str, network_interface_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.EffectiveRouteListResult][source]¶

Gets all route tables applied to a network interface.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[EffectiveRouteListResult]

Raises

HttpResponseError –

begin_list_effective_network_security_groups(resource_group_name: str, network_interface_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.EffectiveNetworkSecurityGroupListResult][source]¶

Gets all network security groups applied to a network interface.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[EffectiveNetworkSecurityGroupListResult]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, network_interface_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkInterface][source]¶

begin_update_tags(resource_group_name: str, network_interface_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkInterface]

Updates a network interface tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_interface_name (str) – The name of the network interface. Required.
parameters (TagsObject or IO) – Parameters supplied to update network interface tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NetworkInterface]

Raises

HttpResponseError –

get(resource_group_name: str, network_interface_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterface[source]¶

Gets information about the specified network interface.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_interface_name (str) – The name of the network interface. Required.
expand (str) – Expands referenced resources. Default value is None.

Keyword Arguments

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

Returns

NetworkInterface or the result of cls(response)

Return type

NetworkInterface

Raises

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) → azure.mgmt.network.v2019_02_01.models._models_py3.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. Required.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set. Required.
virtualmachine_index (str) – The virtual machine index. Required.
network_interface_name (str) – The name of the network interface. Required.
ip_configuration_name (str) – The name of the ip configuration. Required.
expand (str) – Expands referenced resources. Default value is None.

Keyword Arguments

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

Returns

NetworkInterfaceIPConfiguration or the result of cls(response)

Return type

NetworkInterfaceIPConfiguration

Raises

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) → azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterface[source]¶

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

Parameters

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

Keyword Arguments

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

Returns

NetworkInterface or the result of cls(response)

Return type

NetworkInterface

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterface][source]¶

Gets all network interfaces in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterface][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 NetworkInterface or the result of cls(response)
Return type: ItemPaged[NetworkInterface]
Raises: 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[azure.mgmt.network.v2019_02_01.models._models_py3.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. Required.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set. Required.
virtualmachine_index (str) – The virtual machine index. Required.
network_interface_name (str) – The name of the network interface. Required.
expand (str) – Expands referenced resources. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NetworkInterfaceIPConfiguration]

Raises

HttpResponseError –

list_virtual_machine_scale_set_network_interfaces(resource_group_name: str, virtual_machine_scale_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterface][source]¶

Gets all network interfaces in a virtual machine scale set.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NetworkInterface]

Raises

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[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkInterface][source]¶

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

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NetworkInterface]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

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

Bases: azure.mgmt.network.v2019_02_01._vendor.MixinABC

check_dns_name_availability(location: str, domain_name_label: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.DnsNameAvailabilityResult[source]¶

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

Parameters

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

Keyword Arguments

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

Returns

DnsNameAvailabilityResult or the result of cls(response)

Return type

DnsNameAvailabilityResult

Raises

HttpResponseError –

supported_security_providers(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualWanSecurityProviders[source]¶

Gives the supported security providers for the virtual wan.

Parameters

resource_group_name (str) – The resource group name. Required.
virtual_wan_name (str) – The name of the VirtualWAN for which supported security providers are needed. Required.

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

VirtualWanSecurityProviders

Raises

HttpResponseError –

class azure.mgmt.network.v2019_02_01.operations.NetworkProfilesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s network_profiles attribute.

begin_delete(resource_group_name: str, network_profile_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified network profile.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_profile_name (str) – The name of the NetworkProfile. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

create_or_update(resource_group_name: str, network_profile_name: str, parameters: _models.NetworkProfile, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkProfile[source]¶

create_or_update(resource_group_name: str, network_profile_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkProfile

Creates or updates a network profile.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_profile_name (str) – The name of the network profile. Required.
parameters (NetworkProfile or IO) – Parameters supplied to the create or update network profile operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

get(resource_group_name: str, network_profile_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.NetworkProfile[source]¶

Gets the specified network profile in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_profile_name (str) – The name of the public IP prefix. Required.
expand (str) – Expands referenced resources. Default value is None.

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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkProfile][source]¶

Gets all network profiles in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkProfile][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 NetworkProfile or the result of cls(response)
Return type: ItemPaged[NetworkProfile]
Raises: HttpResponseError –

update_tags(resource_group_name: str, network_profile_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkProfile[source]¶

update_tags(resource_group_name: str, network_profile_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkProfile

Updates network profile tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_profile_name (str) – The name of the network profile. Required.
parameters (TagsObject or IO) – Parameters supplied to update network profile tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.NetworkSecurityGroupsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s network_security_groups attribute.

begin_create_or_update(resource_group_name: str, network_security_group_name: str, parameters: _models.NetworkSecurityGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkSecurityGroup][source]¶

begin_create_or_update(resource_group_name: str, network_security_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkSecurityGroup]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_security_group_name (str) – The name of the network security group. Required.
parameters (NetworkSecurityGroup or IO) – Parameters supplied to the create or update network security group operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[NetworkSecurityGroup]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_security_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified network security group.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, network_security_group_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkSecurityGroup][source]¶

begin_update_tags(resource_group_name: str, network_security_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkSecurityGroup]

Updates a network security group tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_security_group_name (str) – The name of the network security group. Required.
parameters (TagsObject or IO) – Parameters supplied to update network security group tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[NetworkSecurityGroup]

Raises

HttpResponseError –

get(resource_group_name: str, network_security_group_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.NetworkSecurityGroup[source]¶

Gets the specified network security group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_security_group_name (str) – The name of the network security group. Required.
expand (str) – Expands referenced resources. Default value is None.

Keyword Arguments

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

Returns

NetworkSecurityGroup or the result of cls(response)

Return type

NetworkSecurityGroup

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkSecurityGroup][source]¶

Gets all network security groups in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkSecurityGroup][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 NetworkSecurityGroup or the result of cls(response)
Return type: ItemPaged[NetworkSecurityGroup]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.NetworkWatchersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s network_watchers attribute.

begin_check_connectivity(resource_group_name: str, network_watcher_name: str, parameters: _models.ConnectivityParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectivityInformation][source]¶

begin_check_connectivity(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectivityInformation]

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

Parameters

resource_group_name (str) – The name of the network watcher resource group. Required.
network_watcher_name (str) – The name of the network watcher resource. Required.
parameters (ConnectivityParameters or IO) – Parameters that determine how the connectivity check will be performed. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ConnectivityInformation or the result of cls(response)

Return type

LROPoller[ConnectivityInformation]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified network watcher resource.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_get_azure_reachability_report(resource_group_name: str, network_watcher_name: str, parameters: _models.AzureReachabilityReportParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AzureReachabilityReport][source]¶

begin_get_azure_reachability_report(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AzureReachabilityReport]

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

Parameters

resource_group_name (str) – The name of the network watcher resource group. Required.
network_watcher_name (str) – The name of the network watcher resource. Required.
parameters (AzureReachabilityReportParameters or IO) – Parameters that determine Azure reachability report configuration. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 AzureReachabilityReport or the result of cls(response)

Return type

LROPoller[AzureReachabilityReport]

Raises

HttpResponseError –

begin_get_flow_log_status(resource_group_name: str, network_watcher_name: str, parameters: _models.FlowLogStatusParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FlowLogInformation][source]¶

begin_get_flow_log_status(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FlowLogInformation]

Queries status of flow log and traffic analytics (optional) on a specified resource.

Parameters

resource_group_name (str) – The name of the network watcher resource group. Required.
network_watcher_name (str) – The name of the network watcher resource. Required.
parameters (FlowLogStatusParameters or IO) – Parameters that define a resource to query flow log and traffic analytics (optional) status. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[FlowLogInformation]

Raises

HttpResponseError –

begin_get_network_configuration_diagnostic(resource_group_name: str, network_watcher_name: str, parameters: _models.NetworkConfigurationDiagnosticParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkConfigurationDiagnosticResponse][source]¶

begin_get_network_configuration_diagnostic(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NetworkConfigurationDiagnosticResponse]

Get network configuration diagnostic.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher. Required.
parameters (NetworkConfigurationDiagnosticParameters or IO) – Parameters to get network configuration diagnostic. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[NetworkConfigurationDiagnosticResponse]

Raises

HttpResponseError –

begin_get_next_hop(resource_group_name: str, network_watcher_name: str, parameters: _models.NextHopParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NextHopResult][source]¶

begin_get_next_hop(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NextHopResult]

Gets the next hop from the specified VM.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher. Required.
parameters (NextHopParameters or IO) – Parameters that define the source and destination endpoint. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NextHopResult]

Raises

HttpResponseError –

begin_get_troubleshooting(resource_group_name: str, network_watcher_name: str, parameters: _models.TroubleshootingParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.TroubleshootingResult][source]¶

begin_get_troubleshooting(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.TroubleshootingResult]

Initiate troubleshooting on a specified resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher resource. Required.
parameters (TroubleshootingParameters or IO) – Parameters that define the resource to troubleshoot. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[TroubleshootingResult]

Raises

HttpResponseError –

begin_get_troubleshooting_result(resource_group_name: str, network_watcher_name: str, parameters: _models.QueryTroubleshootingParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.TroubleshootingResult][source]¶

begin_get_troubleshooting_result(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.TroubleshootingResult]

Get the last completed troubleshooting result on a specified resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher resource. Required.
parameters (QueryTroubleshootingParameters or IO) – Parameters that define the resource to query the troubleshooting result. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[TroubleshootingResult]

Raises

HttpResponseError –

begin_get_vm_security_rules(resource_group_name: str, network_watcher_name: str, parameters: _models.SecurityGroupViewParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityGroupViewResult][source]¶

begin_get_vm_security_rules(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityGroupViewResult]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher. Required.
parameters (SecurityGroupViewParameters or IO) – Parameters that define the VM to check security groups for. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SecurityGroupViewResult]

Raises

HttpResponseError –

begin_list_available_providers(resource_group_name: str, network_watcher_name: str, parameters: _models.AvailableProvidersListParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AvailableProvidersList][source]¶

begin_list_available_providers(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AvailableProvidersList]

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

Parameters

resource_group_name (str) – The name of the network watcher resource group. Required.
network_watcher_name (str) – The name of the network watcher resource. Required.
parameters (AvailableProvidersListParameters or IO) – Parameters that scope the list of available providers. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[AvailableProvidersList]

Raises

HttpResponseError –

begin_set_flow_log_configuration(resource_group_name: str, network_watcher_name: str, parameters: _models.FlowLogInformation, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FlowLogInformation][source]¶

begin_set_flow_log_configuration(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FlowLogInformation]

Configures flow log and traffic analytics (optional) on a specified resource.

Parameters

resource_group_name (str) – The name of the network watcher resource group. Required.
network_watcher_name (str) – The name of the network watcher resource. Required.
parameters (FlowLogInformation or IO) – Parameters that define the configuration of flow log. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[FlowLogInformation]

Raises

HttpResponseError –

begin_verify_ip_flow(resource_group_name: str, network_watcher_name: str, parameters: _models.VerificationIPFlowParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VerificationIPFlowResult][source]¶

begin_verify_ip_flow(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VerificationIPFlowResult]

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. Required.
network_watcher_name (str) – The name of the network watcher. Required.
parameters (VerificationIPFlowParameters or IO) – Parameters that define the IP flow to be verified. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[VerificationIPFlowResult]

Raises

HttpResponseError –

create_or_update(resource_group_name: str, network_watcher_name: str, parameters: _models.NetworkWatcher, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkWatcher[source]¶

create_or_update(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkWatcher

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher. Required.
parameters (NetworkWatcher or IO) – Parameters that define the network watcher resource. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

get(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.NetworkWatcher[source]¶

Gets the specified network watcher by resource group.

Parameters

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

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

HttpResponseError –

get_topology(resource_group_name: str, network_watcher_name: str, parameters: _models.TopologyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Topology[source]¶

get_topology(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Topology

Gets the current network topology by resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher. Required.
parameters (TopologyParameters or IO) – Parameters that define the representation of topology. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkWatcher][source]¶

Gets all network watchers by resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.NetworkWatcher][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 NetworkWatcher or the result of cls(response)
Return type: ItemPaged[NetworkWatcher]
Raises: HttpResponseError –

update_tags(resource_group_name: str, network_watcher_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkWatcher[source]¶

update_tags(resource_group_name: str, network_watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkWatcher

Updates a network watcher tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher. Required.
parameters (TagsObject or IO) – Parameters supplied to update network watcher tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.Operation][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 Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.P2SVpnGatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s p2_svpn_gateways attribute.

begin_create_or_update(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: _models.P2SVpnGateway, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.P2SVpnGateway][source]¶

begin_create_or_update(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.P2SVpnGateway]

Creates a virtual wan p2s vpn gateway if it doesn’t exist else updates the existing gateway.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.
p2_s_vpn_gateway_parameters (P2SVpnGateway or IO) – Parameters supplied to create or Update a virtual wan p2s vpn gateway. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 P2SVpnGateway or the result of cls(response)

Return type

LROPoller[P2SVpnGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a virtual wan p2s vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_generate_vpn_profile(resource_group_name: str, gateway_name: str, parameters: _models.P2SVpnProfileParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnProfileResponse][source]¶

begin_generate_vpn_profile(resource_group_name: str, gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnProfileResponse]

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
gateway_name (str) – The name of the P2SVpnGateway. Required.
parameters (P2SVpnProfileParameters or IO) – Parameters supplied to the generate P2SVpnGateway VPN client package operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 VpnProfileResponse or the result of cls(response)

Return type

LROPoller[VpnProfileResponse]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.P2SVpnGateway][source]¶

begin_update_tags(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.P2SVpnGateway]

Updates virtual wan p2s vpn gateway tags.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.
p2_s_vpn_gateway_parameters (TagsObject or IO) – Parameters supplied to update a virtual wan p2s vpn gateway tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 P2SVpnGateway or the result of cls(response)

Return type

LROPoller[P2SVpnGateway]

Raises

HttpResponseError –

get(resource_group_name: str, gateway_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.P2SVpnGateway[source]¶

Retrieves the details of a virtual wan p2s vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.P2SVpnGateway][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 P2SVpnGateway or the result of cls(response)
Return type: ItemPaged[P2SVpnGateway]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.P2SVpnGateway][source]¶

Lists all the P2SVpnGateways in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.P2SVpnServerConfigurationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s p2_svpn_server_configurations attribute.

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, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.P2SVpnServerConfiguration][source]¶

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: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.P2SVpnServerConfiguration]

Creates a P2SVpnServerConfiguration to associate with a VirtualWan if it doesn’t exist else updates the existing P2SVpnServerConfiguration.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan. Required.
virtual_wan_name (str) – The name of the VirtualWan. Required.
p2_s_vpn_server_configuration_name (str) – The name of the P2SVpnServerConfiguration. Required.
p2_s_vpn_server_configuration_parameters (P2SVpnServerConfiguration or IO) – Parameters supplied to create or Update a P2SVpnServerConfiguration. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 P2SVpnServerConfiguration or the result of cls(response)

Return type

LROPoller[P2SVpnServerConfiguration]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_wan_name: str, p2_s_vpn_server_configuration_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a P2SVpnServerConfiguration.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnServerConfiguration. Required.
virtual_wan_name (str) – The name of the VirtualWan. Required.
p2_s_vpn_server_configuration_name (str) – The name of the P2SVpnServerConfiguration. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_wan_name: str, p2_s_vpn_server_configuration_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.P2SVpnServerConfiguration[source]¶

Retrieves the details of a P2SVpnServerConfiguration.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnServerConfiguration. Required.
virtual_wan_name (str) – The name of the VirtualWan. Required.
p2_s_vpn_server_configuration_name (str) – The name of the P2SVpnServerConfiguration. Required.

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

P2SVpnServerConfiguration

Raises

HttpResponseError –

list_by_virtual_wan(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.P2SVpnServerConfiguration][source]¶

Retrieves all P2SVpnServerConfigurations for a particular VirtualWan.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan. Required.
virtual_wan_name (str) – The name of the VirtualWan. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[P2SVpnServerConfiguration]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.PacketCapturesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s packet_captures attribute.

begin_create(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, parameters: _models.PacketCapture, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PacketCaptureResult][source]¶

begin_create(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PacketCaptureResult]

Create and start a packet capture on the specified VM.

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_watcher_name (str) – The name of the network watcher. Required.
packet_capture_name (str) – The name of the packet capture session. Required.
parameters (PacketCapture or IO) – Parameters that define the create packet capture operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PacketCaptureResult]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified packet capture session.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_get_status(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.PacketCaptureQueryStatusResult][source]¶

Query the status of a running packet capture session.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PacketCaptureQueryStatusResult]

Raises

HttpResponseError –

begin_stop(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Stops a specified packet capture session.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, network_watcher_name: str, packet_capture_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.PacketCaptureResult[source]¶

Gets a packet capture session by name.

Parameters

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

Keyword Arguments

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

Returns

PacketCaptureResult or the result of cls(response)

Return type

PacketCaptureResult

Raises

HttpResponseError –

list(resource_group_name: str, network_watcher_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.PacketCaptureResult][source]¶

Lists all packet capture sessions within the specified resource group.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PacketCaptureResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.PeerExpressRouteCircuitConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s peer_express_route_circuit_connections attribute.

get(resource_group_name: str, circuit_name: str, peering_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.PeerExpressRouteCircuitConnection[source]¶

Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.

Parameters

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

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

PeerExpressRouteCircuitConnection

Raises

HttpResponseError –

list(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.PeerExpressRouteCircuitConnection][source]¶

Gets all global reach peer connections associated with a private peering in an express route circuit.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PeerExpressRouteCircuitConnection]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.PublicIPAddressesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s public_ip_addresses attribute.

begin_create_or_update(resource_group_name: str, public_ip_address_name: str, parameters: _models.PublicIPAddress, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPAddress][source]¶

begin_create_or_update(resource_group_name: str, public_ip_address_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPAddress]

Creates or updates a static or dynamic public IP address.

Parameters

resource_group_name (str) – The name of the resource group. Required.
public_ip_address_name (str) – The name of the public IP address. Required.
parameters (PublicIPAddress or IO) – Parameters supplied to the create or update public IP address operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PublicIPAddress]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, public_ip_address_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified public IP address.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, public_ip_address_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPAddress][source]¶

begin_update_tags(resource_group_name: str, public_ip_address_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPAddress]

Updates public IP address tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
public_ip_address_name (str) – The name of the public IP address. Required.
parameters (TagsObject or IO) – Parameters supplied to update public IP address tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PublicIPAddress]

Raises

HttpResponseError –

get(resource_group_name: str, public_ip_address_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPAddress[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
public_ip_address_name (str) – The name of the subnet. Required.
expand (str) – Expands referenced resources. Default value is None.

Keyword Arguments

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

Returns

PublicIPAddress or the result of cls(response)

Return type

PublicIPAddress

Raises

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) → azure.mgmt.network.v2019_02_01.models._models_py3.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. Required.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set. Required.
virtualmachine_index (str) – The virtual machine index. Required.
network_interface_name (str) – The name of the network interface. Required.
ip_configuration_name (str) – The name of the IP configuration. Required.
public_ip_address_name (str) – The name of the public IP Address. Required.
expand (str) – Expands referenced resources. Default value is None.

Keyword Arguments

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

Returns

PublicIPAddress or the result of cls(response)

Return type

PublicIPAddress

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPAddress][source]¶

Gets all public IP addresses in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPAddress][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 PublicIPAddress or the result of cls(response)
Return type: ItemPaged[PublicIPAddress]
Raises: HttpResponseError –

list_virtual_machine_scale_set_public_ip_addresses(resource_group_name: str, virtual_machine_scale_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPAddress][source]¶

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

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PublicIPAddress]

Raises

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[azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPAddress][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set. Required.
virtualmachine_index (str) – The virtual machine index. Required.
network_interface_name (str) – The network interface name. Required.
ip_configuration_name (str) – The IP configuration name. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PublicIPAddress]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.PublicIPPrefixesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s public_ip_prefixes attribute.

begin_create_or_update(resource_group_name: str, public_ip_prefix_name: str, parameters: _models.PublicIPPrefix, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPPrefix][source]¶

begin_create_or_update(resource_group_name: str, public_ip_prefix_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPPrefix]

Creates or updates a static or dynamic public IP prefix.

Parameters

resource_group_name (str) – The name of the resource group. Required.
public_ip_prefix_name (str) – The name of the public IP prefix. Required.
parameters (PublicIPPrefix or IO) – Parameters supplied to the create or update public IP prefix operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[PublicIPPrefix]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, public_ip_prefix_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified public IP prefix.

Parameters

resource_group_name (str) – The name of the resource group. Required.
public_ip_prefix_name (str) – The name of the PublicIpPrefix. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, public_ip_prefix_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPPrefix][source]¶

begin_update_tags(resource_group_name: str, public_ip_prefix_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PublicIPPrefix]

Updates public IP prefix tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
public_ip_prefix_name (str) – The name of the public IP prefix. Required.
parameters (TagsObject or IO) – Parameters supplied to update public IP prefix tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[PublicIPPrefix]

Raises

HttpResponseError –

get(resource_group_name: str, public_ip_prefix_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPPrefix[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
public_ip_prefix_name (str) – The name of the public IP prefix. Required.
expand (str) – Expands referenced resources. Default value is None.

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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPPrefix][source]¶

Gets all public IP prefixes in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.PublicIPPrefix][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 PublicIPPrefix or the result of cls(response)
Return type: ItemPaged[PublicIPPrefix]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ResourceNavigationLinksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s resource_navigation_links attribute.

get(resource_group_name: str, virtual_network_name: str, subnet_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ResourceNavigationLinksListResult[source]¶

Gets a list of resource navigation links for a subnet.

Parameters

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

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

ResourceNavigationLinksListResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.RouteFilterRulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s route_filter_rules attribute.

begin_create_or_update(resource_group_name: str, route_filter_name: str, rule_name: str, route_filter_rule_parameters: _models.RouteFilterRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilterRule][source]¶

begin_create_or_update(resource_group_name: str, route_filter_name: str, rule_name: str, route_filter_rule_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilterRule]

Creates or updates a route in the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_filter_name (str) – The name of the route filter. Required.
rule_name (str) – The name of the route filter rule. Required.
route_filter_rule_parameters (RouteFilterRule or IO) – Parameters supplied to the create or update route filter rule operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 RouteFilterRule or the result of cls(response)

Return type

LROPoller[RouteFilterRule]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, route_filter_name: str, rule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified rule from a route filter.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, route_filter_name: str, rule_name: str, route_filter_rule_parameters: _models.PatchRouteFilterRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilterRule][source]¶

begin_update(resource_group_name: str, route_filter_name: str, rule_name: str, route_filter_rule_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilterRule]

Updates a route in the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_filter_name (str) – The name of the route filter. Required.
rule_name (str) – The name of the route filter rule. Required.
route_filter_rule_parameters (PatchRouteFilterRule or IO) – Parameters supplied to the update route filter rule operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 RouteFilterRule or the result of cls(response)

Return type

LROPoller[RouteFilterRule]

Raises

HttpResponseError –

get(resource_group_name: str, route_filter_name: str, rule_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.RouteFilterRule[source]¶

Gets the specified rule from a route filter.

Parameters

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

Keyword Arguments

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

Returns

RouteFilterRule or the result of cls(response)

Return type

RouteFilterRule

Raises

HttpResponseError –

list_by_route_filter(resource_group_name: str, route_filter_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.RouteFilterRule][source]¶

Gets all RouteFilterRules in a route filter.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RouteFilterRule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.RouteFiltersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s route_filters attribute.

begin_create_or_update(resource_group_name: str, route_filter_name: str, route_filter_parameters: _models.RouteFilter, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilter][source]¶

begin_create_or_update(resource_group_name: str, route_filter_name: str, route_filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilter]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_filter_name (str) – The name of the route filter. Required.
route_filter_parameters (RouteFilter or IO) – Parameters supplied to the create or update route filter operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[RouteFilter]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, route_filter_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified route filter.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, route_filter_name: str, route_filter_parameters: _models.PatchRouteFilter, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilter][source]¶

begin_update(resource_group_name: str, route_filter_name: str, route_filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteFilter]

Updates a route filter in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_filter_name (str) – The name of the route filter. Required.
route_filter_parameters (PatchRouteFilter or IO) – Parameters supplied to the update route filter operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[RouteFilter]

Raises

HttpResponseError –

get(resource_group_name: str, route_filter_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.RouteFilter[source]¶

Gets the specified route filter.

Parameters

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

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.RouteFilter][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 RouteFilter or the result of cls(response)
Return type: ItemPaged[RouteFilter]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.RouteFilter][source]¶

Gets all route filters in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.RouteTablesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s route_tables attribute.

begin_create_or_update(resource_group_name: str, route_table_name: str, parameters: _models.RouteTable, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteTable][source]¶

begin_create_or_update(resource_group_name: str, route_table_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteTable]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_table_name (str) – The name of the route table. Required.
parameters (RouteTable or IO) – Parameters supplied to the create or update route table operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[RouteTable]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, route_table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified route table.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, route_table_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteTable][source]¶

begin_update_tags(resource_group_name: str, route_table_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RouteTable]

Updates a route table tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_table_name (str) – The name of the route table. Required.
parameters (TagsObject or IO) – Parameters supplied to update route table tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[RouteTable]

Raises

HttpResponseError –

get(resource_group_name: str, route_table_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.RouteTable[source]¶

Gets the specified route table.

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_table_name (str) – The name of the route table. Required.
expand (str) – Expands referenced resources. Default value is None.

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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.RouteTable][source]¶

Gets all route tables in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.RouteTable][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 RouteTable or the result of cls(response)
Return type: ItemPaged[RouteTable]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.RoutesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s routes attribute.

begin_create_or_update(resource_group_name: str, route_table_name: str, route_name: str, route_parameters: _models.Route, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Route][source]¶

begin_create_or_update(resource_group_name: str, route_table_name: str, route_name: str, route_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Route]

Creates or updates a route in the specified route table.

Parameters

resource_group_name (str) – The name of the resource group. Required.
route_table_name (str) – The name of the route table. Required.
route_name (str) – The name of the route. Required.
route_parameters (Route or IO) – Parameters supplied to the create or update route operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Route]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, route_table_name: str, route_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified route from a route table.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, route_table_name: str, route_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.Route[source]¶

Gets the specified route from a route table.

Parameters

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

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

HttpResponseError –

list(resource_group_name: str, route_table_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.Route][source]¶

Gets all routes in a route table.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Route]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.SecurityRulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s security_rules attribute.

begin_create_or_update(resource_group_name: str, network_security_group_name: str, security_rule_name: str, security_rule_parameters: _models.SecurityRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityRule][source]¶

begin_create_or_update(resource_group_name: str, network_security_group_name: str, security_rule_name: str, security_rule_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityRule]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
network_security_group_name (str) – The name of the network security group. Required.
security_rule_name (str) – The name of the security rule. Required.
security_rule_parameters (SecurityRule or IO) – Parameters supplied to the create or update network security rule operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SecurityRule or the result of cls(response)

Return type

LROPoller[SecurityRule]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, network_security_group_name: str, security_rule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified network security rule.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, network_security_group_name: str, security_rule_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.SecurityRule[source]¶

Get the specified network security rule.

Parameters

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

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

HttpResponseError –

list(resource_group_name: str, network_security_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.SecurityRule][source]¶

Gets all security rules in a network security group.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SecurityRule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ServiceAssociationLinksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s service_association_links attribute.

get(resource_group_name: str, virtual_network_name: str, subnet_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ServiceAssociationLinksListResult[source]¶

Gets a list of service association links for a subnet.

Parameters

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

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

ServiceAssociationLinksListResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ServiceEndpointPoliciesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s service_endpoint_policies attribute.

begin_create_or_update(resource_group_name: str, service_endpoint_policy_name: str, parameters: _models.ServiceEndpointPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceEndpointPolicy][source]¶

begin_create_or_update(resource_group_name: str, service_endpoint_policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceEndpointPolicy]

Creates or updates a service Endpoint Policies.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the service endpoint policy. Required.
parameters (ServiceEndpointPolicy or IO) – Parameters supplied to the create or update service endpoint policy operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ServiceEndpointPolicy]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, service_endpoint_policy_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified service endpoint policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the service endpoint policy. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, service_endpoint_policy_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceEndpointPolicy][source]¶

begin_update(resource_group_name: str, service_endpoint_policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceEndpointPolicy]

Updates service Endpoint Policies.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the service endpoint policy. Required.
parameters (TagsObject or IO) – Parameters supplied to update service endpoint policy tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[ServiceEndpointPolicy]

Raises

HttpResponseError –

get(resource_group_name: str, service_endpoint_policy_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ServiceEndpointPolicy[source]¶

Gets the specified service Endpoint Policies in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the service endpoint policy. Required.
expand (str) – Expands referenced resources. Default value is None.

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

ServiceEndpointPolicy

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ServiceEndpointPolicy][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 ServiceEndpointPolicy or the result of cls(response)
Return type: ItemPaged[ServiceEndpointPolicy]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ServiceEndpointPolicy][source]¶

Gets all service endpoint Policies in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.ServiceEndpointPolicyDefinitionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s service_endpoint_policy_definitions attribute.

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, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceEndpointPolicyDefinition][source]¶

begin_create_or_update(resource_group_name: str, service_endpoint_policy_name: str, service_endpoint_policy_definition_name: str, service_endpoint_policy_definitions: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceEndpointPolicyDefinition]

Creates or updates a service endpoint policy definition in the specified service endpoint policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the service endpoint policy. Required.
service_endpoint_policy_definition_name (str) – The name of the service endpoint policy definition name. Required.
service_endpoint_policy_definitions (ServiceEndpointPolicyDefinition or IO) – Parameters supplied to the create or update service endpoint policy operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ServiceEndpointPolicyDefinition or the result of cls(response)

Return type

LROPoller[ServiceEndpointPolicyDefinition]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, service_endpoint_policy_name: str, service_endpoint_policy_definition_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified ServiceEndpoint policy definitions.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the Service Endpoint Policy. Required.
service_endpoint_policy_definition_name (str) – The name of the service endpoint policy definition. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, service_endpoint_policy_name: str, service_endpoint_policy_definition_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ServiceEndpointPolicyDefinition[source]¶

Get the specified service endpoint policy definitions from service endpoint policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the service endpoint policy name. Required.
service_endpoint_policy_definition_name (str) – The name of the service endpoint policy definition name. Required.

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

ServiceEndpointPolicyDefinition

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, service_endpoint_policy_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.ServiceEndpointPolicyDefinition][source]¶

Gets all service endpoint policy definitions in a service end point policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
service_endpoint_policy_name (str) – The name of the service endpoint policy name. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServiceEndpointPolicyDefinition]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.SubnetsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s subnets attribute.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, subnet_name: str, subnet_parameters: _models.Subnet, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Subnet][source]¶

begin_create_or_update(resource_group_name: str, virtual_network_name: str, subnet_name: str, subnet_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Subnet]

Creates or updates a subnet in the specified virtual network.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_name (str) – The name of the virtual network. Required.
subnet_name (str) – The name of the subnet. Required.
subnet_parameters (Subnet or IO) – Parameters supplied to the create or update subnet operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Subnet]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_name: str, subnet_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified subnet.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_prepare_network_policies(resource_group_name: str, virtual_network_name: str, subnet_name: str, prepare_network_policies_request_parameters: _models.PrepareNetworkPoliciesRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_prepare_network_policies(resource_group_name: str, virtual_network_name: str, subnet_name: str, prepare_network_policies_request_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Prepares a subnet by applying network intent policies.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_name (str) – The name of the virtual network. Required.
subnet_name (str) – The name of the subnet. Required.
prepare_network_policies_request_parameters (PrepareNetworkPoliciesRequest or IO) – Parameters supplied to prepare subnet by applying network intent policies. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

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

Gets the specified subnet by virtual network and resource group.

Parameters

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

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

HttpResponseError –

list(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.Subnet][source]¶

Gets all subnets in a virtual network.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Subnet]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.UsagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s usages attribute.

list(location: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.Usage][source]¶

List network usages for a subscription.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VirtualHubsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s virtual_hubs attribute.

begin_create_or_update(resource_group_name: str, virtual_hub_name: str, virtual_hub_parameters: _models.VirtualHub, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualHub][source]¶

begin_create_or_update(resource_group_name: str, virtual_hub_name: str, virtual_hub_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualHub]

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. Required.
virtual_hub_name (str) – The name of the VirtualHub. Required.
virtual_hub_parameters (VirtualHub or IO) – Parameters supplied to create or update VirtualHub. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VirtualHub]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a VirtualHub.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub. Required.
virtual_hub_name (str) – The name of the VirtualHub. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, virtual_hub_name: str, virtual_hub_parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualHub][source]¶

begin_update_tags(resource_group_name: str, virtual_hub_name: str, virtual_hub_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualHub]

Updates VirtualHub tags.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub. Required.
virtual_hub_name (str) – The name of the VirtualHub. Required.
virtual_hub_parameters (TagsObject or IO) – Parameters supplied to update VirtualHub tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VirtualHub]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualHub[source]¶

Retrieves the details of a VirtualHub.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub. Required.
virtual_hub_name (str) – The name of the VirtualHub. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualHub][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 VirtualHub or the result of cls(response)
Return type: ItemPaged[VirtualHub]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualHub][source]¶

Lists all the VirtualHubs in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VirtualNetworkGatewayConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s virtual_network_gateway_connections attribute.

begin_create_or_update(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: _models.VirtualNetworkGatewayConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGatewayConnection][source]¶

begin_create_or_update(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGatewayConnection]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection. Required.
parameters (VirtualNetworkGatewayConnection or IO) – Parameters supplied to the create or update virtual network gateway connection operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 VirtualNetworkGatewayConnection or the result of cls(response)

Return type

LROPoller[VirtualNetworkGatewayConnection]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified virtual network Gateway connection.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_reset_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: _models.ConnectionResetSharedKey, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectionResetSharedKey][source]¶

begin_reset_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectionResetSharedKey]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_connection_name (str) – The virtual network gateway connection reset shared key Name. Required.
parameters (ConnectionResetSharedKey or IO) – Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ConnectionResetSharedKey or the result of cls(response)

Return type

LROPoller[ConnectionResetSharedKey]

Raises

HttpResponseError –

begin_set_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: _models.ConnectionSharedKey, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectionSharedKey][source]¶

begin_set_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectionSharedKey]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_connection_name (str) – The virtual network gateway connection name. Required.
parameters (ConnectionSharedKey or IO) – Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 ConnectionSharedKey or the result of cls(response)

Return type

LROPoller[ConnectionSharedKey]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGatewayConnection][source]¶

begin_update_tags(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGatewayConnection]

Updates a virtual network gateway connection tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection. Required.
parameters (TagsObject or IO) – Parameters supplied to update virtual network gateway connection tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 VirtualNetworkGatewayConnection or the result of cls(response)

Return type

LROPoller[VirtualNetworkGatewayConnection]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkGatewayConnection[source]¶

Gets the specified virtual network gateway connection by resource group.

Parameters

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

Keyword Arguments

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

Returns

VirtualNetworkGatewayConnection or the result of cls(response)

Return type

VirtualNetworkGatewayConnection

Raises

HttpResponseError –

get_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.ConnectionSharedKey[source]¶

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

Parameters

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

Keyword Arguments

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

Returns

ConnectionSharedKey or the result of cls(response)

Return type

ConnectionSharedKey

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkGatewayConnection][source]¶

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

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VirtualNetworkGatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s virtual_network_gateways attribute.

begin_create_or_update(resource_group_name: str, virtual_network_gateway_name: str, parameters: _models.VirtualNetworkGateway, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGateway][source]¶

begin_create_or_update(resource_group_name: str, virtual_network_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGateway]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_name (str) – The name of the virtual network gateway. Required.
parameters (VirtualNetworkGateway or IO) – Parameters supplied to create or update virtual network gateway operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[VirtualNetworkGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified virtual network gateway.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_generate_vpn_profile(resource_group_name: str, virtual_network_gateway_name: str, parameters: _models.VpnClientParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[str][source]¶

begin_generate_vpn_profile(resource_group_name: str, virtual_network_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[str]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_name (str) – The name of the virtual network gateway. Required.
parameters (VpnClientParameters or IO) – Parameters supplied to the generate virtual network gateway VPN client package operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 str or the result of cls(response)

Return type

Raises

HttpResponseError –

begin_generatevpnclientpackage(resource_group_name: str, virtual_network_gateway_name: str, parameters: _models.VpnClientParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[str][source]¶

begin_generatevpnclientpackage(resource_group_name: str, virtual_network_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[str]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_name (str) – The name of the virtual network gateway. Required.
parameters (VpnClientParameters or IO) – Parameters supplied to the generate virtual network gateway VPN client package operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 str or the result of cls(response)

Return type

Raises

HttpResponseError –

begin_get_advertised_routes(resource_group_name: str, virtual_network_gateway_name: str, peer: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.GatewayRouteListResult][source]¶

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

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 GatewayRouteListResult or the result of cls(response)

Return type

LROPoller[GatewayRouteListResult]

Raises

HttpResponseError –

begin_get_bgp_peer_status(resource_group_name: str, virtual_network_gateway_name: str, peer: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.BgpPeerStatusListResult][source]¶

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[BgpPeerStatusListResult]

Raises

HttpResponseError –

begin_get_learned_routes(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.GatewayRouteListResult][source]¶

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

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 GatewayRouteListResult or the result of cls(response)

Return type

LROPoller[GatewayRouteListResult]

Raises

HttpResponseError –

begin_get_vpn_profile_package_url(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[str][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.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 str or the result of cls(response)

Return type

Raises

HttpResponseError –

begin_get_vpnclient_ipsec_parameters(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.VpnClientIPsecParameters][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.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 VpnClientIPsecParameters or the result of cls(response)

Return type

LROPoller[VpnClientIPsecParameters]

Raises

HttpResponseError –

begin_reset(resource_group_name: str, virtual_network_gateway_name: str, gateway_vip: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkGateway][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_name (str) – The name of the virtual network gateway. Required.
gateway_vip (str) – Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway. Default value is None.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[VirtualNetworkGateway]

Raises

HttpResponseError –

begin_reset_vpn_client_shared_key(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_set_vpnclient_ipsec_parameters(resource_group_name: str, virtual_network_gateway_name: str, vpnclient_ipsec_params: _models.VpnClientIPsecParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnClientIPsecParameters][source]¶

begin_set_vpnclient_ipsec_parameters(resource_group_name: str, virtual_network_gateway_name: str, vpnclient_ipsec_params: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnClientIPsecParameters]

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.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_name (str) – The name of the virtual network gateway. Required.
vpnclient_ipsec_params (VpnClientIPsecParameters or IO) – Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 VpnClientIPsecParameters or the result of cls(response)

Return type

LROPoller[VpnClientIPsecParameters]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, virtual_network_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGateway][source]¶

begin_update_tags(resource_group_name: str, virtual_network_gateway_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkGateway]

Updates a virtual network gateway tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_name (str) – The name of the virtual network gateway. Required.
parameters (TagsObject or IO) – Parameters supplied to update virtual network gateway tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[VirtualNetworkGateway]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkGateway[source]¶

Gets the specified virtual network gateway by resource group.

Parameters

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

Keyword Arguments

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

Returns

VirtualNetworkGateway or the result of cls(response)

Return type

VirtualNetworkGateway

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkGateway][source]¶

Gets all virtual network gateways by resource group.

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

list_connections(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkGatewayConnectionListEntity][source]¶

Gets all the connections in a virtual network gateway.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualNetworkGatewayConnectionListEntity]

Raises

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

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

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

HttpResponseError –

vpn_device_configuration_script(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: _models.VpnDeviceScriptParameters, *, content_type: str = "'application/json'", **kwargs: Any) → str [source]¶

vpn_device_configuration_script(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → str

Gets a xml format representation for vpn device configuration script.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection for which the configuration script is generated. Required.
parameters (VpnDeviceScriptParameters or IO) – Parameters supplied to the generate vpn device script operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VirtualNetworkPeeringsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s virtual_network_peerings attribute.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, virtual_network_peering_parameters: _models.VirtualNetworkPeering, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkPeering][source]¶

begin_create_or_update(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, virtual_network_peering_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkPeering]

Creates or updates a peering in the specified virtual network.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_name (str) – The name of the virtual network. Required.
virtual_network_peering_name (str) – The name of the peering. Required.
virtual_network_peering_parameters (VirtualNetworkPeering or IO) – Parameters supplied to the create or update virtual network peering operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 VirtualNetworkPeering or the result of cls(response)

Return type

LROPoller[VirtualNetworkPeering]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified virtual network peering.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkPeering[source]¶

Gets the specified virtual network peering.

Parameters

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

Keyword Arguments

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

Returns

VirtualNetworkPeering or the result of cls(response)

Return type

VirtualNetworkPeering

Raises

HttpResponseError –

list(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkPeering][source]¶

Gets all virtual network peerings in a virtual network.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualNetworkPeering]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VirtualNetworkTapsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s virtual_network_taps attribute.

begin_create_or_update(resource_group_name: str, tap_name: str, parameters: _models.VirtualNetworkTap, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkTap][source]¶

begin_create_or_update(resource_group_name: str, tap_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkTap]

Creates or updates a Virtual Network Tap.

Parameters

resource_group_name (str) – The name of the resource group. Required.
tap_name (str) – The name of the virtual network tap. Required.
parameters (VirtualNetworkTap or IO) – Parameters supplied to the create or update virtual network tap operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VirtualNetworkTap]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, tap_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified virtual network tap.

Parameters

resource_group_name (str) – The name of the resource group. Required.
tap_name (str) – The name of the virtual network tap. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, tap_name: str, tap_parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkTap][source]¶

begin_update_tags(resource_group_name: str, tap_name: str, tap_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkTap]

Updates an VirtualNetworkTap tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
tap_name (str) – The name of the tap. Required.
tap_parameters (TagsObject or IO) – Parameters supplied to update VirtualNetworkTap tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VirtualNetworkTap]

Raises

HttpResponseError –

get(resource_group_name: str, tap_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkTap[source]¶

Gets information about the specified virtual network tap.

Parameters

resource_group_name (str) – The name of the resource group. Required.
tap_name (str) – The name of virtual network tap. Required.

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

VirtualNetworkTap

Raises

HttpResponseError –

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkTap][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 VirtualNetworkTap or the result of cls(response)
Return type: ItemPaged[VirtualNetworkTap]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkTap][source]¶

Gets all the VirtualNetworkTaps in a subscription.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VirtualNetworksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s virtual_networks attribute.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, parameters: _models.VirtualNetwork, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetwork][source]¶

begin_create_or_update(resource_group_name: str, virtual_network_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetwork]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_name (str) – The name of the virtual network. Required.
parameters (VirtualNetwork or IO) – Parameters supplied to the create or update virtual network operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[VirtualNetwork]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes the specified virtual network.

Parameters

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

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, virtual_network_name: str, parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetwork][source]¶

begin_update_tags(resource_group_name: str, virtual_network_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetwork]

Updates a virtual network tags.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_name (str) – The name of the virtual network. Required.
parameters (TagsObject or IO) – Parameters supplied to update virtual network tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[VirtualNetwork]

Raises

HttpResponseError –

check_ip_address_availability(resource_group_name: str, virtual_network_name: str, ip_address: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.IPAddressAvailabilityResult[source]¶

Checks whether a private IP address is available for use.

Parameters

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

Keyword Arguments

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

Returns

IPAddressAvailabilityResult or the result of cls(response)

Return type

IPAddressAvailabilityResult

Raises

HttpResponseError –

get(resource_group_name: str, virtual_network_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetwork[source]¶

Gets the specified virtual network by resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_name (str) – The name of the virtual network. Required.
expand (str) – Expands referenced resources. Default value is None.

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

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetwork][source]¶

Gets all virtual networks in a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetwork][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 VirtualNetwork or the result of cls(response)
Return type: ItemPaged[VirtualNetwork]
Raises: HttpResponseError –

list_usage(resource_group_name: str, virtual_network_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualNetworkUsage][source]¶

Lists usage stats.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualNetworkUsage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VirtualWansOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s virtual_wans attribute.

begin_create_or_update(resource_group_name: str, virtual_wan_name: str, wan_parameters: _models.VirtualWAN, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualWAN][source]¶

begin_create_or_update(resource_group_name: str, virtual_wan_name: str, wan_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualWAN]

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. Required.
virtual_wan_name (str) – The name of the VirtualWAN being created or updated. Required.
wan_parameters (VirtualWAN or IO) – Parameters supplied to create or update VirtualWAN. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VirtualWAN]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a VirtualWAN.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan. Required.
virtual_wan_name (str) – The name of the VirtualWAN being deleted. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, virtual_wan_name: str, wan_parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualWAN][source]¶

begin_update_tags(resource_group_name: str, virtual_wan_name: str, wan_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualWAN]

Updates a VirtualWAN tags.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan. Required.
virtual_wan_name (str) – The name of the VirtualWAN being updated. Required.
wan_parameters (TagsObject or IO) – Parameters supplied to Update VirtualWAN tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VirtualWAN]

Raises

HttpResponseError –

get(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VirtualWAN[source]¶

Retrieves the details of a VirtualWAN.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan. Required.
virtual_wan_name (str) – The name of the VirtualWAN being retrieved. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualWAN][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 VirtualWAN or the result of cls(response)
Return type: ItemPaged[VirtualWAN]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VirtualWAN][source]¶

Lists all the VirtualWANs in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VpnConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s vpn_connections attribute.

begin_create_or_update(resource_group_name: str, gateway_name: str, connection_name: str, vpn_connection_parameters: _models.VpnConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnConnection][source]¶

begin_create_or_update(resource_group_name: str, gateway_name: str, connection_name: str, vpn_connection_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnConnection]

Creates a vpn connection to a scalable vpn gateway if it doesn’t exist else updates the existing connection.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.
connection_name (str) – The name of the connection. Required.
vpn_connection_parameters (VpnConnection or IO) – Parameters supplied to create or Update a VPN Connection. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 VpnConnection or the result of cls(response)

Return type

LROPoller[VpnConnection]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a vpn connection.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.
connection_name (str) – The name of the connection. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VpnConnection[source]¶

Retrieves the details of a vpn connection.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.
connection_name (str) – The name of the vpn connection. Required.

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

HttpResponseError –

list_by_vpn_gateway(resource_group_name: str, gateway_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VpnConnection][source]¶

Retrieves all vpn connections for a particular virtual wan vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VpnConnection]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VpnGatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s vpn_gateways attribute.

begin_create_or_update(resource_group_name: str, gateway_name: str, vpn_gateway_parameters: _models.VpnGateway, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnGateway][source]¶

begin_create_or_update(resource_group_name: str, gateway_name: str, vpn_gateway_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnGateway]

Creates a virtual wan vpn gateway if it doesn’t exist else updates the existing gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.
vpn_gateway_parameters (VpnGateway or IO) – Parameters supplied to create or Update a virtual wan vpn gateway. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VpnGateway]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, gateway_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a virtual wan vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, gateway_name: str, vpn_gateway_parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnGateway][source]¶

begin_update_tags(resource_group_name: str, gateway_name: str, vpn_gateway_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnGateway]

Updates virtual wan vpn gateway tags.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.
vpn_gateway_parameters (TagsObject or IO) – Parameters supplied to update a virtual wan vpn gateway tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VpnGateway]

Raises

HttpResponseError –

get(resource_group_name: str, gateway_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VpnGateway[source]¶

Retrieves the details of a virtual wan vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway. Required.
gateway_name (str) – The name of the gateway. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VpnGateway][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 VpnGateway or the result of cls(response)
Return type: ItemPaged[VpnGateway]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VpnGateway][source]¶

Lists all the VpnGateways in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VpnSitesConfigurationOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s vpn_sites_configuration attribute.

begin_download(resource_group_name: str, virtual_wan_name: str, request: _models.GetVpnSitesConfigurationRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_download(resource_group_name: str, virtual_wan_name: str, request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Gives the sas-url to download the configurations for vpn-sites in a resource group.

Parameters

resource_group_name (str) – The resource group name. Required.
virtual_wan_name (str) – The name of the VirtualWAN for which configuration of all vpn-sites is needed. Required.
request (GetVpnSitesConfigurationRequest or IO) – Parameters supplied to download vpn-sites configuration. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.VpnSitesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s vpn_sites attribute.

begin_create_or_update(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: _models.VpnSite, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnSite][source]¶

begin_create_or_update(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnSite]

Creates a VpnSite resource if it doesn’t exist else updates the existing VpnSite.

Parameters

resource_group_name (str) – The resource group name of the VpnSite. Required.
vpn_site_name (str) – The name of the VpnSite being created or updated. Required.
vpn_site_parameters (VpnSite or IO) – Parameters supplied to create or update VpnSite. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VpnSite]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, vpn_site_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a VpnSite.

Parameters

resource_group_name (str) – The resource group name of the VpnSite. Required.
vpn_site_name (str) – The name of the VpnSite being deleted. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update_tags(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: _models.TagsObject, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnSite][source]¶

begin_update_tags(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VpnSite]

Updates VpnSite tags.

Parameters

resource_group_name (str) – The resource group name of the VpnSite. Required.
vpn_site_name (str) – The name of the VpnSite being updated. Required.
vpn_site_parameters (TagsObject or IO) – Parameters supplied to update VpnSite tags. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

LROPoller[VpnSite]

Raises

HttpResponseError –

get(resource_group_name: str, vpn_site_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.VpnSite[source]¶

Retrieves the details of a VPN site.

Parameters

resource_group_name (str) – The resource group name of the VpnSite. Required.
vpn_site_name (str) – The name of the VpnSite being retrieved. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VpnSite][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 VpnSite or the result of cls(response)
Return type: ItemPaged[VpnSite]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.VpnSite][source]¶

Lists all the vpnSites in a resource group.

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

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶

class azure.mgmt.network.v2019_02_01.operations.WebApplicationFirewallPoliciesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NetworkManagementClient’s web_application_firewall_policies attribute.

begin_delete(resource_group_name: str, policy_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes Policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
policy_name (str) – The name of the policy. Required.

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

create_or_update(resource_group_name: str, policy_name: str, parameters: _models.WebApplicationFirewallPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.WebApplicationFirewallPolicy[source]¶

create_or_update(resource_group_name: str, policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.WebApplicationFirewallPolicy

Creates or update policy with specified rule set name within a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
policy_name (str) – The name of the policy. Required.
parameters (WebApplicationFirewallPolicy or IO) – Policy to be created. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

WebApplicationFirewallPolicy or the result of cls(response)

Return type

WebApplicationFirewallPolicy

Raises

HttpResponseError –

get(resource_group_name: str, policy_name: str, **kwargs: Any) → azure.mgmt.network.v2019_02_01.models._models_py3.WebApplicationFirewallPolicy[source]¶

Retrieve protection policy with specified name within a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
policy_name (str) – The name of the policy. Required.

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

WebApplicationFirewallPolicy

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.WebApplicationFirewallPolicy][source]¶

Lists all of the protection policies within a resource group.

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

list_all(**kwargs: Any) → Iterable[azure.mgmt.network.v2019_02_01.models._models_py3.WebApplicationFirewallPolicy][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 WebApplicationFirewallPolicy or the result of cls(response)
Return type: ItemPaged[WebApplicationFirewallPolicy]
Raises: HttpResponseError –

models = <module 'azure.mgmt.network.v2019_02_01.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/network/v2019_02_01/models/__init__.py'>¶