Docs Home Pulumi IaC Pulumi ESC 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 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.eventgrid.getClient

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

    Get properties of a client. Azure REST API version: 2023-06-01-preview.

    Other available API versions: 2023-12-15-preview, 2024-06-01-preview.

    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>
    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]
    func LookupClient(ctx *Context, args *LookupClientArgs, opts ...InvokeOption) (*LookupClientResult, error)
func LookupClientOutput(ctx *Context, args *LookupClientOutputArgs, opts ...InvokeOption) LookupClientResultOutput

    > 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)
}
    public static CompletableFuture<GetClientResult> getClient(GetClientArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:eventgrid:getClient
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClientName string
    Name of the client.
    NamespaceName string
    Name of the namespace.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    ClientName string
    Name of the client.
    NamespaceName string
    Name of the namespace.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    clientName String
    Name of the client.
    namespaceName String
    Name of the namespace.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    clientName string
    Name of the client.
    namespaceName string
    Name of the namespace.
    resourceGroupName string
    The name of the resource group within the user's subscription.
    client_name str
    Name of the client.
    namespace_name str
    Name of the namespace.
    resource_group_name str
    The name of the resource group within the user's subscription.
    clientName String
    Name of the client.
    namespaceName String
    Name of the namespace.
    resourceGroupName String
    The name of the resource group within the user's subscription.

    getClient Result

    The following output properties are available:

    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 Client 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"] }
    Authentication Pulumi.AzureNative.EventGrid.Outputs.ClientAuthenticationResponse
    Authentication information for the client.
    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.
    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 Client 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"] }
    Authentication ClientAuthenticationResponse
    Authentication information for the client.
    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.
    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 Client 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"] }
    authentication ClientAuthenticationResponse
    Authentication information for the client.
    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.
    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 Client 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"] }
    authentication ClientAuthenticationResponse
    Authentication information for the client.
    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.
    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 Client 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 ClientAuthenticationResponse
    Authentication information for the client.
    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.
    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 Client 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"] }
    authentication Property Map
    Authentication information for the client.
    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

    ClientAuthenticationResponse

    CertificateSubject ClientCertificateSubjectDistinguishedNameResponse
    The CA certificate subject name used for authentication.
    CertificateThumbprint ClientCertificateThumbprintResponse
    The self signed certificate's thumbprints data used for authentication.
    certificateSubject ClientCertificateSubjectDistinguishedNameResponse
    The CA certificate subject name used for authentication.
    certificateThumbprint ClientCertificateThumbprintResponse
    The self signed certificate's thumbprints data used for authentication.
    certificateSubject ClientCertificateSubjectDistinguishedNameResponse
    The CA certificate subject name used for authentication.
    certificateThumbprint ClientCertificateThumbprintResponse
    The self signed certificate's thumbprints data used for authentication.
    certificate_subject ClientCertificateSubjectDistinguishedNameResponse
    The CA certificate subject name used for authentication.
    certificate_thumbprint ClientCertificateThumbprintResponse
    The self signed certificate's thumbprints data used for authentication.
    certificateSubject Property Map
    The CA certificate subject name used for authentication.
    certificateThumbprint Property Map
    The self signed certificate's thumbprints data used for authentication.

    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.

    ClientCertificateSubjectDistinguishedNameResponse

    CommonName string
    The common name field in the subject name. The allowed limit is 64 characters and it should be specified.
    CountryCode string
    The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'.
    Organization string
    The organization field in the subject name. If present, the allowed limit is 64 characters.
    OrganizationUnit string
    The organization unit field in the subject name. If present, the allowed limit is 32 characters.
    CommonName string
    The common name field in the subject name. The allowed limit is 64 characters and it should be specified.
    CountryCode string
    The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'.
    Organization string
    The organization field in the subject name. If present, the allowed limit is 64 characters.
    OrganizationUnit string
    The organization unit field in the subject name. If present, the allowed limit is 32 characters.
    commonName String
    The common name field in the subject name. The allowed limit is 64 characters and it should be specified.
    countryCode String
    The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'.
    organization String
    The organization field in the subject name. If present, the allowed limit is 64 characters.
    organizationUnit String
    The organization unit field in the subject name. If present, the allowed limit is 32 characters.
    commonName string
    The common name field in the subject name. The allowed limit is 64 characters and it should be specified.
    countryCode string
    The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'.
    organization string
    The organization field in the subject name. If present, the allowed limit is 64 characters.
    organizationUnit string
    The organization unit field in the subject name. If present, the allowed limit is 32 characters.
    common_name str
    The common name field in the subject name. The allowed limit is 64 characters and it should be specified.
    country_code str
    The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'.
    organization str
    The organization field in the subject name. If present, the allowed limit is 64 characters.
    organization_unit str
    The organization unit field in the subject name. If present, the allowed limit is 32 characters.
    commonName String
    The common name field in the subject name. The allowed limit is 64 characters and it should be specified.
    countryCode String
    The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'.
    organization String
    The organization field in the subject name. If present, the allowed limit is 64 characters.
    organizationUnit String
    The organization unit field in the subject name. If present, the allowed limit is 32 characters.

    ClientCertificateThumbprintResponse

    Primary string
    The primary thumbprint used for validation.
    Secondary string
    The secondary thumbprint used for validation.
    Primary string
    The primary thumbprint used for validation.
    Secondary string
    The secondary thumbprint used for validation.
    primary String
    The primary thumbprint used for validation.
    secondary String
    The secondary thumbprint used for validation.
    primary string
    The primary thumbprint used for validation.
    secondary string
    The secondary thumbprint used for validation.
    primary str
    The primary thumbprint used for validation.
    secondary str
    The secondary thumbprint used for validation.
    primary String
    The primary thumbprint used for validation.
    secondary String
    The secondary thumbprint used for validation.

    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
    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