1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. WorkspaceGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.WorkspaceGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Contract details. Azure REST API version: 2022-09-01-preview.

    Other available API versions: 2023-03-01-preview, 2023-05-01-preview.

    Example Usage

    ApiManagementCreateWorkspaceGroup

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var workspaceGroup = new AzureNative.ApiManagement.WorkspaceGroup("workspaceGroup", new()
        {
            DisplayName = "temp group",
            GroupId = "tempgroup",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            WorkspaceId = "wks1",
        });
    
    });
    
    package main
    
    import (
    	"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.NewWorkspaceGroup(ctx, "workspaceGroup", &apimanagement.WorkspaceGroupArgs{
    			DisplayName:       pulumi.String("temp group"),
    			GroupId:           pulumi.String("tempgroup"),
    			ResourceGroupName: pulumi.String("rg1"),
    			ServiceName:       pulumi.String("apimService1"),
    			WorkspaceId:       pulumi.String("wks1"),
    		})
    		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.WorkspaceGroup;
    import com.pulumi.azurenative.apimanagement.WorkspaceGroupArgs;
    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 workspaceGroup = new WorkspaceGroup("workspaceGroup", WorkspaceGroupArgs.builder()        
                .displayName("temp group")
                .groupId("tempgroup")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .workspaceId("wks1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    workspace_group = azure_native.apimanagement.WorkspaceGroup("workspaceGroup",
        display_name="temp group",
        group_id="tempgroup",
        resource_group_name="rg1",
        service_name="apimService1",
        workspace_id="wks1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const workspaceGroup = new azure_native.apimanagement.WorkspaceGroup("workspaceGroup", {
        displayName: "temp group",
        groupId: "tempgroup",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
        workspaceId: "wks1",
    });
    
    resources:
      workspaceGroup:
        type: azure-native:apimanagement:WorkspaceGroup
        properties:
          displayName: temp group
          groupId: tempgroup
          resourceGroupName: rg1
          serviceName: apimService1
          workspaceId: wks1
    

    ApiManagementCreateWorkspaceGroupExternal

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var workspaceGroup = new AzureNative.ApiManagement.WorkspaceGroup("workspaceGroup", 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,
            WorkspaceId = "wks1",
        });
    
    });
    
    package main
    
    import (
    	"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.NewWorkspaceGroup(ctx, "workspaceGroup", &apimanagement.WorkspaceGroupArgs{
    			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,
    			WorkspaceId:       pulumi.String("wks1"),
    		})
    		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.WorkspaceGroup;
    import com.pulumi.azurenative.apimanagement.WorkspaceGroupArgs;
    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 workspaceGroup = new WorkspaceGroup("workspaceGroup", WorkspaceGroupArgs.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")
                .workspaceId("wks1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    workspace_group = azure_native.apimanagement.WorkspaceGroup("workspaceGroup",
        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,
        workspace_id="wks1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const workspaceGroup = new azure_native.apimanagement.WorkspaceGroup("workspaceGroup", {
        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,
        workspaceId: "wks1",
    });
    
    resources:
      workspaceGroup:
        type: azure-native:apimanagement:WorkspaceGroup
        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
          workspaceId: wks1
    

    Create WorkspaceGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkspaceGroup(name: string, args: WorkspaceGroupArgs, opts?: CustomResourceOptions);
    @overload
    def WorkspaceGroup(resource_name: str,
                       args: WorkspaceGroupArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkspaceGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       display_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       workspace_id: Optional[str] = None,
                       description: Optional[str] = None,
                       external_id: Optional[str] = None,
                       group_id: Optional[str] = None,
                       type: Optional[GroupType] = None)
    func NewWorkspaceGroup(ctx *Context, name string, args WorkspaceGroupArgs, opts ...ResourceOption) (*WorkspaceGroup, error)
    public WorkspaceGroup(string name, WorkspaceGroupArgs args, CustomResourceOptions? opts = null)
    public WorkspaceGroup(String name, WorkspaceGroupArgs args)
    public WorkspaceGroup(String name, WorkspaceGroupArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:WorkspaceGroup
    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 WorkspaceGroupArgs
    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 WorkspaceGroupArgs
    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 WorkspaceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var workspaceGroupResource = new AzureNative.ApiManagement.WorkspaceGroup("workspaceGroupResource", new()
    {
        DisplayName = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        WorkspaceId = "string",
        Description = "string",
        ExternalId = "string",
        GroupId = "string",
        Type = AzureNative.ApiManagement.GroupType.Custom,
    });
    
    example, err := apimanagement.NewWorkspaceGroup(ctx, "workspaceGroupResource", &apimanagement.WorkspaceGroupArgs{
    DisplayName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    WorkspaceId: pulumi.String("string"),
    Description: pulumi.String("string"),
    ExternalId: pulumi.String("string"),
    GroupId: pulumi.String("string"),
    Type: apimanagement.GroupTypeCustom,
    })
    
    var workspaceGroupResource = new WorkspaceGroup("workspaceGroupResource", WorkspaceGroupArgs.builder()        
        .displayName("string")
        .resourceGroupName("string")
        .serviceName("string")
        .workspaceId("string")
        .description("string")
        .externalId("string")
        .groupId("string")
        .type("custom")
        .build());
    
    workspace_group_resource = azure_native.apimanagement.WorkspaceGroup("workspaceGroupResource",
        display_name="string",
        resource_group_name="string",
        service_name="string",
        workspace_id="string",
        description="string",
        external_id="string",
        group_id="string",
        type=azure_native.apimanagement.GroupType.CUSTOM)
    
    const workspaceGroupResource = new azure_native.apimanagement.WorkspaceGroup("workspaceGroupResource", {
        displayName: "string",
        resourceGroupName: "string",
        serviceName: "string",
        workspaceId: "string",
        description: "string",
        externalId: "string",
        groupId: "string",
        type: azure_native.apimanagement.GroupType.Custom,
    });
    
    type: azure-native:apimanagement:WorkspaceGroup
    properties:
        description: string
        displayName: string
        externalId: string
        groupId: string
        resourceGroupName: string
        serviceName: string
        type: custom
        workspaceId: string
    

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

    DisplayName string
    Group name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    WorkspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    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. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    WorkspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    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. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    workspaceId String
    Workspace identifier. Must be unique in the current API Management service instance.
    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. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    workspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    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. The name is case insensitive.
    service_name str
    The name of the API Management service.
    workspace_id str
    Workspace identifier. Must be unique in the current API Management service instance.
    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. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    workspaceId String
    Workspace identifier. Must be unique in the current API Management service instance.
    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 WorkspaceGroup 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
    The name of the resource
    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
    The name of the resource
    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
    The name of the resource
    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
    The name of the resource
    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
    The name of the resource
    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
    The name of the resource

    Supporting Types

    GroupType, GroupTypeArgs

    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:WorkspaceGroup aadGroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi