Class MetricsAdvisorKeyCredential

Package version

Credential used to authenticate and authorize with Metrics Advisor service

Hierarchy

MetricsAdvisorKeyCredential

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new MetricsAdvisorKeyCredential(subscriptionKey: string, apiKey: string): MetricsAdvisorKeyCredential

- Defined in mnt/vss/_work/1/s/sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorKeyCredentialPolicy.ts:29
Creates an instance of MetricsAdvisorKeyCredential

Parameters
- subscriptionKey: string
  
  Subscription access key from the Azure portal
- apiKey: string
  
  API key from the Metrics Advisor web portal
Returns MetricsAdvisorKeyCredential

Accessors

apiKey

get apiKey(): string

- Defined in mnt/vss/_work/1/s/sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorKeyCredentialPolicy.ts:48
Get Api Key

Returns string

subscriptionKey

get subscriptionKey(): string

- Defined in mnt/vss/_work/1/s/sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorKeyCredentialPolicy.ts:55
Get Subscription key

Returns string

Methods

updateApiKey

updateApiKey(apiKey: string): void

- Defined in mnt/vss/_work/1/s/sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorKeyCredentialPolicy.ts:82
Change the value of the api key.

Updates will take effect upon the next request after updating the key value.

Parameters
- apiKey: string
  
  The new api key value to be used
Returns void

updateSubscriptionKey

updateSubscriptionKey(subscriptionKey: string): void

- Defined in mnt/vss/_work/1/s/sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorKeyCredentialPolicy.ts:67
Change the value of the subscription key.

Updates will take effect upon the next request after updating the key value.

Parameters
- subscriptionKey: string
  
  The new subscription key value to be used
Returns void

Generated using TypeDoc