Share via


Client Class

Definition

The Client resource.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ClientTypeConverter))]
public class Client : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IClient, Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ClientTypeConverter))>]
type Client = class
    interface IClient
    interface IJsonSerializable
    interface IResource
    interface IValidates
Public Class Client
Implements IClient, IValidates
Inheritance
Client
Attributes
Implements

Constructors

Client()

Creates an new Client instance.

Properties

Attribute

Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }

AuthenticationName

The name presented by the client for authentication. The default value is the name of the resource.

CertificateAuthenticationAllowedThumbprint

The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.

CertificateAuthenticationValidationScheme

The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.

CertificateSubjectCommonName

The common name field in the subject name. The allowed limit is 64 characters and it should be specified.

CertificateSubjectCountryCode

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

CertificateSubjectOrganization

The organization field in the subject name. If present, the allowed limit is 64 characters.

CertificateSubjectOrganizationUnit

The organization unit field in the subject name. If present, the allowed limit is 32 characters.

CertificateThumbprintPrimary

The primary thumbprint used for validation.

CertificateThumbprintSecondary

The secondary thumbprint used for validation.

Description

Description for the Client resource.

Id

Fully qualified identifier of the resource.

Name

Name of the resource.

ProvisioningState

Provisioning state of the Client resource.

ResourceGroupName

Gets the resource group name

State

Indicates if the client is enabled or not. Default value is Enabled.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

Type of the resource.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Client.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Client.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IClient.

FromJsonString(String)

Creates a new instance of Client, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Client into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to