1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. Group

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.apimanagement.Group

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Manages an API Management Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleService = new azure.apimanagement.Service("example", {
        name: "example-apim",
        location: example.location,
        resourceGroupName: example.name,
        publisherName: "pub1",
        publisherEmail: "pub1@email.com",
        skuName: "Developer_1",
    });
    const exampleGroup = new azure.apimanagement.Group("example", {
        name: "example-apimg",
        resourceGroupName: example.name,
        apiManagementName: exampleService.name,
        displayName: "Example Group",
        description: "This is an example API management group.",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_service = azure.apimanagement.Service("example",
        name="example-apim",
        location=example.location,
        resource_group_name=example.name,
        publisher_name="pub1",
        publisher_email="pub1@email.com",
        sku_name="Developer_1")
    example_group = azure.apimanagement.Group("example",
        name="example-apimg",
        resource_group_name=example.name,
        api_management_name=example_service.name,
        display_name="Example Group",
        description="This is an example API management group.")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
    			Name:              pulumi.String("example-apim"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			PublisherName:     pulumi.String("pub1"),
    			PublisherEmail:    pulumi.String("pub1@email.com"),
    			SkuName:           pulumi.String("Developer_1"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apimanagement.NewGroup(ctx, "example", &apimanagement.GroupArgs{
    			Name:              pulumi.String("example-apimg"),
    			ResourceGroupName: example.Name,
    			ApiManagementName: exampleService.Name,
    			DisplayName:       pulumi.String("Example Group"),
    			Description:       pulumi.String("This is an example API management group."),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleService = new Azure.ApiManagement.Service("example", new()
        {
            Name = "example-apim",
            Location = example.Location,
            ResourceGroupName = example.Name,
            PublisherName = "pub1",
            PublisherEmail = "pub1@email.com",
            SkuName = "Developer_1",
        });
    
        var exampleGroup = new Azure.ApiManagement.Group("example", new()
        {
            Name = "example-apimg",
            ResourceGroupName = example.Name,
            ApiManagementName = exampleService.Name,
            DisplayName = "Example Group",
            Description = "This is an example API management group.",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.apimanagement.Service;
    import com.pulumi.azure.apimanagement.ServiceArgs;
    import com.pulumi.azure.apimanagement.Group;
    import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()
                .name("example-apim")
                .location(example.location())
                .resourceGroupName(example.name())
                .publisherName("pub1")
                .publisherEmail("pub1@email.com")
                .skuName("Developer_1")
                .build());
    
            var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
                .name("example-apimg")
                .resourceGroupName(example.name())
                .apiManagementName(exampleService.name())
                .displayName("Example Group")
                .description("This is an example API management group.")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleService:
        type: azure:apimanagement:Service
        name: example
        properties:
          name: example-apim
          location: ${example.location}
          resourceGroupName: ${example.name}
          publisherName: pub1
          publisherEmail: pub1@email.com
          skuName: Developer_1
      exampleGroup:
        type: azure:apimanagement:Group
        name: example
        properties:
          name: example-apimg
          resourceGroupName: ${example.name}
          apiManagementName: ${exampleService.name}
          displayName: Example Group
          description: This is an example API management group.
    

    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,
              api_management_name: Optional[str] = None,
              display_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              description: Optional[str] = None,
              external_id: Optional[str] = None,
              name: Optional[str] = None,
              type: Optional[str] = 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: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 Azure.ApiManagement.Group("groupResource", new()
    {
        ApiManagementName = "string",
        DisplayName = "string",
        ResourceGroupName = "string",
        Description = "string",
        ExternalId = "string",
        Name = "string",
        Type = "string",
    });
    
    example, err := apimanagement.NewGroup(ctx, "groupResource", &apimanagement.GroupArgs{
    	ApiManagementName: pulumi.String("string"),
    	DisplayName:       pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	ExternalId:        pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Type:              pulumi.String("string"),
    })
    
    var groupResource = new Group("groupResource", GroupArgs.builder()
        .apiManagementName("string")
        .displayName("string")
        .resourceGroupName("string")
        .description("string")
        .externalId("string")
        .name("string")
        .type("string")
        .build());
    
    group_resource = azure.apimanagement.Group("groupResource",
        api_management_name="string",
        display_name="string",
        resource_group_name="string",
        description="string",
        external_id="string",
        name="string",
        type="string")
    
    const groupResource = new azure.apimanagement.Group("groupResource", {
        apiManagementName: "string",
        displayName: "string",
        resourceGroupName: "string",
        description: "string",
        externalId: "string",
        name: "string",
        type: "string",
    });
    
    type: azure:apimanagement:Group
    properties:
        apiManagementName: string
        description: string
        displayName: string
        externalId: string
        name: string
        resourceGroupName: string
        type: string
    

    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:

    ApiManagementName string
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    DisplayName string
    The display name of this API Management Group.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    Description string
    The description of this API Management Group.
    ExternalId string
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    Name string
    The name of the API Management Group. Changing this forces a new resource to be created.
    Type string
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    ApiManagementName string
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    DisplayName string
    The display name of this API Management Group.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    Description string
    The description of this API Management Group.
    ExternalId string
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    Name string
    The name of the API Management Group. Changing this forces a new resource to be created.
    Type string
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    apiManagementName String
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    displayName String
    The display name of this API Management Group.
    resourceGroupName String
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    description String
    The description of this API Management Group.
    externalId String
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name String
    The name of the API Management Group. Changing this forces a new resource to be created.
    type String
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    apiManagementName string
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    displayName string
    The display name of this API Management Group.
    resourceGroupName string
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    description string
    The description of this API Management Group.
    externalId string
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name string
    The name of the API Management Group. Changing this forces a new resource to be created.
    type string
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    api_management_name str
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    display_name str
    The display name of this API Management Group.
    resource_group_name str
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    description str
    The description of this API Management Group.
    external_id str
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name str
    The name of the API Management Group. Changing this forces a new resource to be created.
    type str
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    apiManagementName String
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    displayName String
    The display name of this API Management Group.
    resourceGroupName String
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    description String
    The description of this API Management Group.
    externalId String
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name String
    The name of the API Management Group. Changing this forces a new resource to be created.
    type String
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Group 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 Existing Group Resource

    Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_management_name: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            external_id: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            type: Optional[str] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState 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:
    ApiManagementName string
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    Description string
    The description of this API Management Group.
    DisplayName string
    The display name of this API Management Group.
    ExternalId string
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    Name string
    The name of the API Management Group. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    Type string
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    ApiManagementName string
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    Description string
    The description of this API Management Group.
    DisplayName string
    The display name of this API Management Group.
    ExternalId string
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    Name string
    The name of the API Management Group. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    Type string
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    apiManagementName String
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    description String
    The description of this API Management Group.
    displayName String
    The display name of this API Management Group.
    externalId String
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name String
    The name of the API Management Group. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    type String
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    apiManagementName string
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    description string
    The description of this API Management Group.
    displayName string
    The display name of this API Management Group.
    externalId string
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name string
    The name of the API Management Group. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    type string
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    api_management_name str
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    description str
    The description of this API Management Group.
    display_name str
    The display name of this API Management Group.
    external_id str
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name str
    The name of the API Management Group. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    type str
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.
    apiManagementName String
    The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
    description String
    The description of this API Management Group.
    displayName String
    The display name of this API Management Group.
    externalId String
    The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>. Changing this forces a new resource to be created.
    name String
    The name of the API Management Group. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
    type String
    The type of this API Management Group. Possible values are custom, external and system. Default is custom. Changing this forces a new resource to be created.

    Import

    API Management Groups can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/group:Group example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/groups/example-apimg
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi