-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.core.credential.AzureNamedKeyCredential.yml
71 lines (71 loc) · 6.5 KB
/
com.azure.core.credential.AzureNamedKeyCredential.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
### YamlMime:JavaType
uid: "com.azure.core.credential.AzureNamedKeyCredential"
fullName: "com.azure.core.credential.AzureNamedKeyCredential"
name: "AzureNamedKeyCredential"
nameWithType: "AzureNamedKeyCredential"
summary: "The <xref uid=\"com.azure.core.credential.AzureNamedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKeyCredential\"></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\" />"
inheritedClassMethods:
- 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 **AzureNamedKeyCredential**"
constructors:
- uid: "com.azure.core.credential.AzureNamedKeyCredential.AzureNamedKeyCredential(java.lang.String,java.lang.String)"
fullName: "com.azure.core.credential.AzureNamedKeyCredential.AzureNamedKeyCredential(String name, String key)"
name: "AzureNamedKeyCredential(String name, String key)"
nameWithType: "AzureNamedKeyCredential.AzureNamedKeyCredential(String name, String key)"
summary: "Creates a credential with specified `name` that authorizes request with the given `key`."
parameters:
- description: "The name of the key credential."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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 AzureNamedKeyCredential(String name, String key)"
desc: "Creates a credential with specified `name` that authorizes request with the given `key`."
methods:
- uid: "com.azure.core.credential.AzureNamedKeyCredential.getAzureNamedKey()"
fullName: "com.azure.core.credential.AzureNamedKeyCredential.getAzureNamedKey()"
name: "getAzureNamedKey()"
nameWithType: "AzureNamedKeyCredential.getAzureNamedKey()"
summary: "Retrieves the <xref uid=\"com.azure.core.credential.AzureNamedKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKey\"></xref> containing the name and key associated with this credential."
syntax: "public AzureNamedKey getAzureNamedKey()"
desc: "Retrieves the <xref uid=\"com.azure.core.credential.AzureNamedKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKey\"></xref> containing the name and key associated with this credential."
returns:
description: "The <xref uid=\"com.azure.core.credential.AzureNamedKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKey\"></xref> containing the name and key ."
type: "<xref href=\"com.azure.core.credential.AzureNamedKey?alt=com.azure.core.credential.AzureNamedKey&text=AzureNamedKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.credential.AzureNamedKeyCredential.update(java.lang.String,java.lang.String)"
fullName: "com.azure.core.credential.AzureNamedKeyCredential.update(String name, String key)"
name: "update(String name, String key)"
nameWithType: "AzureNamedKeyCredential.update(String name, String key)"
summary: "Rotates the `name` and `key` associated to this credential."
parameters:
- description: "The new name of the key credential."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The new key to be 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 AzureNamedKeyCredential update(String name, String key)"
desc: "Rotates the `name` and `key` associated to this credential."
returns:
description: "The updated <code>AzureNamedKeyCredential</code> object."
type: "<xref href=\"com.azure.core.credential.AzureNamedKeyCredential?alt=com.azure.core.credential.AzureNamedKeyCredential&text=AzureNamedKeyCredential\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The <xref uid=\"com.azure.core.credential.AzureNamedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureNamedKeyCredential\"></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 with a name identifier associated with it.\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 Tables and Azure Event Hubs. Each service may have its own specific way of using API keys, but the general concept remains the same.\n\nThe <xref uid=\"com.azure.core.credential.AzureNamedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.credential.AzureNamedKeyCredential\"></xref> can be created for keys which have a name identifier associated with them.\n\n**Code Samples**\n\nCreate a named credential for a service specific sas key.\n\n```java\nAzureNamedKeyCredential azureNamedKeyCredential =\n new AzureNamedKeyCredential(\"AZURE-SERVICE-SAS-KEY-NAME\", \"AZURE-SERVICE-SAS-KEY\");\n```"
metadata: {}
package: "com.azure.core.credential"
artifact: com.azure:azure-core:1.49.1