Share via


ClientProperties Class

Definition

The properties of client.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ClientPropertiesTypeConverter))]
public class ClientProperties : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IClientProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ClientPropertiesTypeConverter))>]
type ClientProperties = class
    interface IClientProperties
    interface IJsonSerializable
Public Class ClientProperties
Implements IClientProperties
Inheritance
ClientProperties
Attributes
Implements

Constructors

ClientProperties()

Creates an new ClientProperties 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.

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.

ClientCertificateAuthenticationAllowedThumbprint

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

ClientCertificateAuthenticationValidationScheme

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

Description

Description for the Client resource.

ProvisioningState

Provisioning state of the Client resource.

State

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ClientProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ClientProperties.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of ClientProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to