62 строки
5.5 KiB
YAML
62 строки
5.5 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.credential.AzureKeyCredential"
|
|
fullName: "com.azure.core.credential.AzureKeyCredential"
|
|
name: "AzureKeyCredential"
|
|
nameWithType: "AzureKeyCredential"
|
|
summary: "The <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> is used to authenticate and authorize requests made to Azure services."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.credential.KeyCredential?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.core.credential.KeyCredential?alt=com.azure.core.credential.KeyCredential&text=KeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.core.credential.KeyCredential.getKey()?alt=com.azure.core.credential.KeyCredential.getKey&text=getKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.credential.KeyCredential.update(java.lang.String)?alt=com.azure.core.credential.KeyCredential.update&text=update\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **AzureKeyCredential**</br> extends <xref href=\"com.azure.core.credential.KeyCredential?alt=com.azure.core.credential.KeyCredential&text=KeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.core.credential.AzureKeyCredential.AzureKeyCredential(java.lang.String)"
|
|
fullName: "com.azure.core.credential.AzureKeyCredential.AzureKeyCredential(String key)"
|
|
name: "AzureKeyCredential(String key)"
|
|
nameWithType: "AzureKeyCredential.AzureKeyCredential(String key)"
|
|
summary: "Creates a credential that authorizes request with the given key."
|
|
parameters:
|
|
- description: "The key used to authorize requests."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureKeyCredential(String key)"
|
|
desc: "Creates a credential that authorizes request with the given key."
|
|
methods:
|
|
- uid: "com.azure.core.credential.AzureKeyCredential.update(java.lang.String)"
|
|
fullName: "com.azure.core.credential.AzureKeyCredential.update(String key)"
|
|
name: "update(String key)"
|
|
nameWithType: "AzureKeyCredential.update(String key)"
|
|
summary: "Rotates the key associated to this credential."
|
|
overridden: "com.azure.core.credential.KeyCredential.update(java.lang.String)"
|
|
parameters:
|
|
- description: "The new key to associated with this credential."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureKeyCredential update(String key)"
|
|
desc: "Rotates the key associated to this credential."
|
|
returns:
|
|
description: "The updated <code>AzureKeyCredential</code> object."
|
|
type: "<xref href=\"com.azure.core.credential.AzureKeyCredential?alt=com.azure.core.credential.AzureKeyCredential&text=AzureKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> is used to authenticate and authorize requests made to Azure services. It is specifically designed for scenarios where you need to authenticate using a key.\n\nA key is a unique identifier or token that is associated with a specific user or application. It serves as a simple form of authentication to ensure that only authorized clients can access the protected resources or APIs. This authentication is commonly used for accessing certain services, such as Azure Cognitive Services, Azure Search, or Azure Management APIs. Each service may have its own specific way of using API keys, but the general concept remains the same. The <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.credential.AzureKeyCredential\"></xref> allows you to authenticate using a key.\n\n**Code Samples**\n\nCreate a key credential for a service key.\n\n```java\nAzureKeyCredential azureKeyCredential = new AzureKeyCredential(\"AZURE-SERVICE-KEY\");\n```"
|
|
metadata: {}
|
|
package: "com.azure.core.credential"
|
|
artifact: com.azure:azure-core:1.54.0
|