azure-native.apimanagement.Group
Explore with Pulumi AI
Contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2016-10-10, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateGroup
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var @group = new AzureNative.ApiManagement.Group("group", new()
{
DisplayName = "temp group",
GroupId = "tempgroup",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Group;
import com.pulumi.azurenative.apimanagement.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
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 System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var @group = new AzureNative.ApiManagement.Group("group", new()
{
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/apimanagement/v2"
"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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Group;
import com.pulumi.azurenative.apimanagement.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
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 Group Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
args: GroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Group(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
description: Optional[str] = None,
external_id: Optional[str] = None,
group_id: Optional[str] = None,
type: Optional[GroupType] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
type: azure-native:apimanagement:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var groupResource = new AzureNative.ApiManagement.Group("groupResource", new()
{
DisplayName = "string",
ResourceGroupName = "string",
ServiceName = "string",
Description = "string",
ExternalId = "string",
GroupId = "string",
Type = AzureNative.ApiManagement.GroupType.Custom,
});
example, err := apimanagement.NewGroup(ctx, "groupResource", &apimanagement.GroupArgs{
DisplayName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Description: pulumi.String("string"),
ExternalId: pulumi.String("string"),
GroupId: pulumi.String("string"),
Type: apimanagement.GroupTypeCustom,
})
var groupResource = new Group("groupResource", GroupArgs.builder()
.displayName("string")
.resourceGroupName("string")
.serviceName("string")
.description("string")
.externalId("string")
.groupId("string")
.type("custom")
.build());
group_resource = azure_native.apimanagement.Group("groupResource",
display_name="string",
resource_group_name="string",
service_name="string",
description="string",
external_id="string",
group_id="string",
type=azure_native.apimanagement.GroupType.CUSTOM)
const groupResource = new azure_native.apimanagement.Group("groupResource", {
displayName: "string",
resourceGroupName: "string",
serviceName: "string",
description: "string",
externalId: "string",
groupId: "string",
type: azure_native.apimanagement.GroupType.Custom,
});
type: azure-native:apimanagement:Group
properties:
description: string
displayName: string
externalId: string
groupId: string
resourceGroupName: string
serviceName: string
type: custom
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Group resource accepts the following input properties:
- Display
Name string - Group name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Description string
- Group description.
- External
Id 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. - Group
Id string - Group identifier. Must be unique in the current API Management service instance.
- Type
Pulumi.
Azure Native. Api Management. Group Type - Group type.
- Display
Name string - Group name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Description string
- Group description.
- External
Id 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. - Group
Id string - Group identifier. Must be unique in the current API Management service instance.
- Type
Group
Type - Group type.
- display
Name String - Group name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- description String
- Group description.
- external
Id 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. - group
Id String - Group identifier. Must be unique in the current API Management service instance.
- type
Group
Type - Group type.
- display
Name string - Group name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- description string
- Group description.
- external
Id 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. - group
Id string - Group identifier. Must be unique in the current API Management service instance.
- type
Group
Type - Group type.
- display_
name str - Group name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- 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
Group
Type - Group type.
- display
Name String - Group name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- description String
- Group description.
- external
Id 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. - group
Id 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:
Supporting Types
GroupType, GroupTypeArgs
- Custom
- custom
- System
- system
- External
- external
- Group
Type Custom - custom
- Group
Type System - system
- Group
Type External - 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0