Azure Native v2.90.0, Mar 27 25

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.blueprint.getPublishedBlueprint

Explore with Pulumi AI

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Using getPublishedBlueprint

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.

TypeScript
Python
Go
C#
Java
YAML

function getPublishedBlueprint(args: GetPublishedBlueprintArgs, opts?: InvokeOptions): Promise<GetPublishedBlueprintResult>
function getPublishedBlueprintOutput(args: GetPublishedBlueprintOutputArgs, opts?: InvokeOptions): Output<GetPublishedBlueprintResult>

def get_published_blueprint(blueprint_name: Optional[str] = None,
                            resource_scope: Optional[str] = None,
                            version_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPublishedBlueprintResult
def get_published_blueprint_output(blueprint_name: Optional[pulumi.Input[str]] = None,
                            resource_scope: Optional[pulumi.Input[str]] = None,
                            version_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPublishedBlueprintResult]

func LookupPublishedBlueprint(ctx *Context, args *LookupPublishedBlueprintArgs, opts ...InvokeOption) (*LookupPublishedBlueprintResult, error)
func LookupPublishedBlueprintOutput(ctx *Context, args *LookupPublishedBlueprintOutputArgs, opts ...InvokeOption) LookupPublishedBlueprintResultOutput

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

public static class GetPublishedBlueprint 
{
    public static Task<GetPublishedBlueprintResult> InvokeAsync(GetPublishedBlueprintArgs args, InvokeOptions? opts = null)
    public static Output<GetPublishedBlueprintResult> Invoke(GetPublishedBlueprintInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPublishedBlueprintResult> getPublishedBlueprint(GetPublishedBlueprintArgs args, InvokeOptions options)
public static Output<GetPublishedBlueprintResult> getPublishedBlueprint(GetPublishedBlueprintArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:blueprint:getPublishedBlueprint
  arguments:
    # arguments dictionary

The following arguments are supported:

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}').
VersionId string: Version of the published blueprint definition.

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}').
VersionId string: Version of the published blueprint definition.

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}').
versionId String: Version of the published blueprint definition.

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}').
versionId string: Version of the published blueprint definition.

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}').
version_id str: Version of the published blueprint definition.

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}').
versionId String: Version of the published blueprint definition.

getPublishedBlueprint Result

The following output properties are available:

Id string: String Id used to locate any resource on Azure.
Name string: Name of this resource.
Status Pulumi.AzureNative.Blueprint.Outputs.BlueprintStatusResponse: Status of the blueprint. This field is readonly.
Type string: Type of this resource.
BlueprintName string: Name of the published blueprint definition.
ChangeNotes string: Version-specific change notes.
Description string: Multi-line explain this resource.
DisplayName string: One-liner string explain this resource.
Parameters Dictionary<string, Pulumi.AzureNative.Blueprint.Outputs.ParameterDefinitionResponse>: Parameters required by this blueprint definition.
ResourceGroups Dictionary<string, Pulumi.AzureNative.Blueprint.Outputs.ResourceGroupDefinitionResponse>: Resource group placeholders defined by this blueprint definition.
TargetScope string: The scope where this blueprint definition can be assigned.

Id string: String Id used to locate any resource on Azure.
Name string: Name of this resource.
Status BlueprintStatusResponse: Status of the blueprint. This field is readonly.
Type string: Type of this resource.
BlueprintName string: Name of the published blueprint definition.
ChangeNotes string: Version-specific change notes.
Description string: Multi-line explain this resource.
DisplayName string: One-liner string explain this resource.
Parameters map[string]ParameterDefinitionResponse: Parameters required by this blueprint definition.
ResourceGroups map[string]ResourceGroupDefinitionResponse: Resource group placeholders defined by this blueprint definition.
TargetScope string: The scope where this blueprint definition can be assigned.

id String: String Id used to locate any resource on Azure.
name String: Name of this resource.
status BlueprintStatusResponse: Status of the blueprint. This field is readonly.
type String: Type of this resource.
blueprintName String: Name of the published blueprint definition.
changeNotes String: Version-specific change notes.
description String: Multi-line explain this resource.
displayName String: One-liner string explain this resource.
parameters Map<String,ParameterDefinitionResponse>: Parameters required by this blueprint definition.
resourceGroups Map<String,ResourceGroupDefinitionResponse>: Resource group placeholders defined by this blueprint definition.
targetScope String: The scope where this blueprint definition can be assigned.

id string: String Id used to locate any resource on Azure.
name string: Name of this resource.
status BlueprintStatusResponse: Status of the blueprint. This field is readonly.
type string: Type of this resource.
blueprintName string: Name of the published blueprint definition.
changeNotes string: Version-specific change notes.
description string: Multi-line explain this resource.
displayName string: One-liner string explain this resource.
parameters {[key: string]: ParameterDefinitionResponse}: Parameters required by this blueprint definition.
resourceGroups {[key: string]: ResourceGroupDefinitionResponse}: Resource group placeholders defined by this blueprint definition.
targetScope string: The scope where this blueprint definition can be assigned.

id str: String Id used to locate any resource on Azure.
name str: Name of this resource.
status BlueprintStatusResponse: Status of the blueprint. This field is readonly.
type str: Type of this resource.
blueprint_name str: Name of the published blueprint definition.
change_notes str: Version-specific change notes.
description str: Multi-line explain this resource.
display_name str: One-liner string explain this resource.
parameters Mapping[str, ParameterDefinitionResponse]: Parameters required by this blueprint definition.
resource_groups Mapping[str, ResourceGroupDefinitionResponse]: Resource group placeholders defined by this blueprint definition.
target_scope str: The scope where this blueprint definition can be assigned.

id String: String Id used to locate any resource on Azure.
name String: Name of this resource.
status Property Map: Status of the blueprint. This field is readonly.
type String: Type of this resource.
blueprintName String: Name of the published blueprint definition.
changeNotes String: Version-specific change notes.
description String: Multi-line explain this resource.
displayName String: One-liner string explain this resource.
parameters Map<Property Map>: Parameters required by this blueprint definition.
resourceGroups Map<Property Map>: Resource group placeholders defined by this blueprint definition.
targetScope String: The scope where this blueprint definition can be assigned.

Supporting Types

BlueprintStatusResponse

LastModified string: Last modified time of this blueprint definition.
TimeCreated string: Creation time of this blueprint definition.

LastModified string: Last modified time of this blueprint definition.
TimeCreated string: Creation time of this blueprint definition.

lastModified String: Last modified time of this blueprint definition.
timeCreated String: Creation time of this blueprint definition.

lastModified string: Last modified time of this blueprint definition.
timeCreated string: Creation time of this blueprint definition.

last_modified str: Last modified time of this blueprint definition.
time_created str: Creation time of this blueprint definition.

lastModified String: Last modified time of this blueprint definition.
timeCreated String: Creation time of this blueprint definition.

ParameterDefinitionResponse

Type string: Allowed data types for Resource Manager template parameters.
AllowedValues List<object>: Array of allowed values for this parameter.
DefaultValue object: Default Value for this parameter.
Description string: Description of this parameter/resourceGroup.
DisplayName string: DisplayName of this parameter/resourceGroup.
StrongType string: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

Type string: Allowed data types for Resource Manager template parameters.
AllowedValues []interface{}: Array of allowed values for this parameter.
DefaultValue interface{}: Default Value for this parameter.
Description string: Description of this parameter/resourceGroup.
DisplayName string: DisplayName of this parameter/resourceGroup.
StrongType string: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type String: Allowed data types for Resource Manager template parameters.
allowedValues List<Object>: Array of allowed values for this parameter.
defaultValue Object: Default Value for this parameter.
description String: Description of this parameter/resourceGroup.
displayName String: DisplayName of this parameter/resourceGroup.
strongType String: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type string: Allowed data types for Resource Manager template parameters.
allowedValues any[]: Array of allowed values for this parameter.
defaultValue any: Default Value for this parameter.
description string: Description of this parameter/resourceGroup.
displayName string: DisplayName of this parameter/resourceGroup.
strongType string: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type str: Allowed data types for Resource Manager template parameters.
allowed_values Sequence[Any]: Array of allowed values for this parameter.
default_value Any: Default Value for this parameter.
description str: Description of this parameter/resourceGroup.
display_name str: DisplayName of this parameter/resourceGroup.
strong_type str: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type String: Allowed data types for Resource Manager template parameters.
allowedValues List<Any>: Array of allowed values for this parameter.
defaultValue Any: Default Value for this parameter.
description String: Description of this parameter/resourceGroup.
displayName String: DisplayName of this parameter/resourceGroup.
strongType String: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

ResourceGroupDefinitionResponse

DependsOn List<string>: Artifacts which need to be deployed before this resource group.
Description string: Description of this parameter/resourceGroup.
DisplayName string: DisplayName of this parameter/resourceGroup.
Location string: Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
Name string: Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
StrongType string: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
Tags Dictionary<string, string>: Tags to be assigned to this resource group.

DependsOn []string: Artifacts which need to be deployed before this resource group.
Description string: Description of this parameter/resourceGroup.
DisplayName string: DisplayName of this parameter/resourceGroup.
Location string: Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
Name string: Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
StrongType string: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
Tags map[string]string: Tags to be assigned to this resource group.

dependsOn List<String>: Artifacts which need to be deployed before this resource group.
description String: Description of this parameter/resourceGroup.
displayName String: DisplayName of this parameter/resourceGroup.
location String: Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
name String: Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
strongType String: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
tags Map<String,String>: Tags to be assigned to this resource group.

dependsOn string[]: Artifacts which need to be deployed before this resource group.
description string: Description of this parameter/resourceGroup.
displayName string: DisplayName of this parameter/resourceGroup.
location string: Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
name string: Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
strongType string: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
tags {[key: string]: string}: Tags to be assigned to this resource group.

depends_on Sequence[str]: Artifacts which need to be deployed before this resource group.
description str: Description of this parameter/resourceGroup.
display_name str: DisplayName of this parameter/resourceGroup.
location str: Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
name str: Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
strong_type str: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
tags Mapping[str, str]: Tags to be assigned to this resource group.

dependsOn List<String>: Artifacts which need to be deployed before this resource group.
description String: Description of this parameter/resourceGroup.
displayName String: DisplayName of this parameter/resourceGroup.
location String: Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
name String: Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
strongType String: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
tags Map<String>: Tags to be assigned to this resource group.

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 v1 docs if using the v1 version of this package.

Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.blueprint.getPublishedBlueprint

On this page

On this page

Using getPublishedBlueprint

getPublishedBlueprint Result

Supporting Types

BlueprintStatusResponse

ParameterDefinitionResponse

ResourceGroupDefinitionResponse

Package Details

On this page

On this page