Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. ProductGroup
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.ProductGroup

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.

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

    Example Usage

    ApiManagementCreateProductGroup

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var productGroup = new AzureNative.ApiManagement.ProductGroup("productGroup", new()
    {
        GroupId = "templateGroup",
        ProductId = "testproduct",
        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.NewProductGroup(ctx, "productGroup", &apimanagement.ProductGroupArgs{
			GroupId:           pulumi.String("templateGroup"),
			ProductId:         pulumi.String("testproduct"),
			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.ProductGroup;
import com.pulumi.azurenative.apimanagement.ProductGroupArgs;
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 productGroup = new ProductGroup("productGroup", ProductGroupArgs.builder()
            .groupId("templateGroup")
            .productId("testproduct")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

product_group = azure_native.apimanagement.ProductGroup("productGroup",
    group_id="templateGroup",
    product_id="testproduct",
    resource_group_name="rg1",
    service_name="apimService1")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const productGroup = new azure_native.apimanagement.ProductGroup("productGroup", {
    groupId: "templateGroup",
    productId: "testproduct",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});

    resources:
  productGroup:
    type: azure-native:apimanagement:ProductGroup
    properties:
      groupId: templateGroup
      productId: testproduct
      resourceGroupName: rg1
      serviceName: apimService1

    Create ProductGroup Resource

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

    Constructor syntax

    new ProductGroup(name: string, args: ProductGroupArgs, opts?: CustomResourceOptions);
    @overload
def ProductGroup(resource_name: str,
                 args: ProductGroupArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ProductGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 product_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 service_name: Optional[str] = None,
                 group_id: Optional[str] = None)
    func NewProductGroup(ctx *Context, name string, args ProductGroupArgs, opts ...ResourceOption) (*ProductGroup, error)
    public ProductGroup(string name, ProductGroupArgs args, CustomResourceOptions? opts = null)
    public ProductGroup(String name, ProductGroupArgs args)
public ProductGroup(String name, ProductGroupArgs args, CustomResourceOptions options)

    type: azure-native:apimanagement:ProductGroup
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 ProductGroupArgs
    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 ProductGroupArgs
    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 ProductGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProductGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProductGroupArgs
    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 productGroupResource = new AzureNative.ApiManagement.ProductGroup("productGroupResource", new()
{
    ProductId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    GroupId = "string",
});

    example, err := apimanagement.NewProductGroup(ctx, "productGroupResource", &apimanagement.ProductGroupArgs{
	ProductId:         pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	GroupId:           pulumi.String("string"),
})

    var productGroupResource = new ProductGroup("productGroupResource", ProductGroupArgs.builder()
    .productId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .groupId("string")
    .build());

    product_group_resource = azure_native.apimanagement.ProductGroup("productGroupResource",
    product_id="string",
    resource_group_name="string",
    service_name="string",
    group_id="string")

    const productGroupResource = new azure_native.apimanagement.ProductGroup("productGroupResource", {
    productId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    groupId: "string",
});

    type: azure-native:apimanagement:ProductGroup
properties:
    groupId: string
    productId: string
    resourceGroupName: string
    serviceName: string

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

    ProductId string
    Product identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    GroupId string
    Group identifier. Must be unique in the current API Management service instance.
    ProductId string
    Product identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    GroupId string
    Group identifier. Must be unique in the current API Management service instance.
    productId String
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    groupId String
    Group identifier. Must be unique in the current API Management service instance.
    productId string
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    groupId string
    Group identifier. Must be unique in the current API Management service instance.
    product_id str
    Product identifier. Must be unique in the current API Management service instance.
    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.
    group_id str
    Group identifier. Must be unique in the current API Management service instance.
    productId String
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    groupId String
    Group identifier. Must be unique in the current API Management service instance.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProductGroup 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.
    DisplayName string
    Group name.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Description string
    Group description. Can contain HTML formatting tags.
    ExternalId string
    For 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.
    BuiltIn bool
    true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
    DisplayName string
    Group name.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Description string
    Group description. Can contain HTML formatting tags.
    ExternalId string
    For 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.
    builtIn Boolean
    true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
    displayName String
    Group name.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description String
    Group description. Can contain HTML formatting tags.
    externalId String
    For 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.
    builtIn boolean
    true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
    displayName string
    Group name.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description string
    Group description. Can contain HTML formatting tags.
    externalId string
    For 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.
    built_in bool
    true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
    display_name str
    Group name.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description str
    Group description. Can contain HTML formatting tags.
    external_id str
    For 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.
    builtIn Boolean
    true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
    displayName String
    Group name.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description String
    Group description. Can contain HTML formatting tags.
    externalId String
    For 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.

    Import

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

    $ pulumi import azure-native:apimanagement:ProductGroup templateGroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native