network_status

Creates, updates, deletes, gets or lists a network_status resource.

Overview

Name	network_status
Type	Resource
Id	azure.api_management.network_status

Fields

The following fields are returned by SELECT queries:

list_by_location

Name	Datatype	Description
connectivityStatus	array	Gets the list of Connectivity Status to the Resources on which the service depends upon. Required.
dnsServers	array	Gets the list of DNS servers IPV4 addresses. Required.

list_by_service

Name	Datatype	Description
location	string	Location of service.
networkStatus	object	Network status in Location.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_location	select	resource_group_name, service_name, location_name, subscription_id		Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.
list_by_service	select	resource_group_name, service_name, subscription_id		Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
location_name	string	Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string

SELECT examples

list_by_location

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

SELECT
connectivityStatus,
dnsServers
FROM azure.api_management.network_status
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

SELECT
location,
networkStatus
FROM azure.api_management.network_status
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;