1. Packages
  2. Azure Native
  3. API Docs
  4. blueprint
  5. getBlueprint
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.blueprint.getBlueprint

Explore with Pulumi AI

azure-native logo
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

    Get a blueprint definition. API Version: 2018-11-01-preview.

    Using getBlueprint

    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 getBlueprint(args: GetBlueprintArgs, opts?: InvokeOptions): Promise<GetBlueprintResult>
    function getBlueprintOutput(args: GetBlueprintOutputArgs, opts?: InvokeOptions): Output<GetBlueprintResult>
    def get_blueprint(blueprint_name: Optional[str] = None,
                      resource_scope: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBlueprintResult
    def get_blueprint_output(blueprint_name: Optional[pulumi.Input[str]] = None,
                      resource_scope: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBlueprintResult]
    func LookupBlueprint(ctx *Context, args *LookupBlueprintArgs, opts ...InvokeOption) (*LookupBlueprintResult, error)
    func LookupBlueprintOutput(ctx *Context, args *LookupBlueprintOutputArgs, opts ...InvokeOption) LookupBlueprintResultOutput

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

    public static class GetBlueprint 
    {
        public static Task<GetBlueprintResult> InvokeAsync(GetBlueprintArgs args, InvokeOptions? opts = null)
        public static Output<GetBlueprintResult> Invoke(GetBlueprintInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBlueprintResult> getBlueprint(GetBlueprintArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:blueprint:getBlueprint
      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}').

    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}').

    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}').

    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}').

    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}').

    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}').

    getBlueprint Result

    The following output properties are available:

    Id string

    String Id used to locate any resource on Azure.

    Layout object

    Layout view of the blueprint definition for UI reference.

    Name string

    Name of this resource.

    Status Pulumi.AzureNative.Blueprint.Outputs.BlueprintStatusResponse

    Status of the blueprint. This field is readonly.

    TargetScope string

    The scope where this blueprint definition can be assigned.

    Type string

    Type of this resource.

    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.

    Versions object

    Published versions of this blueprint definition.

    Id string

    String Id used to locate any resource on Azure.

    Layout interface{}

    Layout view of the blueprint definition for UI reference.

    Name string

    Name of this resource.

    Status BlueprintStatusResponse

    Status of the blueprint. This field is readonly.

    TargetScope string

    The scope where this blueprint definition can be assigned.

    Type string

    Type of this resource.

    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.

    Versions interface{}

    Published versions of this blueprint definition.

    id String

    String Id used to locate any resource on Azure.

    layout Object

    Layout view of the blueprint definition for UI reference.

    name String

    Name of this resource.

    status BlueprintStatusResponse

    Status of the blueprint. This field is readonly.

    targetScope String

    The scope where this blueprint definition can be assigned.

    type String

    Type of this resource.

    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.

    versions Object

    Published versions of this blueprint definition.

    id string

    String Id used to locate any resource on Azure.

    layout any

    Layout view of the blueprint definition for UI reference.

    name string

    Name of this resource.

    status BlueprintStatusResponse

    Status of the blueprint. This field is readonly.

    targetScope string

    The scope where this blueprint definition can be assigned.

    type string

    Type of this resource.

    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.

    versions any

    Published versions of this blueprint definition.

    id str

    String Id used to locate any resource on Azure.

    layout Any

    Layout view of the blueprint definition for UI reference.

    name str

    Name of this resource.

    status BlueprintStatusResponse

    Status of the blueprint. This field is readonly.

    target_scope str

    The scope where this blueprint definition can be assigned.

    type str

    Type of this resource.

    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.

    versions Any

    Published versions of this blueprint definition.

    id String

    String Id used to locate any resource on Azure.

    layout Any

    Layout view of the blueprint definition for UI reference.

    name String

    Name of this resource.

    status Property Map

    Status of the blueprint. This field is readonly.

    targetScope String

    The scope where this blueprint definition can be assigned.

    type String

    Type of this resource.

    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.

    versions Any

    Published versions of this blueprint definition.

    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
    azure-native logo
    Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi