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

Gets the Network status details.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_location	select	subscriptionId, resourceGroupName, serviceName, locationName		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	exec	subscriptionId, resourceGroupName, serviceName		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
locationName	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.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.

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 subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND locationName = '{{ locationName }}' -- required
;

Lifecycle Methods

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.

EXEC azure.api_management.network_status.list_by_service 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required
;