goal_resources

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

Overview

Name	goal_resources
Type	Resource
Id	azure.resilience_management.goal_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.
disasterRecoveryAttestationStatus	string	Flag which depicts whether the Arm resource is manually attested for disaster recovery recommendation. Known values are: "NotAttested" and "ManuallyAttested". (NotAttested, ManuallyAttested)
disasterRecoveryGoalParticipation	string	Flag which depicts whether the Arm resource is excluded for disaster recovery recommendation. Known values are: "Excluded" and "Included". (Excluded, Included)
exclusionReasonForDisasterRecoveryGoals	string	Reason for exclusion from disaster recovery goals. Known values are: "UserSelectedExclusion", "FailedOverResource", and "UnsupportedResource". (UserSelectedExclusion, FailedOverResource, UnsupportedResource)
exclusionReasonForHighAvailabilityGoals	string	Reason for exclusion from high availability goals. Known values are: "UserSelectedExclusion", "FailedOverResource", and "UnsupportedResource". (UserSelectedExclusion, FailedOverResource, UnsupportedResource)
highAvailabilityAttestationStatus	string	Flag which depicts whether the Arm resource is manually attested for high availability recommendation. Required. Known values are: "NotAttested" and "ManuallyAttested". (NotAttested, ManuallyAttested)
highAvailabilityGoalParticipation	string	Flag which depicts whether the Arm resource is excluded for high availability recommendation. Required. Known values are: "Excluded" and "Included". (Excluded, Included)
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
resourceArmId	string	Arm Id of resource under the SG for which the extension resource is maintained. Required.
serviceGroupMemberships	array	List of service groups of which this resource is memberof.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userConfirmationForHighAvailability	array	List of user confirmations for high availability solutions.

list

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.
disasterRecoveryAttestationStatus	string	Flag which depicts whether the Arm resource is manually attested for disaster recovery recommendation. Known values are: "NotAttested" and "ManuallyAttested". (NotAttested, ManuallyAttested)
disasterRecoveryGoalParticipation	string	Flag which depicts whether the Arm resource is excluded for disaster recovery recommendation. Known values are: "Excluded" and "Included". (Excluded, Included)
exclusionReasonForDisasterRecoveryGoals	string	Reason for exclusion from disaster recovery goals. Known values are: "UserSelectedExclusion", "FailedOverResource", and "UnsupportedResource". (UserSelectedExclusion, FailedOverResource, UnsupportedResource)
exclusionReasonForHighAvailabilityGoals	string	Reason for exclusion from high availability goals. Known values are: "UserSelectedExclusion", "FailedOverResource", and "UnsupportedResource". (UserSelectedExclusion, FailedOverResource, UnsupportedResource)
highAvailabilityAttestationStatus	string	Flag which depicts whether the Arm resource is manually attested for high availability recommendation. Required. Known values are: "NotAttested" and "ManuallyAttested". (NotAttested, ManuallyAttested)
highAvailabilityGoalParticipation	string	Flag which depicts whether the Arm resource is excluded for high availability recommendation. Required. Known values are: "Excluded" and "Included". (Excluded, Included)
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
resourceArmId	string	Arm Id of resource under the SG for which the extension resource is maintained. Required.
serviceGroupMemberships	array	List of service groups of which this resource is memberof.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userConfirmationForHighAvailability	array	List of user confirmations for high availability solutions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_group_name, goal_assignment_name, goal_resource_name		Get a GoalResource.
list	select	service_group_name, goal_assignment_name	$skipToken, $top	List GoalResource resources by GoalAssignment.

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
goal_assignment_name	string	The name of the GoalAssignment. Required.
goal_resource_name	string	The name of the GoalAssignment. Required.
service_group_name	string	The name of the service group. Required.
$skipToken	string	Skip over when retrieving results. Default value is None.
$top	integer	Number of elements to return when retrieving results. Default value is None.

SELECT examples

get

Get a GoalResource.

SELECT
id,
name,
disasterRecoveryAttestationStatus,
disasterRecoveryGoalParticipation,
exclusionReasonForDisasterRecoveryGoals,
exclusionReasonForHighAvailabilityGoals,
highAvailabilityAttestationStatus,
highAvailabilityGoalParticipation,
provisioningState,
resourceArmId,
serviceGroupMemberships,
systemData,
type,
userConfirmationForHighAvailability
FROM azure.resilience_management.goal_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND goal_assignment_name = '{{ goal_assignment_name }}' -- required
AND goal_resource_name = '{{ goal_resource_name }}' -- required
;

list

List GoalResource resources by GoalAssignment.

SELECT
id,
name,
disasterRecoveryAttestationStatus,
disasterRecoveryGoalParticipation,
exclusionReasonForDisasterRecoveryGoals,
exclusionReasonForHighAvailabilityGoals,
highAvailabilityAttestationStatus,
highAvailabilityGoalParticipation,
provisioningState,
resourceArmId,
serviceGroupMemberships,
systemData,
type,
userConfirmationForHighAvailability
FROM azure.resilience_management.goal_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND goal_assignment_name = '{{ goal_assignment_name }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;