Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. ClientGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.eventgrid.ClientGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

The Client group resource.

Uses Azure REST API version 2025-02-15. In version 2.x of the Azure Native provider, it used API version 2023-06-01-preview.

Other available API versions: 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview, 2024-12-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native eventgrid [ApiVersion]. See the version guide for details.

Example Usage

ClientGroups_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var clientGroup = new AzureNative.EventGrid.ClientGroup("clientGroup", new()
    {
        ClientGroupName = "exampleClientGroupName1",
        Description = "This is a test client group",
        NamespaceName = "exampleNamespaceName1",
        Query = "attributes.b IN ['a', 'b', 'c']",
        ResourceGroupName = "examplerg",
    });

});
Copy
package main

import (
	eventgrid "github.com/pulumi/pulumi-azure-native-sdk/eventgrid/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eventgrid.NewClientGroup(ctx, "clientGroup", &eventgrid.ClientGroupArgs{
			ClientGroupName:   pulumi.String("exampleClientGroupName1"),
			Description:       pulumi.String("This is a test client group"),
			NamespaceName:     pulumi.String("exampleNamespaceName1"),
			Query:             pulumi.String("attributes.b IN ['a', 'b', 'c']"),
			ResourceGroupName: pulumi.String("examplerg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.eventgrid.ClientGroup;
import com.pulumi.azurenative.eventgrid.ClientGroupArgs;
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 clientGroup = new ClientGroup("clientGroup", ClientGroupArgs.builder()
            .clientGroupName("exampleClientGroupName1")
            .description("This is a test client group")
            .namespaceName("exampleNamespaceName1")
            .query("attributes.b IN ['a', 'b', 'c']")
            .resourceGroupName("examplerg")
            .build());

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

const clientGroup = new azure_native.eventgrid.ClientGroup("clientGroup", {
    clientGroupName: "exampleClientGroupName1",
    description: "This is a test client group",
    namespaceName: "exampleNamespaceName1",
    query: "attributes.b IN ['a', 'b', 'c']",
    resourceGroupName: "examplerg",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

client_group = azure_native.eventgrid.ClientGroup("clientGroup",
    client_group_name="exampleClientGroupName1",
    description="This is a test client group",
    namespace_name="exampleNamespaceName1",
    query="attributes.b IN ['a', 'b', 'c']",
    resource_group_name="examplerg")
Copy
resources:
  clientGroup:
    type: azure-native:eventgrid:ClientGroup
    properties:
      clientGroupName: exampleClientGroupName1
      description: This is a test client group
      namespaceName: exampleNamespaceName1
      query: attributes.b IN ['a', 'b', 'c']
      resourceGroupName: examplerg
Copy

Create ClientGroup Resource

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

Constructor syntax

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

@overload
def ClientGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                namespace_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                client_group_name: Optional[str] = None,
                description: Optional[str] = None,
                query: Optional[str] = None)
func NewClientGroup(ctx *Context, name string, args ClientGroupArgs, opts ...ResourceOption) (*ClientGroup, error)
public ClientGroup(string name, ClientGroupArgs args, CustomResourceOptions? opts = null)
public ClientGroup(String name, ClientGroupArgs args)
public ClientGroup(String name, ClientGroupArgs args, CustomResourceOptions options)

type: azure-native:eventgrid:ClientGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClientGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ClientGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ClientGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClientGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClientGroupArgs
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 clientGroupResource = new AzureNative.EventGrid.ClientGroup("clientGroupResource", new()
{
    NamespaceName = "string",
    ResourceGroupName = "string",
    ClientGroupName = "string",
    Description = "string",
    Query = "string",
});
Copy
example, err := eventgrid.NewClientGroup(ctx, "clientGroupResource", &eventgrid.ClientGroupArgs{
	NamespaceName:     pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ClientGroupName:   pulumi.String("string"),
	Description:       pulumi.String("string"),
	Query:             pulumi.String("string"),
})
Copy
var clientGroupResource = new ClientGroup("clientGroupResource", ClientGroupArgs.builder()
    .namespaceName("string")
    .resourceGroupName("string")
    .clientGroupName("string")
    .description("string")
    .query("string")
    .build());
Copy
client_group_resource = azure_native.eventgrid.ClientGroup("clientGroupResource",
    namespace_name="string",
    resource_group_name="string",
    client_group_name="string",
    description="string",
    query="string")
Copy
const clientGroupResource = new azure_native.eventgrid.ClientGroup("clientGroupResource", {
    namespaceName: "string",
    resourceGroupName: "string",
    clientGroupName: "string",
    description: "string",
    query: "string",
});
Copy
type: azure-native:eventgrid:ClientGroup
properties:
    clientGroupName: string
    description: string
    namespaceName: string
    query: string
    resourceGroupName: string
Copy

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

NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the namespace.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription.
ClientGroupName Changes to this property will trigger replacement. string
The client group name.
Description string
Description for the Client Group resource.
Query string
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the namespace.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription.
ClientGroupName Changes to this property will trigger replacement. string
The client group name.
Description string
Description for the Client Group resource.
Query string
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the namespace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription.
clientGroupName Changes to this property will trigger replacement. String
The client group name.
description String
Description for the Client Group resource.
query String
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the namespace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription.
clientGroupName Changes to this property will trigger replacement. string
The client group name.
description string
Description for the Client Group resource.
query string
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the namespace.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription.
client_group_name Changes to this property will trigger replacement. str
The client group name.
description str
Description for the Client Group resource.
query str
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the namespace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription.
clientGroupName Changes to this property will trigger replacement. String
The client group name.
description String
Description for the Client Group resource.
query String
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].

Outputs

All input properties are implicitly available as output properties. Additionally, the ClientGroup resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the resource.
ProvisioningState string
Provisioning state of the ClientGroup resource.
SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse
The system metadata relating to the Event Grid resource.
Type string
Type of the resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the resource.
ProvisioningState string
Provisioning state of the ClientGroup resource.
SystemData SystemDataResponse
The system metadata relating to the Event Grid resource.
Type string
Type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the resource.
provisioningState String
Provisioning state of the ClientGroup resource.
systemData SystemDataResponse
The system metadata relating to the Event Grid resource.
type String
Type of the resource.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Name of the resource.
provisioningState string
Provisioning state of the ClientGroup resource.
systemData SystemDataResponse
The system metadata relating to the Event Grid resource.
type string
Type of the resource.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
Name of the resource.
provisioning_state str
Provisioning state of the ClientGroup resource.
system_data SystemDataResponse
The system metadata relating to the Event Grid resource.
type str
Type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the resource.
provisioningState String
Provisioning state of the ClientGroup resource.
systemData Property Map
The system metadata relating to the Event Grid resource.
type String
Type of the resource.

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

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

$ pulumi import azure-native:eventgrid:ClientGroup exampleClientGroupName1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native