impacted_resources

Creates, updates, deletes, gets or lists an impacted_resources resource.

Overview

Name	impacted_resources
Type	Resource
Id	azure.resource_health.impacted_resources

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
info	array	Additional information.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetRegion	string	Impacted resource region name.
targetResourceId	string	Identity for resource within Microsoft cloud.
targetResourceType	string	Resource type within Microsoft cloud.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription_id_and_event_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
info	array	Additional information.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetRegion	string	Impacted resource region name.
targetResourceId	string	Identity for resource within Microsoft cloud.
targetResourceType	string	Resource type within Microsoft cloud.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_tenant_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
info	array	Additional information.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetRegion	string	Impacted resource region name.
targetResourceId	string	Identity for resource within Microsoft cloud.
targetResourceType	string	Resource type within Microsoft cloud.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_tenant_id_and_event_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
info	array	Additional information.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetRegion	string	Impacted resource region name.
targetResourceId	string	Identity for resource within Microsoft cloud.
targetResourceType	string	Resource type within Microsoft cloud.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	event_tracking_id, impacted_resource_name, subscription_id		Gets the specific impacted resource in the subscription by an event.
list_by_subscription_id_and_event_id	select	event_tracking_id, subscription_id	$filter	Lists impacted resources in the subscription by an event.
get_by_tenant_id	select	event_tracking_id, impacted_resource_name		Gets the specific impacted resource in the tenant by an event.
list_by_tenant_id_and_event_id	select	event_tracking_id	$filter	Lists impacted resources in the tenant by an event.

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
event_tracking_id	string	Event Id which uniquely identifies ServiceHealth event. Required.
impacted_resource_name	string	Name of the Impacted Resource. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN _. Default value is None.

SELECT examples

get

Gets the specific impacted resource in the subscription by an event.

SELECT
id,
name,
info,
systemData,
targetRegion,
targetResourceId,
targetResourceType,
type
FROM azure.resource_health.impacted_resources
WHERE event_tracking_id = '{{ event_tracking_id }}' -- required
AND impacted_resource_name = '{{ impacted_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_id_and_event_id

Lists impacted resources in the subscription by an event.

SELECT
id,
name,
info,
systemData,
targetRegion,
targetResourceId,
targetResourceType,
type
FROM azure.resource_health.impacted_resources
WHERE event_tracking_id = '{{ event_tracking_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

get_by_tenant_id

Gets the specific impacted resource in the tenant by an event.

SELECT
id,
name,
info,
systemData,
targetRegion,
targetResourceId,
targetResourceType,
type
FROM azure.resource_health.impacted_resources
WHERE event_tracking_id = '{{ event_tracking_id }}' -- required
AND impacted_resource_name = '{{ impacted_resource_name }}' -- required
;

list_by_tenant_id_and_event_id

Lists impacted resources in the tenant by an event.

SELECT
id,
name,
info,
systemData,
targetRegion,
targetResourceId,
targetResourceType,
type
FROM azure.resource_health.impacted_resources
WHERE event_tracking_id = '{{ event_tracking_id }}' -- required
AND $filter = '{{ $filter }}'
;