Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. getClientGroup
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.eventgrid.getClientGroup

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Get properties of a client group.

Uses Azure REST API version 2025-02-15.

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.

Using getClientGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getClientGroup(args: GetClientGroupArgs, opts?: InvokeOptions): Promise<GetClientGroupResult>
function getClientGroupOutput(args: GetClientGroupOutputArgs, opts?: InvokeOptions): Output<GetClientGroupResult>
Copy
def get_client_group(client_group_name: Optional[str] = None,
                     namespace_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetClientGroupResult
def get_client_group_output(client_group_name: Optional[pulumi.Input[str]] = None,
                     namespace_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetClientGroupResult]
Copy
func LookupClientGroup(ctx *Context, args *LookupClientGroupArgs, opts ...InvokeOption) (*LookupClientGroupResult, error)
func LookupClientGroupOutput(ctx *Context, args *LookupClientGroupOutputArgs, opts ...InvokeOption) LookupClientGroupResultOutput
Copy

> Note: This function is named LookupClientGroup in the Go SDK.

public static class GetClientGroup 
{
    public static Task<GetClientGroupResult> InvokeAsync(GetClientGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetClientGroupResult> Invoke(GetClientGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClientGroupResult> getClientGroup(GetClientGroupArgs args, InvokeOptions options)
public static Output<GetClientGroupResult> getClientGroup(GetClientGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:eventgrid:getClientGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClientGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the client group.
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
This property is required.
Changes to this property will trigger replacement.
string
Name of the client group.
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
This property is required.
Changes to this property will trigger replacement.
String
Name of the client group.
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
This property is required.
Changes to this property will trigger replacement.
string
Name of the client group.
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.
client_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the client group.
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.
clientGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the client group.
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.

getClientGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified identifier of the 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.
Description string
Description for the Client Group resource.
Query string
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified identifier of the 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.
Description string
Description for the Client Group resource.
Query string
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified identifier of the 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.
description String
Description for the Client Group resource.
query String
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified identifier of the 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.
description string
Description for the Client Group resource.
query string
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified identifier of the 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.
description str
Description for the Client Group resource.
query str
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified identifier of the 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.
description String
Description for the Client Group resource.
query String
The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c'].

Supporting Types

SystemDataResponse

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.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native