1. Docs
  2. Reference
  3. API
  4. Azure
  5. blueprint
  6. GetDefinition

GetDefinition

Use this data source to access information about an existing Azure Blueprint Definition

NOTE: Azure Blueprints are in Preview and potentially subject to breaking change without notice.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var root = current.Apply(current => Output.Create(Azure.Management.GetGroup.InvokeAsync(new Azure.Management.GetGroupArgs
        {
            Name = current.TenantId,
        })));
        var example = root.Apply(root => Output.Create(Azure.Blueprint.GetDefinition.InvokeAsync(new Azure.Blueprint.GetDefinitionArgs
        {
            Name = "exampleManagementGroupBP",
            ScopeId = root.Id,
        })));
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/blueprint"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/management"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        current, err := core.GetClientConfig(ctx, nil, nil)
        if err != nil {
            return err
        }
        opt0 := current.TenantId
        root, err := management.LookupGroup(ctx, &management.LookupGroupArgs{
            Name: &opt0,
        }, nil)
        if err != nil {
            return err
        }
        _, err := blueprint.GetDefinition(ctx, &blueprint.GetDefinitionArgs{
            Name:    "exampleManagementGroupBP",
            ScopeId: root.Id,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
root = azure.management.get_group(name=current.tenant_id)
example = azure.blueprint.get_definition(name="exampleManagementGroupBP",
    scope_id=root.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const root = current.then(current => azure.management.getGroup({
    name: current.tenantId,
}));
const example = root.then(root => azure.blueprint.getDefinition({
    name: "exampleManagementGroupBP",
    scopeId: root.id,
}));

Using GetDefinition

function getDefinition(args: GetDefinitionArgs, opts?: InvokeOptions): Promise<GetDefinitionResult>
function  get_definition(name=None, scope_id=None, opts=None)
func GetDefinition(ctx *Context, args *GetDefinitionArgs, opts ...InvokeOption) (*GetDefinitionResult, error)
public static class GetDefinition {
    public static Task<GetDefinitionResult> InvokeAsync(GetDefinitionArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the Blueprint

ScopeId string

The Resource ID of the scope at which the blueprint definition is stored. This will be with either a Subscription ID or Management Group ID.

Name string

The name of the Blueprint

ScopeId string

The Resource ID of the scope at which the blueprint definition is stored. This will be with either a Subscription ID or Management Group ID.

name string

The name of the Blueprint

scopeId string

The Resource ID of the scope at which the blueprint definition is stored. This will be with either a Subscription ID or Management Group ID.

name str

The name of the Blueprint

scope_id str

The Resource ID of the scope at which the blueprint definition is stored. This will be with either a Subscription ID or Management Group ID.

GetDefinition Result

The following output properties are available:

Description string

The description of the Blueprint Definition.

DisplayName string

The display name of the Blueprint Definition.

Id string

The provider-assigned unique ID for this managed resource.

LastModified string

The timestamp of when this last modification was saved to the Blueprint Definition.

Name string
ScopeId string
TargetScope string

The target scope.

TimeCreated string

The timestamp of when this Blueprint Definition was created.

Versions List<string>

A list of versions published for this Blueprint Definition.

Description string

The description of the Blueprint Definition.

DisplayName string

The display name of the Blueprint Definition.

Id string

The provider-assigned unique ID for this managed resource.

LastModified string

The timestamp of when this last modification was saved to the Blueprint Definition.

Name string
ScopeId string
TargetScope string

The target scope.

TimeCreated string

The timestamp of when this Blueprint Definition was created.

Versions []string

A list of versions published for this Blueprint Definition.

description string

The description of the Blueprint Definition.

displayName string

The display name of the Blueprint Definition.

id string

The provider-assigned unique ID for this managed resource.

lastModified string

The timestamp of when this last modification was saved to the Blueprint Definition.

name string
scopeId string
targetScope string

The target scope.

timeCreated string

The timestamp of when this Blueprint Definition was created.

versions string[]

A list of versions published for this Blueprint Definition.

description str

The description of the Blueprint Definition.

display_name str

The display name of the Blueprint Definition.

id str

The provider-assigned unique ID for this managed resource.

last_modified str

The timestamp of when this last modification was saved to the Blueprint Definition.

name str
scope_id str
target_scope str

The target scope.

time_created str

The timestamp of when this Blueprint Definition was created.

versions List[str]

A list of versions published for this Blueprint Definition.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.