ApiKeyCredential Class

Definition

Namespace:

System.ClientModel

Assembly:

System.ClientModel.dll

Package:

System.ClientModel v1.2.1

Source:

ApiKeyCredential.cs

A credential used to authenticate to a service that accepts an API key. This type provides the ability to update the key's value without creating a new client.

public class ApiKeyCredential

type ApiKeyCredential = class

Public Class ApiKeyCredential

Inheritance

Object

ApiKeyCredential

Derived

Azure.AzureKeyCredential

Constructors

ApiKeyCredential(String)

Initializes a new instance of the ApiKeyCredential class.

Methods

Deconstruct(String)	Deconstructs the credential into component values.
Update(String)	Updates the API key to used to authenticate with the service. This method is intended to be called when the API key has been regenerated and long-lived clients need to be updated to send the new value.