1. Packages
  2. Azure Native
  3. API Docs
  4. blueprint
  5. getTemplateArtifact
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.blueprint.getTemplateArtifact

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get a blueprint artifact.

Uses 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>
Copy
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]
Copy
func LookupTemplateArtifact(ctx *Context, args *LookupTemplateArtifactArgs, opts ...InvokeOption) (*LookupTemplateArtifactResult, error)
func LookupTemplateArtifactOutput(ctx *Context, args *LookupTemplateArtifactOutputArgs, opts ...InvokeOption) LookupTemplateArtifactResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetTemplateArtifactResult> getTemplateArtifact(GetTemplateArtifactArgs args, InvokeOptions options)
public static Output<GetTemplateArtifactResult> getTemplateArtifact(GetTemplateArtifactArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:blueprint:getTemplateArtifact
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ArtifactName
This property is required.
Changes to this property will trigger replacement.
string
Name of the blueprint artifact.
BlueprintName
This property is required.
Changes to this property will trigger replacement.
string
Name of the blueprint definition.
ResourceScope
This property is required.
Changes to this property will trigger replacement.
string
The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
ArtifactName
This property is required.
Changes to this property will trigger replacement.
string
Name of the blueprint artifact.
BlueprintName
This property is required.
Changes to this property will trigger replacement.
string
Name of the blueprint definition.
ResourceScope
This property is required.
Changes to this property will trigger replacement.
string
The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
artifactName
This property is required.
Changes to this property will trigger replacement.
String
Name of the blueprint artifact.
blueprintName
This property is required.
Changes to this property will trigger replacement.
String
Name of the blueprint definition.
resourceScope
This property is required.
Changes to this property will trigger replacement.
String
The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
artifactName
This property is required.
Changes to this property will trigger replacement.
string
Name of the blueprint artifact.
blueprintName
This property is required.
Changes to this property will trigger replacement.
string
Name of the blueprint definition.
resourceScope
This property is required.
Changes to this property will trigger replacement.
string
The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
artifact_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the blueprint artifact.
blueprint_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the blueprint definition.
resource_scope
This property is required.
Changes to this property will trigger replacement.
str
The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
artifactName
This property is required.
Changes to this property will trigger replacement.
String
Name of the blueprint artifact.
blueprintName
This property is required.
Changes to this property will trigger replacement.
String
Name of the blueprint definition.
resourceScope
This property is required.
Changes to this property will trigger replacement.
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:

AzureApiVersion string
The Azure API version of the resource.
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.
AzureApiVersion string
The Azure API version of the resource.
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.
azureApiVersion String
The Azure API version of the resource.
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.
azureApiVersion string
The Azure API version of the resource.
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.
azure_api_version str
The Azure API version of the resource.
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.
azureApiVersion String
The Azure API version of the resource.
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 This property is required. string
Azure resource ID of the Key Vault.
Id This property is required. string
Azure resource ID of the Key Vault.
id This property is required. String
Azure resource ID of the Key Vault.
id This property is required. string
Azure resource ID of the Key Vault.
id This property is required. str
Azure resource ID of the Key Vault.
id This property is required. 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 This property is required. Pulumi.AzureNative.Blueprint.Inputs.KeyVaultReferenceResponse
Specifies the reference to a given Azure Key Vault.
SecretName This property is required. 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 This property is required. KeyVaultReferenceResponse
Specifies the reference to a given Azure Key Vault.
SecretName This property is required. 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 This property is required. KeyVaultReferenceResponse
Specifies the reference to a given Azure Key Vault.
secretName This property is required. 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 This property is required. KeyVaultReferenceResponse
Specifies the reference to a given Azure Key Vault.
secretName This property is required. 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 This property is required. KeyVaultReferenceResponse
Specifies the reference to a given Azure Key Vault.
secret_name This property is required. 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 This property is required. Property Map
Specifies the reference to a given Azure Key Vault.
secretName This property is required. 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
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi