1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. azureresiliencemanagement
  6. getGoalTemplate
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi

    Get a GoalTemplate

    Uses Azure REST API version 2026-03-01-preview.

    Other available API versions: 2025-02-01-preview, 2026-04-01-preview, 2026-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azureresiliencemanagement [ApiVersion]. See the version guide for details.

    Using getGoalTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGoalTemplate(args: GetGoalTemplateArgs, opts?: InvokeOptions): Promise<GetGoalTemplateResult>
    function getGoalTemplateOutput(args: GetGoalTemplateOutputArgs, opts?: InvokeOptions): Output<GetGoalTemplateResult>
    def get_goal_template(goal_template_name: Optional[str] = None,
                          service_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetGoalTemplateResult
    def get_goal_template_output(goal_template_name: pulumi.Input[Optional[str]] = None,
                          service_group_name: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetGoalTemplateResult]
    func LookupGoalTemplate(ctx *Context, args *LookupGoalTemplateArgs, opts ...InvokeOption) (*LookupGoalTemplateResult, error)
    func LookupGoalTemplateOutput(ctx *Context, args *LookupGoalTemplateOutputArgs, opts ...InvokeOption) LookupGoalTemplateResultOutput

    > Note: This function is named LookupGoalTemplate in the Go SDK.

    public static class GetGoalTemplate 
    {
        public static Task<GetGoalTemplateResult> InvokeAsync(GetGoalTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetGoalTemplateResult> Invoke(GetGoalTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGoalTemplateResult> getGoalTemplate(GetGoalTemplateArgs args, InvokeOptions options)
    public static Output<GetGoalTemplateResult> getGoalTemplate(GetGoalTemplateArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:azureresiliencemanagement:getGoalTemplate
      arguments:
        # arguments dictionary
    data "azure-native_azureresiliencemanagement_get_goal_template" "name" {
        # arguments
    }

    The following arguments are supported:

    GoalTemplateName string
    The name of the goalTemplate
    ServiceGroupName string
    The name of the service group.
    GoalTemplateName string
    The name of the goalTemplate
    ServiceGroupName string
    The name of the service group.
    goal_template_name string
    The name of the goalTemplate
    service_group_name string
    The name of the service group.
    goalTemplateName String
    The name of the goalTemplate
    serviceGroupName String
    The name of the service group.
    goalTemplateName string
    The name of the goalTemplate
    serviceGroupName string
    The name of the service group.
    goal_template_name str
    The name of the goalTemplate
    service_group_name str
    The name of the service group.
    goalTemplateName String
    The name of the goalTemplate
    serviceGroupName String
    The name of the service group.

    getGoalTemplate Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureResilienceManagement.Outputs.GoalTemplatePropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.AzureResilienceManagement.Outputs.SystemDataResponse
    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"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties GoalTemplatePropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    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"
    azure_api_version string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties object
    The resource-specific properties for this resource.
    system_data 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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties GoalTemplatePropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    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"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties GoalTemplatePropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    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"
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties GoalTemplatePropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    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"

    Supporting Types

    ErrorAdditionalInfoResponse

    Info object
    The additional info.
    Type string
    The additional info type.
    Info interface{}
    The additional info.
    Type string
    The additional info type.
    info any
    The additional info.
    type string
    The additional info type.
    info Object
    The additional info.
    type String
    The additional info type.
    info any
    The additional info.
    type string
    The additional info type.
    info Any
    The additional info.
    type str
    The additional info type.
    info Any
    The additional info.
    type String
    The additional info type.

    ErrorDetailResponse

    AdditionalInfo []ErrorAdditionalInfoResponse
    The error additional info.
    Code string
    The error code.
    Details []ErrorDetailResponse
    The error details.
    Message string
    The error message.
    Target string
    The error target.
    additional_info list(object)
    The error additional info.
    code string
    The error code.
    details list(object)
    The error details.
    message string
    The error message.
    target string
    The error target.
    additionalInfo List<ErrorAdditionalInfoResponse>
    The error additional info.
    code String
    The error code.
    details List<ErrorDetailResponse>
    The error details.
    message String
    The error message.
    target String
    The error target.
    additionalInfo ErrorAdditionalInfoResponse[]
    The error additional info.
    code string
    The error code.
    details ErrorDetailResponse[]
    The error details.
    message string
    The error message.
    target string
    The error target.
    additional_info Sequence[ErrorAdditionalInfoResponse]
    The error additional info.
    code str
    The error code.
    details Sequence[ErrorDetailResponse]
    The error details.
    message str
    The error message.
    target str
    The error target.
    additionalInfo List<Property Map>
    The error additional info.
    code String
    The error code.
    details List<Property Map>
    The error details.
    message String
    The error message.
    target String
    The error target.

    GoalTemplatePropertiesResponse

    ErrorDetails Pulumi.AzureNative.AzureResilienceManagement.Inputs.ErrorDetailResponse
    Details of any errors encountered during the operation.
    GoalType string
    Type of Goal Template created by customer
    ProvisioningState string
    Provisioning state
    RegionalRecoveryPointObjective string
    Regional recovery point objective specified by customer. eg, PT15M for 15 minutes
    RegionalRecoveryTimeObjective string
    Regional recovery time objective specified by customer. eg, PT15M for 15 minutes
    RequireDisasterRecovery string
    Option specified by customer under disaster recovery section of goal template
    RequireHighAvailability string
    Option specified by customer under high availability section of goal template
    ErrorDetails ErrorDetailResponse
    Details of any errors encountered during the operation.
    GoalType string
    Type of Goal Template created by customer
    ProvisioningState string
    Provisioning state
    RegionalRecoveryPointObjective string
    Regional recovery point objective specified by customer. eg, PT15M for 15 minutes
    RegionalRecoveryTimeObjective string
    Regional recovery time objective specified by customer. eg, PT15M for 15 minutes
    RequireDisasterRecovery string
    Option specified by customer under disaster recovery section of goal template
    RequireHighAvailability string
    Option specified by customer under high availability section of goal template
    error_details object
    Details of any errors encountered during the operation.
    goal_type string
    Type of Goal Template created by customer
    provisioning_state string
    Provisioning state
    regional_recovery_point_objective string
    Regional recovery point objective specified by customer. eg, PT15M for 15 minutes
    regional_recovery_time_objective string
    Regional recovery time objective specified by customer. eg, PT15M for 15 minutes
    require_disaster_recovery string
    Option specified by customer under disaster recovery section of goal template
    require_high_availability string
    Option specified by customer under high availability section of goal template
    errorDetails ErrorDetailResponse
    Details of any errors encountered during the operation.
    goalType String
    Type of Goal Template created by customer
    provisioningState String
    Provisioning state
    regionalRecoveryPointObjective String
    Regional recovery point objective specified by customer. eg, PT15M for 15 minutes
    regionalRecoveryTimeObjective String
    Regional recovery time objective specified by customer. eg, PT15M for 15 minutes
    requireDisasterRecovery String
    Option specified by customer under disaster recovery section of goal template
    requireHighAvailability String
    Option specified by customer under high availability section of goal template
    errorDetails ErrorDetailResponse
    Details of any errors encountered during the operation.
    goalType string
    Type of Goal Template created by customer
    provisioningState string
    Provisioning state
    regionalRecoveryPointObjective string
    Regional recovery point objective specified by customer. eg, PT15M for 15 minutes
    regionalRecoveryTimeObjective string
    Regional recovery time objective specified by customer. eg, PT15M for 15 minutes
    requireDisasterRecovery string
    Option specified by customer under disaster recovery section of goal template
    requireHighAvailability string
    Option specified by customer under high availability section of goal template
    error_details ErrorDetailResponse
    Details of any errors encountered during the operation.
    goal_type str
    Type of Goal Template created by customer
    provisioning_state str
    Provisioning state
    regional_recovery_point_objective str
    Regional recovery point objective specified by customer. eg, PT15M for 15 minutes
    regional_recovery_time_objective str
    Regional recovery time objective specified by customer. eg, PT15M for 15 minutes
    require_disaster_recovery str
    Option specified by customer under disaster recovery section of goal template
    require_high_availability str
    Option specified by customer under high availability section of goal template
    errorDetails Property Map
    Details of any errors encountered during the operation.
    goalType String
    Type of Goal Template created by customer
    provisioningState String
    Provisioning state
    regionalRecoveryPointObjective String
    Regional recovery point objective specified by customer. eg, PT15M for 15 minutes
    regionalRecoveryTimeObjective String
    Regional recovery time objective specified by customer. eg, PT15M for 15 minutes
    requireDisasterRecovery String
    Option specified by customer under disaster recovery section of goal template
    requireHighAvailability String
    Option specified by customer under high availability section of goal template

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.23.0
    published on Saturday, Jul 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial