1. Packages
  2. Azure Native
  3. API Docs
  4. blueprint
  5. getTemplateArtifact
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

azure-native.blueprint.getTemplateArtifact

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

    Get a blueprint artifact. Azure REST API version: 2018-11-01-preview.

    Using getTemplateArtifact

    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 getTemplateArtifact(args: GetTemplateArtifactArgs, opts?: InvokeOptions): Promise<GetTemplateArtifactResult>
    function getTemplateArtifactOutput(args: GetTemplateArtifactOutputArgs, opts?: InvokeOptions): Output<GetTemplateArtifactResult>
    def get_template_artifact(artifact_name: Optional[str] = None,
                              blueprint_name: Optional[str] = None,
                              resource_scope: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetTemplateArtifactResult
    def get_template_artifact_output(artifact_name: Optional[pulumi.Input[str]] = None,
                              blueprint_name: Optional[pulumi.Input[str]] = None,
                              resource_scope: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetTemplateArtifactResult]
    func LookupTemplateArtifact(ctx *Context, args *LookupTemplateArtifactArgs, opts ...InvokeOption) (*LookupTemplateArtifactResult, error)
    func LookupTemplateArtifactOutput(ctx *Context, args *LookupTemplateArtifactOutputArgs, opts ...InvokeOption) LookupTemplateArtifactResultOutput

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

    public static class GetTemplateArtifact 
    {
        public static Task<GetTemplateArtifactResult> InvokeAsync(GetTemplateArtifactArgs args, InvokeOptions? opts = null)
        public static Output<GetTemplateArtifactResult> Invoke(GetTemplateArtifactInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTemplateArtifactResult> getTemplateArtifact(GetTemplateArtifactArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:blueprint:getTemplateArtifact
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ArtifactName string
    Name of the blueprint artifact.
    BlueprintName string
    Name of the blueprint definition.
    ResourceScope string
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    ArtifactName string
    Name of the blueprint artifact.
    BlueprintName string
    Name of the blueprint definition.
    ResourceScope string
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    artifactName String
    Name of the blueprint artifact.
    blueprintName String
    Name of the blueprint definition.
    resourceScope String
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    artifactName string
    Name of the blueprint artifact.
    blueprintName string
    Name of the blueprint definition.
    resourceScope string
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    artifact_name str
    Name of the blueprint artifact.
    blueprint_name str
    Name of the blueprint definition.
    resource_scope str
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    artifactName String
    Name of the blueprint artifact.
    blueprintName String
    Name of the blueprint definition.
    resourceScope String
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

    getTemplateArtifact Result

    The following output properties are available:

    Id string
    String Id used to locate any resource on Azure.
    Name string
    Name of this resource.
    Parameters Dictionary<string, Pulumi.AzureNative.Blueprint.Outputs.ParameterValueResponse>
    Resource Manager template blueprint artifact parameter values.
    Template object
    The Resource Manager template blueprint artifact body.
    Type string
    Type of this resource.
    DependsOn List<string>
    Artifacts which need to be deployed before the specified artifact.
    Description string
    Multi-line explain this resource.
    DisplayName string
    One-liner string explain this resource.
    ResourceGroup string
    If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.
    Id string
    String Id used to locate any resource on Azure.
    Name string
    Name of this resource.
    Parameters map[string]ParameterValueResponse
    Resource Manager template blueprint artifact parameter values.
    Template interface{}
    The Resource Manager template blueprint artifact body.
    Type string
    Type of this resource.
    DependsOn []string
    Artifacts which need to be deployed before the specified artifact.
    Description string
    Multi-line explain this resource.
    DisplayName string
    One-liner string explain this resource.
    ResourceGroup string
    If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.
    id String
    String Id used to locate any resource on Azure.
    name String
    Name of this resource.
    parameters Map<String,ParameterValueResponse>
    Resource Manager template blueprint artifact parameter values.
    template Object
    The Resource Manager template blueprint artifact body.
    type String
    Type of this resource.
    dependsOn List<String>
    Artifacts which need to be deployed before the specified artifact.
    description String
    Multi-line explain this resource.
    displayName String
    One-liner string explain this resource.
    resourceGroup String
    If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.
    id string
    String Id used to locate any resource on Azure.
    name string
    Name of this resource.
    parameters {[key: string]: ParameterValueResponse}
    Resource Manager template blueprint artifact parameter values.
    template any
    The Resource Manager template blueprint artifact body.
    type string
    Type of this resource.
    dependsOn string[]
    Artifacts which need to be deployed before the specified artifact.
    description string
    Multi-line explain this resource.
    displayName string
    One-liner string explain this resource.
    resourceGroup string
    If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.
    id str
    String Id used to locate any resource on Azure.
    name str
    Name of this resource.
    parameters Mapping[str, ParameterValueResponse]
    Resource Manager template blueprint artifact parameter values.
    template Any
    The Resource Manager template blueprint artifact body.
    type str
    Type of this resource.
    depends_on Sequence[str]
    Artifacts which need to be deployed before the specified artifact.
    description str
    Multi-line explain this resource.
    display_name str
    One-liner string explain this resource.
    resource_group str
    If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.
    id String
    String Id used to locate any resource on Azure.
    name String
    Name of this resource.
    parameters Map<Property Map>
    Resource Manager template blueprint artifact parameter values.
    template Any
    The Resource Manager template blueprint artifact body.
    type String
    Type of this resource.
    dependsOn List<String>
    Artifacts which need to be deployed before the specified artifact.
    description String
    Multi-line explain this resource.
    displayName String
    One-liner string explain this resource.
    resourceGroup String
    If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.

    Supporting Types

    KeyVaultReferenceResponse

    Id string
    Azure resource ID of the Key Vault.
    Id string
    Azure resource ID of the Key Vault.
    id String
    Azure resource ID of the Key Vault.
    id string
    Azure resource ID of the Key Vault.
    id str
    Azure resource ID of the Key Vault.
    id String
    Azure resource ID of the Key Vault.

    ParameterValueResponse

    Reference Pulumi.AzureNative.Blueprint.Inputs.SecretValueReferenceResponse
    Parameter value as reference type.
    Value object
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    Reference SecretValueReferenceResponse
    Parameter value as reference type.
    Value interface{}
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference SecretValueReferenceResponse
    Parameter value as reference type.
    value Object
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference SecretValueReferenceResponse
    Parameter value as reference type.
    value any
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference SecretValueReferenceResponse
    Parameter value as reference type.
    value Any
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference Property Map
    Parameter value as reference type.
    value Any
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.

    SecretValueReferenceResponse

    KeyVault Pulumi.AzureNative.Blueprint.Inputs.KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    SecretName string
    Name of the secret.
    SecretVersion string
    The version of the secret to use. If left blank, the latest version of the secret is used.
    KeyVault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    SecretName string
    Name of the secret.
    SecretVersion string
    The version of the secret to use. If left blank, the latest version of the secret is used.
    keyVault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    secretName String
    Name of the secret.
    secretVersion String
    The version of the secret to use. If left blank, the latest version of the secret is used.
    keyVault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    secretName string
    Name of the secret.
    secretVersion string
    The version of the secret to use. If left blank, the latest version of the secret is used.
    key_vault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    secret_name str
    Name of the secret.
    secret_version str
    The version of the secret to use. If left blank, the latest version of the secret is used.
    keyVault Property Map
    Specifies the reference to a given Azure Key Vault.
    secretName String
    Name of the secret.
    secretVersion String
    The version of the secret to use. If left blank, the latest version of the secret is used.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi