Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. getClient
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.getClient

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

Get properties of a client.

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 getClient

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 getClient(args: GetClientArgs, opts?: InvokeOptions): Promise<GetClientResult>
function getClientOutput(args: GetClientOutputArgs, opts?: InvokeOptions): Output<GetClientResult>
Copy
def get_client(client_name: Optional[str] = None,
               namespace_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetClientResult
def get_client_output(client_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[GetClientResult]
Copy
func LookupClient(ctx *Context, args *LookupClientArgs, opts ...InvokeOption) (*LookupClientResult, error)
func LookupClientOutput(ctx *Context, args *LookupClientOutputArgs, opts ...InvokeOption) LookupClientResultOutput
Copy

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

public static class GetClient 
{
    public static Task<GetClientResult> InvokeAsync(GetClientArgs args, InvokeOptions? opts = null)
    public static Output<GetClientResult> Invoke(GetClientInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClientResult> getClient(GetClientArgs args, InvokeOptions options)
public static Output<GetClientResult> getClient(GetClientArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:eventgrid:getClient
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClientName
This property is required.
Changes to this property will trigger replacement.
string
Name of the client.
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.
ClientName
This property is required.
Changes to this property will trigger replacement.
string
Name of the client.
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.
clientName
This property is required.
Changes to this property will trigger replacement.
String
Name of the client.
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.
clientName
This property is required.
Changes to this property will trigger replacement.
string
Name of the client.
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_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the client.
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.
clientName
This property is required.
Changes to this property will trigger replacement.
String
Name of the client.
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.

getClient 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 Client resource.
SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse
The system metadata relating to the Event Grid resource.
Type string
Type of the resource.
Attributes object
Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
AuthenticationName string
The name presented by the client for authentication. The default value is the name of the resource.
ClientCertificateAuthentication Pulumi.AzureNative.EventGrid.Outputs.ClientCertificateAuthenticationResponse
The client certificate authentication information.
Description string
Description for the Client resource.
State string
Indicates if the client is enabled or not. Default value is Enabled.
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 Client resource.
SystemData SystemDataResponse
The system metadata relating to the Event Grid resource.
Type string
Type of the resource.
Attributes interface{}
Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
AuthenticationName string
The name presented by the client for authentication. The default value is the name of the resource.
ClientCertificateAuthentication ClientCertificateAuthenticationResponse
The client certificate authentication information.
Description string
Description for the Client resource.
State string
Indicates if the client is enabled or not. Default value is Enabled.
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 Client resource.
systemData SystemDataResponse
The system metadata relating to the Event Grid resource.
type String
Type of the resource.
attributes Object
Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
authenticationName String
The name presented by the client for authentication. The default value is the name of the resource.
clientCertificateAuthentication ClientCertificateAuthenticationResponse
The client certificate authentication information.
description String
Description for the Client resource.
state String
Indicates if the client is enabled or not. Default value is Enabled.
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 Client resource.
systemData SystemDataResponse
The system metadata relating to the Event Grid resource.
type string
Type of the resource.
attributes any
Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
authenticationName string
The name presented by the client for authentication. The default value is the name of the resource.
clientCertificateAuthentication ClientCertificateAuthenticationResponse
The client certificate authentication information.
description string
Description for the Client resource.
state string
Indicates if the client is enabled or not. Default value is Enabled.
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 Client resource.
system_data SystemDataResponse
The system metadata relating to the Event Grid resource.
type str
Type of the resource.
attributes Any
Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
authentication_name str
The name presented by the client for authentication. The default value is the name of the resource.
client_certificate_authentication ClientCertificateAuthenticationResponse
The client certificate authentication information.
description str
Description for the Client resource.
state str
Indicates if the client is enabled or not. Default value is Enabled.
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 Client resource.
systemData Property Map
The system metadata relating to the Event Grid resource.
type String
Type of the resource.
attributes Any
Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
authenticationName String
The name presented by the client for authentication. The default value is the name of the resource.
clientCertificateAuthentication Property Map
The client certificate authentication information.
description String
Description for the Client resource.
state String
Indicates if the client is enabled or not. Default value is Enabled.

Supporting Types

ClientCertificateAuthenticationResponse

AllowedThumbprints List<string>
The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
ValidationScheme string
The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
AllowedThumbprints []string
The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
ValidationScheme string
The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
allowedThumbprints List<String>
The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
validationScheme String
The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
allowedThumbprints string[]
The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
validationScheme string
The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
allowed_thumbprints Sequence[str]
The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
validation_scheme str
The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
allowedThumbprints List<String>
The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
validationScheme String
The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native