Documentation
¶
Index ¶
- type LookupManagementGroupArgs
- type LookupManagementGroupOutputArgs
- type LookupManagementGroupResult
- type LookupManagementGroupResultOutput
- func (o LookupManagementGroupResultOutput) AllManagementGroupIds() pulumi.StringArrayOutput
- func (o LookupManagementGroupResultOutput) AllSubscriptionIds() pulumi.StringArrayOutput
- func (o LookupManagementGroupResultOutput) DisplayName() pulumi.StringOutput
- func (LookupManagementGroupResultOutput) ElementType() reflect.Type
- func (o LookupManagementGroupResultOutput) Id() pulumi.StringOutput
- func (o LookupManagementGroupResultOutput) ManagementGroupIds() pulumi.StringArrayOutput
- func (o LookupManagementGroupResultOutput) Name() pulumi.StringOutput
- func (o LookupManagementGroupResultOutput) ParentManagementGroupId() pulumi.StringOutput
- func (o LookupManagementGroupResultOutput) SubscriptionIds() pulumi.StringArrayOutput
- func (o LookupManagementGroupResultOutput) TenantScopedId() pulumi.StringOutput
- func (o LookupManagementGroupResultOutput) ToLookupManagementGroupResultOutput() LookupManagementGroupResultOutput
- func (o LookupManagementGroupResultOutput) ToLookupManagementGroupResultOutputWithContext(ctx context.Context) LookupManagementGroupResultOutput
- type ManagementGroupdeprecated
- type ManagementGroupArgs
- type ManagementGroupArray
- type ManagementGroupArrayInput
- type ManagementGroupArrayOutput
- func (ManagementGroupArrayOutput) ElementType() reflect.Type
- func (o ManagementGroupArrayOutput) Index(i pulumi.IntInput) ManagementGroupOutput
- func (o ManagementGroupArrayOutput) ToManagementGroupArrayOutput() ManagementGroupArrayOutput
- func (o ManagementGroupArrayOutput) ToManagementGroupArrayOutputWithContext(ctx context.Context) ManagementGroupArrayOutput
- type ManagementGroupInput
- type ManagementGroupMap
- type ManagementGroupMapInput
- type ManagementGroupMapOutput
- func (ManagementGroupMapOutput) ElementType() reflect.Type
- func (o ManagementGroupMapOutput) MapIndex(k pulumi.StringInput) ManagementGroupOutput
- func (o ManagementGroupMapOutput) ToManagementGroupMapOutput() ManagementGroupMapOutput
- func (o ManagementGroupMapOutput) ToManagementGroupMapOutputWithContext(ctx context.Context) ManagementGroupMapOutput
- type ManagementGroupOutput
- func (o ManagementGroupOutput) DisplayName() pulumi.StringOutput
- func (ManagementGroupOutput) ElementType() reflect.Type
- func (o ManagementGroupOutput) Name() pulumi.StringOutput
- func (o ManagementGroupOutput) ParentManagementGroupId() pulumi.StringOutput
- func (o ManagementGroupOutput) SubscriptionIds() pulumi.StringArrayOutput
- func (o ManagementGroupOutput) TenantScopedId() pulumi.StringOutput
- func (o ManagementGroupOutput) ToManagementGroupOutput() ManagementGroupOutput
- func (o ManagementGroupOutput) ToManagementGroupOutputWithContext(ctx context.Context) ManagementGroupOutput
- type ManagementGroupState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LookupManagementGroupArgs ¶
type LookupManagementGroupArgs struct { // Specifies the display name of this Management Group. // // > **NOTE** Whilst multiple management groups may share the same display name, when filtering, the provider expects a single management group to be found with this name. DisplayName *string `pulumi:"displayName"` // Specifies the name or UUID of this Management Group. Name *string `pulumi:"name"` }
A collection of arguments for invoking getManagementGroup.
type LookupManagementGroupOutputArgs ¶
type LookupManagementGroupOutputArgs struct { // Specifies the display name of this Management Group. // // > **NOTE** Whilst multiple management groups may share the same display name, when filtering, the provider expects a single management group to be found with this name. DisplayName pulumi.StringPtrInput `pulumi:"displayName"` // Specifies the name or UUID of this Management Group. Name pulumi.StringPtrInput `pulumi:"name"` }
A collection of arguments for invoking getManagementGroup.
func (LookupManagementGroupOutputArgs) ElementType ¶
func (LookupManagementGroupOutputArgs) ElementType() reflect.Type
type LookupManagementGroupResult ¶
type LookupManagementGroupResult struct { // A list of Management Group IDs which directly or indirectly belong to this Management Group. AllManagementGroupIds []string `pulumi:"allManagementGroupIds"` // A list of Subscription IDs which are assigned to this Management Group or its children Management Groups. AllSubscriptionIds []string `pulumi:"allSubscriptionIds"` DisplayName string `pulumi:"displayName"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // A list of Management Group IDs which directly belong to this Management Group. ManagementGroupIds []string `pulumi:"managementGroupIds"` Name string `pulumi:"name"` // The ID of any Parent Management Group. ParentManagementGroupId string `pulumi:"parentManagementGroupId"` // A list of Subscription IDs which are directly assigned to this Management Group. SubscriptionIds []string `pulumi:"subscriptionIds"` // The Management Group ID with the Tenant ID prefix. TenantScopedId string `pulumi:"tenantScopedId"` }
A collection of values returned by getManagementGroup.
func LookupManagementGroup
deprecated
func LookupManagementGroup(ctx *pulumi.Context, args *LookupManagementGroupArgs, opts ...pulumi.InvokeOption) (*LookupManagementGroupResult, error)
Use this data source to access information about an existing Management Group.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/management" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := management.LookupGroup(ctx, &management.LookupGroupArgs{ Name: pulumi.StringRef("00000000-0000-0000-0000-000000000000"), }, nil) if err != nil { return err } ctx.Export("displayName", example.DisplayName) return nil }) }
```
Deprecated: azure.managementgroups.getManagementGroup has been deprecated in favor of azure.management.getGroup
type LookupManagementGroupResultOutput ¶
type LookupManagementGroupResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getManagementGroup.
func LookupManagementGroupOutput ¶
func LookupManagementGroupOutput(ctx *pulumi.Context, args LookupManagementGroupOutputArgs, opts ...pulumi.InvokeOption) LookupManagementGroupResultOutput
func (LookupManagementGroupResultOutput) AllManagementGroupIds ¶ added in v5.16.0
func (o LookupManagementGroupResultOutput) AllManagementGroupIds() pulumi.StringArrayOutput
A list of Management Group IDs which directly or indirectly belong to this Management Group.
func (LookupManagementGroupResultOutput) AllSubscriptionIds ¶ added in v5.16.0
func (o LookupManagementGroupResultOutput) AllSubscriptionIds() pulumi.StringArrayOutput
A list of Subscription IDs which are assigned to this Management Group or its children Management Groups.
func (LookupManagementGroupResultOutput) DisplayName ¶
func (o LookupManagementGroupResultOutput) DisplayName() pulumi.StringOutput
func (LookupManagementGroupResultOutput) ElementType ¶
func (LookupManagementGroupResultOutput) ElementType() reflect.Type
func (LookupManagementGroupResultOutput) Id ¶
func (o LookupManagementGroupResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupManagementGroupResultOutput) ManagementGroupIds ¶ added in v5.16.0
func (o LookupManagementGroupResultOutput) ManagementGroupIds() pulumi.StringArrayOutput
A list of Management Group IDs which directly belong to this Management Group.
func (LookupManagementGroupResultOutput) Name ¶
func (o LookupManagementGroupResultOutput) Name() pulumi.StringOutput
func (LookupManagementGroupResultOutput) ParentManagementGroupId ¶
func (o LookupManagementGroupResultOutput) ParentManagementGroupId() pulumi.StringOutput
The ID of any Parent Management Group.
func (LookupManagementGroupResultOutput) SubscriptionIds ¶
func (o LookupManagementGroupResultOutput) SubscriptionIds() pulumi.StringArrayOutput
A list of Subscription IDs which are directly assigned to this Management Group.
func (LookupManagementGroupResultOutput) TenantScopedId ¶ added in v5.73.0
func (o LookupManagementGroupResultOutput) TenantScopedId() pulumi.StringOutput
The Management Group ID with the Tenant ID prefix.
func (LookupManagementGroupResultOutput) ToLookupManagementGroupResultOutput ¶
func (o LookupManagementGroupResultOutput) ToLookupManagementGroupResultOutput() LookupManagementGroupResultOutput
func (LookupManagementGroupResultOutput) ToLookupManagementGroupResultOutputWithContext ¶
func (o LookupManagementGroupResultOutput) ToLookupManagementGroupResultOutputWithContext(ctx context.Context) LookupManagementGroupResultOutput
type ManagementGroup
deprecated
type ManagementGroup struct { pulumi.CustomResourceState // A friendly name for this Management Group. If not specified, this will be the same as the `name`. DisplayName pulumi.StringOutput `pulumi:"displayName"` // The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The ID of the Parent Management Group. ParentManagementGroupId pulumi.StringOutput `pulumi:"parentManagementGroupId"` // A list of Subscription GUIDs which should be assigned to the Management Group. // // > **Note:** To clear all Subscriptions from the Management Group set `subscriptionIds` to an empty list SubscriptionIds pulumi.StringArrayOutput `pulumi:"subscriptionIds"` // The Management Group ID with the Tenant ID prefix. TenantScopedId pulumi.StringOutput `pulumi:"tenantScopedId"` }
Manages a Management Group.
!> **Note:** Configuring `subscriptionIds` is not supported when using the `management.GroupSubscriptionAssociation` resource, results will be unpredictable.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/management" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { current, err := core.LookupSubscription(ctx, nil, nil) if err != nil { return err } exampleParent, err := management.NewGroup(ctx, "example_parent", &management.GroupArgs{ DisplayName: pulumi.String("ParentGroup"), SubscriptionIds: pulumi.StringArray{ pulumi.String(current.SubscriptionId), }, }) if err != nil { return err } _, err = management.NewGroup(ctx, "example_child", &management.GroupArgs{ DisplayName: pulumi.String("ChildGroup"), ParentManagementGroupId: exampleParent.ID(), SubscriptionIds: pulumi.StringArray{ pulumi.String(current.SubscriptionId), }, }) if err != nil { return err } return nil }) }
```
## Import
Management Groups can be imported using the `management group resource id`, e.g.
```sh $ pulumi import azure:managementgroups/managementGroup:ManagementGroup example /providers/Microsoft.Management/managementGroups/group1 ```
Deprecated: azure.managementgroups.ManagementGroup has been deprecated in favor of azure.management.Group
func GetManagementGroup ¶
func GetManagementGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ManagementGroupState, opts ...pulumi.ResourceOption) (*ManagementGroup, error)
GetManagementGroup gets an existing ManagementGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewManagementGroup ¶
func NewManagementGroup(ctx *pulumi.Context, name string, args *ManagementGroupArgs, opts ...pulumi.ResourceOption) (*ManagementGroup, error)
NewManagementGroup registers a new resource with the given unique name, arguments, and options.
func (*ManagementGroup) ElementType ¶
func (*ManagementGroup) ElementType() reflect.Type
func (*ManagementGroup) ToManagementGroupOutput ¶
func (i *ManagementGroup) ToManagementGroupOutput() ManagementGroupOutput
func (*ManagementGroup) ToManagementGroupOutputWithContext ¶
func (i *ManagementGroup) ToManagementGroupOutputWithContext(ctx context.Context) ManagementGroupOutput
type ManagementGroupArgs ¶
type ManagementGroupArgs struct { // A friendly name for this Management Group. If not specified, this will be the same as the `name`. DisplayName pulumi.StringPtrInput // The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The ID of the Parent Management Group. ParentManagementGroupId pulumi.StringPtrInput // A list of Subscription GUIDs which should be assigned to the Management Group. // // > **Note:** To clear all Subscriptions from the Management Group set `subscriptionIds` to an empty list SubscriptionIds pulumi.StringArrayInput }
The set of arguments for constructing a ManagementGroup resource.
func (ManagementGroupArgs) ElementType ¶
func (ManagementGroupArgs) ElementType() reflect.Type
type ManagementGroupArray ¶
type ManagementGroupArray []ManagementGroupInput
func (ManagementGroupArray) ElementType ¶
func (ManagementGroupArray) ElementType() reflect.Type
func (ManagementGroupArray) ToManagementGroupArrayOutput ¶
func (i ManagementGroupArray) ToManagementGroupArrayOutput() ManagementGroupArrayOutput
func (ManagementGroupArray) ToManagementGroupArrayOutputWithContext ¶
func (i ManagementGroupArray) ToManagementGroupArrayOutputWithContext(ctx context.Context) ManagementGroupArrayOutput
type ManagementGroupArrayInput ¶
type ManagementGroupArrayInput interface { pulumi.Input ToManagementGroupArrayOutput() ManagementGroupArrayOutput ToManagementGroupArrayOutputWithContext(context.Context) ManagementGroupArrayOutput }
ManagementGroupArrayInput is an input type that accepts ManagementGroupArray and ManagementGroupArrayOutput values. You can construct a concrete instance of `ManagementGroupArrayInput` via:
ManagementGroupArray{ ManagementGroupArgs{...} }
type ManagementGroupArrayOutput ¶
type ManagementGroupArrayOutput struct{ *pulumi.OutputState }
func (ManagementGroupArrayOutput) ElementType ¶
func (ManagementGroupArrayOutput) ElementType() reflect.Type
func (ManagementGroupArrayOutput) Index ¶
func (o ManagementGroupArrayOutput) Index(i pulumi.IntInput) ManagementGroupOutput
func (ManagementGroupArrayOutput) ToManagementGroupArrayOutput ¶
func (o ManagementGroupArrayOutput) ToManagementGroupArrayOutput() ManagementGroupArrayOutput
func (ManagementGroupArrayOutput) ToManagementGroupArrayOutputWithContext ¶
func (o ManagementGroupArrayOutput) ToManagementGroupArrayOutputWithContext(ctx context.Context) ManagementGroupArrayOutput
type ManagementGroupInput ¶
type ManagementGroupInput interface { pulumi.Input ToManagementGroupOutput() ManagementGroupOutput ToManagementGroupOutputWithContext(ctx context.Context) ManagementGroupOutput }
type ManagementGroupMap ¶
type ManagementGroupMap map[string]ManagementGroupInput
func (ManagementGroupMap) ElementType ¶
func (ManagementGroupMap) ElementType() reflect.Type
func (ManagementGroupMap) ToManagementGroupMapOutput ¶
func (i ManagementGroupMap) ToManagementGroupMapOutput() ManagementGroupMapOutput
func (ManagementGroupMap) ToManagementGroupMapOutputWithContext ¶
func (i ManagementGroupMap) ToManagementGroupMapOutputWithContext(ctx context.Context) ManagementGroupMapOutput
type ManagementGroupMapInput ¶
type ManagementGroupMapInput interface { pulumi.Input ToManagementGroupMapOutput() ManagementGroupMapOutput ToManagementGroupMapOutputWithContext(context.Context) ManagementGroupMapOutput }
ManagementGroupMapInput is an input type that accepts ManagementGroupMap and ManagementGroupMapOutput values. You can construct a concrete instance of `ManagementGroupMapInput` via:
ManagementGroupMap{ "key": ManagementGroupArgs{...} }
type ManagementGroupMapOutput ¶
type ManagementGroupMapOutput struct{ *pulumi.OutputState }
func (ManagementGroupMapOutput) ElementType ¶
func (ManagementGroupMapOutput) ElementType() reflect.Type
func (ManagementGroupMapOutput) MapIndex ¶
func (o ManagementGroupMapOutput) MapIndex(k pulumi.StringInput) ManagementGroupOutput
func (ManagementGroupMapOutput) ToManagementGroupMapOutput ¶
func (o ManagementGroupMapOutput) ToManagementGroupMapOutput() ManagementGroupMapOutput
func (ManagementGroupMapOutput) ToManagementGroupMapOutputWithContext ¶
func (o ManagementGroupMapOutput) ToManagementGroupMapOutputWithContext(ctx context.Context) ManagementGroupMapOutput
type ManagementGroupOutput ¶
type ManagementGroupOutput struct{ *pulumi.OutputState }
func (ManagementGroupOutput) DisplayName ¶ added in v5.5.0
func (o ManagementGroupOutput) DisplayName() pulumi.StringOutput
A friendly name for this Management Group. If not specified, this will be the same as the `name`.
func (ManagementGroupOutput) ElementType ¶
func (ManagementGroupOutput) ElementType() reflect.Type
func (ManagementGroupOutput) Name ¶ added in v5.5.0
func (o ManagementGroupOutput) Name() pulumi.StringOutput
The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created.
func (ManagementGroupOutput) ParentManagementGroupId ¶ added in v5.5.0
func (o ManagementGroupOutput) ParentManagementGroupId() pulumi.StringOutput
The ID of the Parent Management Group.
func (ManagementGroupOutput) SubscriptionIds ¶ added in v5.5.0
func (o ManagementGroupOutput) SubscriptionIds() pulumi.StringArrayOutput
A list of Subscription GUIDs which should be assigned to the Management Group.
> **Note:** To clear all Subscriptions from the Management Group set `subscriptionIds` to an empty list
func (ManagementGroupOutput) TenantScopedId ¶ added in v5.73.0
func (o ManagementGroupOutput) TenantScopedId() pulumi.StringOutput
The Management Group ID with the Tenant ID prefix.
func (ManagementGroupOutput) ToManagementGroupOutput ¶
func (o ManagementGroupOutput) ToManagementGroupOutput() ManagementGroupOutput
func (ManagementGroupOutput) ToManagementGroupOutputWithContext ¶
func (o ManagementGroupOutput) ToManagementGroupOutputWithContext(ctx context.Context) ManagementGroupOutput
type ManagementGroupState ¶
type ManagementGroupState struct { // A friendly name for this Management Group. If not specified, this will be the same as the `name`. DisplayName pulumi.StringPtrInput // The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The ID of the Parent Management Group. ParentManagementGroupId pulumi.StringPtrInput // A list of Subscription GUIDs which should be assigned to the Management Group. // // > **Note:** To clear all Subscriptions from the Management Group set `subscriptionIds` to an empty list SubscriptionIds pulumi.StringArrayInput // The Management Group ID with the Tenant ID prefix. TenantScopedId pulumi.StringPtrInput }
func (ManagementGroupState) ElementType ¶
func (ManagementGroupState) ElementType() reflect.Type