← All packages

Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.5.0 published on Wednesday, May 4, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Azure Classic
  3. Azure Classic
  4. lighthouse
  5. Definition

Definition

Manages a Lighthouse Definition.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var contributor = Output.Create(Azure.Authorization.GetRoleDefinition.InvokeAsync(new Azure.Authorization.GetRoleDefinitionArgs
        {
            RoleDefinitionId = "b24988ac-6180-42a0-ab88-20f7382dd24c",
        }));
        var example = new Azure.Lighthouse.Definition("example", new Azure.Lighthouse.DefinitionArgs
        {
            Description = "This is a lighthouse definition created IaC",
            ManagingTenantId = "00000000-0000-0000-0000-000000000000",
            Scope = "/subscriptions/00000000-0000-0000-0000-000000000000",
            Authorizations = 
            {
                new Azure.Lighthouse.Inputs.DefinitionAuthorizationArgs
                {
                    PrincipalId = "00000000-0000-0000-0000-000000000000",
                    RoleDefinitionId = contributor.Apply(contributor => contributor.RoleDefinitionId),
                    PrincipalDisplayName = "Tier 1 Support",
                },
            },
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/authorization"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/lighthouse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		contributor, err := authorization.LookupRoleDefinition(ctx, &authorization.LookupRoleDefinitionArgs{
			RoleDefinitionId: pulumi.StringRef("b24988ac-6180-42a0-ab88-20f7382dd24c"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = lighthouse.NewDefinition(ctx, "example", &lighthouse.DefinitionArgs{
			Description:      pulumi.String("This is a lighthouse definition created IaC"),
			ManagingTenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			Scope:            pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000"),
			Authorizations: lighthouse.DefinitionAuthorizationArray{
				&lighthouse.DefinitionAuthorizationArgs{
					PrincipalId:          pulumi.String("00000000-0000-0000-0000-000000000000"),
					RoleDefinitionId:     pulumi.String(contributor.RoleDefinitionId),
					PrincipalDisplayName: pulumi.String("Tier 1 Support"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var contributor = Output.of(AuthorizationFunctions.getRoleDefinition(GetRoleDefinitionArgs.builder()
            .roleDefinitionId("b24988ac-6180-42a0-ab88-20f7382dd24c")
            .build()));

        var example = new Definition("example", DefinitionArgs.builder()        
            .description("This is a lighthouse definition created IaC")
            .managingTenantId("00000000-0000-0000-0000-000000000000")
            .scope("/subscriptions/00000000-0000-0000-0000-000000000000")
            .authorizations(DefinitionAuthorization.builder()
                .principalId("00000000-0000-0000-0000-000000000000")
                .roleDefinitionId(contributor.apply(getRoleDefinitionResult -> getRoleDefinitionResult.getRoleDefinitionId()))
                .principalDisplayName("Tier 1 Support")
                .build())
            .build());

        }
}

import pulumi
import pulumi_azure as azure

contributor = azure.authorization.get_role_definition(role_definition_id="b24988ac-6180-42a0-ab88-20f7382dd24c")
example = azure.lighthouse.Definition("example",
    description="This is a lighthouse definition created IaC",
    managing_tenant_id="00000000-0000-0000-0000-000000000000",
    scope="/subscriptions/00000000-0000-0000-0000-000000000000",
    authorizations=[azure.lighthouse.DefinitionAuthorizationArgs(
        principal_id="00000000-0000-0000-0000-000000000000",
        role_definition_id=contributor.role_definition_id,
        principal_display_name="Tier 1 Support",
    )])

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const contributor = azure.authorization.getRoleDefinition({
    roleDefinitionId: "b24988ac-6180-42a0-ab88-20f7382dd24c",
});
const example = new azure.lighthouse.Definition("example", {
    description: "This is a lighthouse definition created IaC",
    managingTenantId: "00000000-0000-0000-0000-000000000000",
    scope: "/subscriptions/00000000-0000-0000-0000-000000000000",
    authorizations: [{
        principalId: "00000000-0000-0000-0000-000000000000",
        roleDefinitionId: contributor.then(contributor => contributor.roleDefinitionId),
        principalDisplayName: "Tier 1 Support",
    }],
});

resources:
  example:
    type: azure:lighthouse:Definition
    properties:
      description: This is a lighthouse definition created IaC
      managingTenantId: 00000000-0000-0000-0000-000000000000
      scope: /subscriptions/00000000-0000-0000-0000-000000000000
      authorizations:
        - principalId: 00000000-0000-0000-0000-000000000000
          roleDefinitionId: ${contributor.roleDefinitionId}
          principalDisplayName: Tier 1 Support
variables:
  contributor:
    Fn::Invoke:
      Function: azure:authorization:getRoleDefinition
      Arguments:
        roleDefinitionId: b24988ac-6180-42a0-ab88-20f7382dd24c

Create a Definition Resource

new Definition(name: string, args: DefinitionArgs, opts?: CustomResourceOptions);
@overload
def Definition(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               authorizations: Optional[Sequence[DefinitionAuthorizationArgs]] = None,
               description: Optional[str] = None,
               lighthouse_definition_id: Optional[str] = None,
               managing_tenant_id: Optional[str] = None,
               name: Optional[str] = None,
               plan: Optional[DefinitionPlanArgs] = None,
               scope: Optional[str] = None)
@overload
def Definition(resource_name: str,
               args: DefinitionArgs,
               opts: Optional[ResourceOptions] = None)
func NewDefinition(ctx *Context, name string, args DefinitionArgs, opts ...ResourceOption) (*Definition, error)
public Definition(string name, DefinitionArgs args, CustomResourceOptions? opts = null)
public Definition(String name, DefinitionArgs args)
public Definition(String name, DefinitionArgs args, CustomResourceOptions options)

type: azure:lighthouse:Definition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DefinitionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DefinitionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DefinitionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Definition Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Definition resource accepts the following input properties:

Authorizations List<DefinitionAuthorizationArgs>

An authorization block as defined below.

ManagingTenantId string

The ID of the managing tenant. Changing this forces a new resource to be created.

Scope string

The ID of the managed subscription. Changing this forces a new resource to be created.

Description string

A description of the Lighthouse Definition.

LighthouseDefinitionId string

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

Name string

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

Plan DefinitionPlanArgs

A plan block as defined below.

Authorizations []DefinitionAuthorizationArgs

An authorization block as defined below.

ManagingTenantId string

The ID of the managing tenant. Changing this forces a new resource to be created.

Scope string

The ID of the managed subscription. Changing this forces a new resource to be created.

Description string

A description of the Lighthouse Definition.

LighthouseDefinitionId string

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

Name string

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

Plan DefinitionPlanArgs

A plan block as defined below.

authorizations ListAuthorizationArgs>

An authorization block as defined below.

managingTenantId String

The ID of the managing tenant. Changing this forces a new resource to be created.

scope String

The ID of the managed subscription. Changing this forces a new resource to be created.

description String

A description of the Lighthouse Definition.

lighthouseDefinitionId String

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

name String

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan DefinitionPlanArgs

A plan block as defined below.

authorizations DefinitionAuthorizationArgs[]

An authorization block as defined below.

managingTenantId string

The ID of the managing tenant. Changing this forces a new resource to be created.

scope string

The ID of the managed subscription. Changing this forces a new resource to be created.

description string

A description of the Lighthouse Definition.

lighthouseDefinitionId string

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

name string

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan DefinitionPlanArgs

A plan block as defined below.

authorizations Sequence[DefinitionAuthorizationArgs]

An authorization block as defined below.

managing_tenant_id str

The ID of the managing tenant. Changing this forces a new resource to be created.

scope str

The ID of the managed subscription. Changing this forces a new resource to be created.

description str

A description of the Lighthouse Definition.

lighthouse_definition_id str

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

name str

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan DefinitionPlanArgs

A plan block as defined below.

authorizations List

An authorization block as defined below.

managingTenantId String

The ID of the managing tenant. Changing this forces a new resource to be created.

scope String

The ID of the managed subscription. Changing this forces a new resource to be created.

description String

A description of the Lighthouse Definition.

lighthouseDefinitionId String

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

name String

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan Property Map

A plan block as defined below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Definition resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing Definition Resource

Get an existing Definition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DefinitionState, opts?: CustomResourceOptions): Definition
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorizations: Optional[Sequence[DefinitionAuthorizationArgs]] = None,
        description: Optional[str] = None,
        lighthouse_definition_id: Optional[str] = None,
        managing_tenant_id: Optional[str] = None,
        name: Optional[str] = None,
        plan: Optional[DefinitionPlanArgs] = None,
        scope: Optional[str] = None) -> Definition
func GetDefinition(ctx *Context, name string, id IDInput, state *DefinitionState, opts ...ResourceOption) (*Definition, error)
public static Definition Get(string name, Input<string> id, DefinitionState? state, CustomResourceOptions? opts = null)
public static Definition get(String name, Output<String> id, DefinitionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Authorizations List<DefinitionAuthorizationArgs>

An authorization block as defined below.

Description string

A description of the Lighthouse Definition.

LighthouseDefinitionId string

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

ManagingTenantId string

The ID of the managing tenant. Changing this forces a new resource to be created.

Name string

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

Plan DefinitionPlanArgs

A plan block as defined below.

Scope string

The ID of the managed subscription. Changing this forces a new resource to be created.

Authorizations []DefinitionAuthorizationArgs

An authorization block as defined below.

Description string

A description of the Lighthouse Definition.

LighthouseDefinitionId string

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

ManagingTenantId string

The ID of the managing tenant. Changing this forces a new resource to be created.

Name string

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

Plan DefinitionPlanArgs

A plan block as defined below.

Scope string

The ID of the managed subscription. Changing this forces a new resource to be created.

authorizations ListAuthorizationArgs>

An authorization block as defined below.

description String

A description of the Lighthouse Definition.

lighthouseDefinitionId String

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

managingTenantId String

The ID of the managing tenant. Changing this forces a new resource to be created.

name String

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan DefinitionPlanArgs

A plan block as defined below.

scope String

The ID of the managed subscription. Changing this forces a new resource to be created.

authorizations DefinitionAuthorizationArgs[]

An authorization block as defined below.

description string

A description of the Lighthouse Definition.

lighthouseDefinitionId string

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

managingTenantId string

The ID of the managing tenant. Changing this forces a new resource to be created.

name string

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan DefinitionPlanArgs

A plan block as defined below.

scope string

The ID of the managed subscription. Changing this forces a new resource to be created.

authorizations Sequence[DefinitionAuthorizationArgs]

An authorization block as defined below.

description str

A description of the Lighthouse Definition.

lighthouse_definition_id str

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

managing_tenant_id str

The ID of the managing tenant. Changing this forces a new resource to be created.

name str

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan DefinitionPlanArgs

A plan block as defined below.

scope str

The ID of the managed subscription. Changing this forces a new resource to be created.

authorizations List

An authorization block as defined below.

description String

A description of the Lighthouse Definition.

lighthouseDefinitionId String

A unique UUID/GUID which identifies this lighthouse definition - one will be generated if not specified. Changing this forces a new resource to be created.

managingTenantId String

The ID of the managing tenant. Changing this forces a new resource to be created.

name String

The name of the Lighthouse Definition. Changing this forces a new resource to be created.

plan Property Map

A plan block as defined below.

scope String

The ID of the managed subscription. Changing this forces a new resource to be created.

Supporting Types

DefinitionAuthorization

PrincipalId string

Principal ID of the security group/service principal/user that would be assigned permissions to the projected subscription.

RoleDefinitionId string

The role definition identifier. This role will define the permissions that are granted to the principal. This cannot be an Owner role.

DelegatedRoleDefinitionIds List<string>

The set of role definition ids which define all the permissions that the principal id can assign.

PrincipalDisplayName string

The display name of the security group/service principal/user that would be assigned permissions to the projected subscription.

PrincipalId string

Principal ID of the security group/service principal/user that would be assigned permissions to the projected subscription.

RoleDefinitionId string

The role definition identifier. This role will define the permissions that are granted to the principal. This cannot be an Owner role.

DelegatedRoleDefinitionIds []string

The set of role definition ids which define all the permissions that the principal id can assign.

PrincipalDisplayName string

The display name of the security group/service principal/user that would be assigned permissions to the projected subscription.

principalId String

Principal ID of the security group/service principal/user that would be assigned permissions to the projected subscription.

roleDefinitionId String

The role definition identifier. This role will define the permissions that are granted to the principal. This cannot be an Owner role.

delegatedRoleDefinitionIds List

The set of role definition ids which define all the permissions that the principal id can assign.

principalDisplayName String

The display name of the security group/service principal/user that would be assigned permissions to the projected subscription.

principalId string

Principal ID of the security group/service principal/user that would be assigned permissions to the projected subscription.

roleDefinitionId string

The role definition identifier. This role will define the permissions that are granted to the principal. This cannot be an Owner role.

delegatedRoleDefinitionIds string[]

The set of role definition ids which define all the permissions that the principal id can assign.

principalDisplayName string

The display name of the security group/service principal/user that would be assigned permissions to the projected subscription.

principal_id str

Principal ID of the security group/service principal/user that would be assigned permissions to the projected subscription.

role_definition_id str

The role definition identifier. This role will define the permissions that are granted to the principal. This cannot be an Owner role.

delegated_role_definition_ids Sequence[str]

The set of role definition ids which define all the permissions that the principal id can assign.

principal_display_name str

The display name of the security group/service principal/user that would be assigned permissions to the projected subscription.

principalId String

Principal ID of the security group/service principal/user that would be assigned permissions to the projected subscription.

roleDefinitionId String

The role definition identifier. This role will define the permissions that are granted to the principal. This cannot be an Owner role.

delegatedRoleDefinitionIds List

The set of role definition ids which define all the permissions that the principal id can assign.

principalDisplayName String

The display name of the security group/service principal/user that would be assigned permissions to the projected subscription.

DefinitionPlan

Name string

The plan name of the marketplace offer.

Product string

The product code of the plan.

Publisher string

The publisher ID of the plan.

Version string

The version of the plan.

Name string

The plan name of the marketplace offer.

Product string

The product code of the plan.

Publisher string

The publisher ID of the plan.

Version string

The version of the plan.

name String

The plan name of the marketplace offer.

product String

The product code of the plan.

publisher String

The publisher ID of the plan.

version String

The version of the plan.

name string

The plan name of the marketplace offer.

product string

The product code of the plan.

publisher string

The publisher ID of the plan.

version string

The version of the plan.

name str

The plan name of the marketplace offer.

product str

The product code of the plan.

publisher str

The publisher ID of the plan.

version str

The version of the plan.

name String

The plan name of the marketplace offer.

product String

The product code of the plan.

publisher String

The publisher ID of the plan.

version String

The version of the plan.

Import

Lighthouse Definitions can be imported using the resource id, e.g.

 $ pulumi import azure:lighthouse/definition:Definition example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ManagedServices/registrationDefinitions/00000000-0000-0000-0000-000000000000

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.