Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

Group

Contract details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateGroup

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var @group = new AzureNative.ApiManagement.Group("group", new AzureNative.ApiManagement.GroupArgs
        {
            DisplayName = "temp group",
            GroupId = "tempgroup",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewGroup(ctx, "group", &apimanagement.GroupArgs{
			DisplayName:       pulumi.String("temp group"),
			GroupId:           pulumi.String("tempgroup"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
		})
		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) {
        var group = new Group("group", GroupArgs.builder()        
            .displayName("temp group")
            .groupId("tempgroup")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

group = azure_native.apimanagement.Group("group",
    display_name="temp group",
    group_id="tempgroup",
    resource_group_name="rg1",
    service_name="apimService1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const group = new azure_native.apimanagement.Group("group", {
    displayName: "temp group",
    groupId: "tempgroup",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});
resources:
  group:
    type: azure-native:apimanagement:Group
    properties:
      displayName: temp group
      groupId: tempgroup
      resourceGroupName: rg1
      serviceName: apimService1

ApiManagementCreateGroupExternal

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var @group = new AzureNative.ApiManagement.Group("group", new AzureNative.ApiManagement.GroupArgs
        {
            Description = "new group to test",
            DisplayName = "NewGroup (samiraad.onmicrosoft.com)",
            ExternalId = "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d",
            GroupId = "aadGroup",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            Type = AzureNative.ApiManagement.GroupType.External,
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewGroup(ctx, "group", &apimanagement.GroupArgs{
			Description:       pulumi.String("new group to test"),
			DisplayName:       pulumi.String("NewGroup (samiraad.onmicrosoft.com)"),
			ExternalId:        pulumi.String("aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"),
			GroupId:           pulumi.String("aadGroup"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			Type:              apimanagement.GroupTypeExternal,
		})
		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) {
        var group = new Group("group", GroupArgs.builder()        
            .description("new group to test")
            .displayName("NewGroup (samiraad.onmicrosoft.com)")
            .externalId("aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d")
            .groupId("aadGroup")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .type("external")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

group = azure_native.apimanagement.Group("group",
    description="new group to test",
    display_name="NewGroup (samiraad.onmicrosoft.com)",
    external_id="aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d",
    group_id="aadGroup",
    resource_group_name="rg1",
    service_name="apimService1",
    type=azure_native.apimanagement.GroupType.EXTERNAL)
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const group = new azure_native.apimanagement.Group("group", {
    description: "new group to test",
    displayName: "NewGroup (samiraad.onmicrosoft.com)",
    externalId: "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d",
    groupId: "aadGroup",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    type: azure_native.apimanagement.GroupType.External,
});
resources:
  group:
    type: azure-native:apimanagement:Group
    properties:
      description: new group to test
      displayName: NewGroup (samiraad.onmicrosoft.com)
      externalId: aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d
      groupId: aadGroup
      resourceGroupName: rg1
      serviceName: apimService1
      type: external

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None,
          external_id: Optional[str] = None,
          group_id: Optional[str] = None,
          resource_group_name: Optional[str] = None,
          service_name: Optional[str] = None,
          type: Optional[GroupType] = None)
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args GroupArgs
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 GroupArgs
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 GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Group 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 Group resource accepts the following input properties:

DisplayName string

Group name.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Description string

Group description.

ExternalId string

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

GroupId string

Group identifier. Must be unique in the current API Management service instance.

Type Pulumi.AzureNative.ApiManagement.GroupType

Group type.

DisplayName string

Group name.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Description string

Group description.

ExternalId string

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

GroupId string

Group identifier. Must be unique in the current API Management service instance.

Type GroupType

Group type.

displayName String

Group name.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

description String

Group description.

externalId String

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

groupId String

Group identifier. Must be unique in the current API Management service instance.

type GroupType

Group type.

displayName string

Group name.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

description string

Group description.

externalId string

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

groupId string

Group identifier. Must be unique in the current API Management service instance.

type GroupType

Group type.

display_name str

Group name.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

description str

Group description.

external_id str

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

group_id str

Group identifier. Must be unique in the current API Management service instance.

type GroupType

Group type.

displayName String

Group name.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

description String

Group description.

externalId String

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

groupId String

Group identifier. Must be unique in the current API Management service instance.

type "custom" | "system" | "external"

Group type.

Outputs

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

BuiltIn bool

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

BuiltIn bool

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

builtIn Boolean

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

builtIn boolean

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name.

built_in bool

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name.

builtIn Boolean

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

Supporting Types

GroupType

Custom
custom
System
system
External
external
GroupTypeCustom
custom
GroupTypeSystem
system
GroupTypeExternal
external
Custom
custom
System
system
External
external
Custom
custom
System
system
External
external
CUSTOM
custom
SYSTEM
system
EXTERNAL
external
"custom"
custom
"system"
system
"external"
external

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:Group aadGroup /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup 

Package Details

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