Share via


ApiKey Class

Definition

An API key used for authenticating with a configuration store endpoint.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.ApiKeyTypeConverter))]
public class ApiKey : Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IApiKey
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.ApiKeyTypeConverter))>]
type ApiKey = class
    interface IApiKey
    interface IJsonSerializable
Public Class ApiKey
Implements IApiKey
Inheritance
ApiKey
Attributes
Implements

Constructors

ApiKey()

Creates an new ApiKey instance.

Properties

ConnectionString

A connection string that can be used by supporting clients for authentication.

Id

The key ID.

LastModified

The last time any of the key's properties were modified.

Name

A name for the key describing its usage.

ReadOnly

Whether this key can only be used for read operations.

ResourceGroupName

Gets the resource group name

Value

The value of the key that is used for authentication purposes.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ApiKey.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ApiKey.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IApiKey.

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of ApiKey into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to