azure-native.blueprint.getBlueprint
Explore with Pulumi AI
Get a blueprint definition. Azure REST API version: 2018-11-01-preview.
Other available API versions: 2017-11-11-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:
- Blueprint
Name string Name of the blueprint definition.
- Resource
Scope string The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- Blueprint
Name string Name of the blueprint definition.
- Resource
Scope string The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- blueprint
Name String Name of the blueprint definition.
- resource
Scope String The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- blueprint
Name string Name of the blueprint definition.
- resource
Scope 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}').
- blueprint
Name String Name of the blueprint definition.
- resource
Scope 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.
Azure Native. Blueprint. Outputs. Blueprint Status Response Status of the blueprint. This field is readonly.
- Target
Scope string The scope where this blueprint definition can be assigned.
- Type string
Type of this resource.
- Description string
Multi-line explain this resource.
- Display
Name string One-liner string explain this resource.
- Parameters
Dictionary<string, Pulumi.
Azure Native. Blueprint. Outputs. Parameter Definition Response> Parameters required by this blueprint definition.
- Resource
Groups Dictionary<string, Pulumi.Azure Native. Blueprint. Outputs. Resource Group Definition Response> 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
Blueprint
Status Response Status of the blueprint. This field is readonly.
- Target
Scope string The scope where this blueprint definition can be assigned.
- Type string
Type of this resource.
- Description string
Multi-line explain this resource.
- Display
Name string One-liner string explain this resource.
- Parameters
map[string]Parameter
Definition Response Parameters required by this blueprint definition.
- Resource
Groups map[string]ResourceGroup Definition Response 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
Blueprint
Status Response Status of the blueprint. This field is readonly.
- target
Scope String The scope where this blueprint definition can be assigned.
- type String
Type of this resource.
- description String
Multi-line explain this resource.
- display
Name String One-liner string explain this resource.
- parameters
Map<String,Parameter
Definition Response> Parameters required by this blueprint definition.
- resource
Groups Map<String,ResourceGroup Definition Response> 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
Blueprint
Status Response Status of the blueprint. This field is readonly.
- target
Scope string The scope where this blueprint definition can be assigned.
- type string
Type of this resource.
- description string
Multi-line explain this resource.
- display
Name string One-liner string explain this resource.
- parameters
{[key: string]: Parameter
Definition Response} Parameters required by this blueprint definition.
- resource
Groups {[key: string]: ResourceGroup Definition Response} 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
Blueprint
Status Response 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, Parameter
Definition Response] Parameters required by this blueprint definition.
- resource_
groups Mapping[str, ResourceGroup Definition Response] 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.
- target
Scope String The scope where this blueprint definition can be assigned.
- type String
Type of this resource.
- description String
Multi-line explain this resource.
- display
Name String One-liner string explain this resource.
- parameters Map<Property Map>
Parameters required by this blueprint definition.
- resource
Groups Map<Property Map> Resource group placeholders defined by this blueprint definition.
- versions Any
Published versions of this blueprint definition.
Supporting Types
BlueprintStatusResponse
- Last
Modified string Last modified time of this blueprint definition.
- Time
Created string Creation time of this blueprint definition.
- Last
Modified string Last modified time of this blueprint definition.
- Time
Created string Creation time of this blueprint definition.
- last
Modified String Last modified time of this blueprint definition.
- time
Created String Creation time of this blueprint definition.
- last
Modified string Last modified time of this blueprint definition.
- time
Created 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.
- last
Modified String Last modified time of this blueprint definition.
- time
Created String Creation time of this blueprint definition.
ParameterDefinitionResponse
- Type string
Allowed data types for Resource Manager template parameters.
- Allowed
Values List<object> Array of allowed values for this parameter.
- Default
Value object Default Value for this parameter.
- Description string
Description of this parameter/resourceGroup.
- Display
Name string DisplayName of this parameter/resourceGroup.
- Strong
Type 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.
- Allowed
Values []interface{} Array of allowed values for this parameter.
- Default
Value interface{} Default Value for this parameter.
- Description string
Description of this parameter/resourceGroup.
- Display
Name string DisplayName of this parameter/resourceGroup.
- Strong
Type 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.
- allowed
Values List<Object> Array of allowed values for this parameter.
- default
Value Object Default Value for this parameter.
- description String
Description of this parameter/resourceGroup.
- display
Name String DisplayName of this parameter/resourceGroup.
- strong
Type 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.
- allowed
Values any[] Array of allowed values for this parameter.
- default
Value any Default Value for this parameter.
- description string
Description of this parameter/resourceGroup.
- display
Name string DisplayName of this parameter/resourceGroup.
- strong
Type 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.
- allowed
Values List<Any> Array of allowed values for this parameter.
- default
Value Any Default Value for this parameter.
- description String
Description of this parameter/resourceGroup.
- display
Name String DisplayName of this parameter/resourceGroup.
- strong
Type String StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
ResourceGroupDefinitionResponse
- Depends
On List<string> Artifacts which need to be deployed before this resource group.
- Description string
Description of this parameter/resourceGroup.
- Display
Name 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.
- Strong
Type string StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Dictionary<string, string>
Tags to be assigned to this resource group.
- Depends
On []string Artifacts which need to be deployed before this resource group.
- Description string
Description of this parameter/resourceGroup.
- Display
Name 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.
- Strong
Type string StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- map[string]string
Tags to be assigned to this resource group.
- depends
On List<String> Artifacts which need to be deployed before this resource group.
- description String
Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type String StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Map<String,String>
Tags to be assigned to this resource group.
- depends
On string[] Artifacts which need to be deployed before this resource group.
- description string
Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type string StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- {[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.
- Mapping[str, str]
Tags to be assigned to this resource group.
- depends
On List<String> Artifacts which need to be deployed before this resource group.
- description String
Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type String StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Map<String>
Tags to be assigned to this resource group.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0