Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

ProductGroup

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

Example Usage

ApiManagementCreateProductGroup

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var productGroup = new AzureNative.ApiManagement.ProductGroup("productGroup", new AzureNative.ApiManagement.ProductGroupArgs
        {
            GroupId = "templateGroup",
            ProductId = "testproduct",
            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.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 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 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 a ProductGroup Resource

new ProductGroup(name: string, args: ProductGroupArgs, opts?: CustomResourceOptions);
@overload
def ProductGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 group_id: Optional[str] = None,
                 product_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 service_name: Optional[str] = None)
@overload
def ProductGroup(resource_name: str,
                 args: ProductGroupArgs,
                 opts: Optional[ResourceOptions] = 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.

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.

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

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.

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.

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.

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.

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.

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.

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

Resource name.

Type string

Resource type for API Management resource.

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

Resource name.

Type string

Resource type for API Management resource.

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

Resource name.

type String

Resource type for API Management resource.

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

Resource name.

type string

Resource type for API Management resource.

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

Resource name.

type str

Resource type for API Management resource.

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

Resource name.

type String

Resource type for API Management resource.

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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup 

Package Details

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