/
com.azure.identity.AzureCliCredentialBuilder.yml
119 lines (119 loc) · 13.9 KB
/
com.azure.identity.AzureCliCredentialBuilder.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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
### YamlMime:JavaType
uid: "com.azure.identity.AzureCliCredentialBuilder"
fullName: "com.azure.identity.AzureCliCredentialBuilder"
name: "AzureCliCredentialBuilder"
nameWithType: "AzureCliCredentialBuilder"
summary: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureCliCredential\"></xref>."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.identity.CredentialBuilderBase?alt=com.azure.identity.CredentialBuilderBase&text=CredentialBuilderBase\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.identity.CredentialBuilderBase.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)?alt=com.azure.identity.CredentialBuilderBase.addPolicy&text=addPolicy\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.clientOptions(com.azure.core.util.ClientOptions)?alt=com.azure.identity.CredentialBuilderBase.clientOptions&text=clientOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.configuration(com.azure.core.util.Configuration)?alt=com.azure.identity.CredentialBuilderBase.configuration&text=configuration\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.enableAccountIdentifierLogging()?alt=com.azure.identity.CredentialBuilderBase.enableAccountIdentifierLogging&text=enableAccountIdentifierLogging\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpClient(com.azure.core.http.HttpClient)?alt=com.azure.identity.CredentialBuilderBase.httpClient&text=httpClient\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)?alt=com.azure.identity.CredentialBuilderBase.httpLogOptions&text=httpLogOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpPipeline(com.azure.core.http.HttpPipeline)?alt=com.azure.identity.CredentialBuilderBase.httpPipeline&text=httpPipeline\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.maxRetry(int)?alt=com.azure.identity.CredentialBuilderBase.maxRetry&text=maxRetry\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.pipeline(com.azure.core.http.HttpPipeline)?alt=com.azure.identity.CredentialBuilderBase.pipeline&text=pipeline\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.proxyOptions(com.azure.core.http.ProxyOptions)?alt=com.azure.identity.CredentialBuilderBase.proxyOptions&text=proxyOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryOptions(com.azure.core.http.policy.RetryOptions)?alt=com.azure.identity.CredentialBuilderBase.retryOptions&text=retryOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryPolicy(com.azure.core.http.policy.RetryPolicy)?alt=com.azure.identity.CredentialBuilderBase.retryPolicy&text=retryPolicy\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryTimeout(java.util.function.Function<java.time.Duration,java.time.Duration>)?alt=com.azure.identity.CredentialBuilderBase.retryTimeout&text=retryTimeout\" 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 class **AzureCliCredentialBuilder**</br> extends <xref href=\"com.azure.identity.CredentialBuilderBase?alt=com.azure.identity.CredentialBuilderBase&text=CredentialBuilderBase\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.identity.AzureCliCredentialBuilder?alt=com.azure.identity.AzureCliCredentialBuilder&text=AzureCliCredentialBuilder\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.identity.AzureCliCredentialBuilder.AzureCliCredentialBuilder()"
fullName: "com.azure.identity.AzureCliCredentialBuilder.AzureCliCredentialBuilder()"
name: "AzureCliCredentialBuilder()"
nameWithType: "AzureCliCredentialBuilder.AzureCliCredentialBuilder()"
summary: "Constructs an instance of Azure<wbr>Cli<wbr>Credential<wbr>Builder."
syntax: "public AzureCliCredentialBuilder()"
desc: "Constructs an instance of AzureCliCredentialBuilder."
methods:
- uid: "com.azure.identity.AzureCliCredentialBuilder.additionallyAllowedTenants(java.lang.String...)"
fullName: "com.azure.identity.AzureCliCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)"
name: "additionallyAllowedTenants(String[] additionallyAllowedTenants)"
nameWithType: "AzureCliCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)"
summary: "Specifies tenants in addition to the specified tenant<wbr>Id for which the credential may acquire tokens."
parameters:
- description: "the additionally allowed tenants."
name: "additionallyAllowedTenants"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]"
syntax: "public AzureCliCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)"
desc: "Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens. Add the wildcard value \"\\*\" to allow the credential to acquire tokens for any tenant the logged in account can access. If no value is specified for tenantId this option will have no effect, and the credential will acquire tokens for any requested tenant."
returns:
description: "An updated instance of this builder with the additional tenants configured."
type: "<xref href=\"com.azure.identity.AzureCliCredentialBuilder?alt=com.azure.identity.AzureCliCredentialBuilder&text=AzureCliCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.AzureCliCredentialBuilder.additionallyAllowedTenants(java.util.List<java.lang.String>)"
fullName: "com.azure.identity.AzureCliCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
name: "additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
nameWithType: "AzureCliCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
summary: "Specifies tenants in addition to the specified tenant<wbr>Id for which the credential may acquire tokens."
parameters:
- description: "the additionally allowed tenants."
name: "additionallyAllowedTenants"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public AzureCliCredentialBuilder additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
desc: "Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens. Add the wildcard value \"\\*\" to allow the credential to acquire tokens for any tenant the logged in account can access. If no value is specified for tenantId this option will have no effect, and the credential will acquire tokens for any requested tenant."
returns:
description: "An updated instance of this builder with the additional tenants configured."
type: "<xref href=\"com.azure.identity.AzureCliCredentialBuilder?alt=com.azure.identity.AzureCliCredentialBuilder&text=AzureCliCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.AzureCliCredentialBuilder.build()"
fullName: "com.azure.identity.AzureCliCredentialBuilder.build()"
name: "build()"
nameWithType: "AzureCliCredentialBuilder.build()"
summary: "Creates a new <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureCliCredential\"></xref> with the current configurations."
syntax: "public AzureCliCredential build()"
desc: "Creates a new <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureCliCredential\"></xref> with the current configurations."
returns:
description: "a <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureCliCredential\"></xref> with the current configurations."
type: "<xref href=\"com.azure.identity.AzureCliCredential?alt=com.azure.identity.AzureCliCredential&text=AzureCliCredential\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.AzureCliCredentialBuilder.processTimeout(java.time.Duration)"
fullName: "com.azure.identity.AzureCliCredentialBuilder.processTimeout(Duration processTimeout)"
name: "processTimeout(Duration processTimeout)"
nameWithType: "AzureCliCredentialBuilder.processTimeout(Duration processTimeout)"
summary: "Specifies a <xref uid=\"java.time.Duration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Duration\"></xref> timeout for calling the Azure CLI."
parameters:
- description: "The <xref uid=\"java.time.Duration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Duration\"></xref> to wait."
name: "processTimeout"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public AzureCliCredentialBuilder processTimeout(Duration processTimeout)"
desc: "Specifies a <xref uid=\"java.time.Duration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Duration\"></xref> timeout for calling the Azure CLI. The timeout period is applied on the Azure CLI command execution process invoked by the credential"
returns:
description: "An updated instance of this builder with the timeout specified."
type: "<xref href=\"com.azure.identity.AzureCliCredentialBuilder?alt=com.azure.identity.AzureCliCredentialBuilder&text=AzureCliCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.AzureCliCredentialBuilder.tenantId(java.lang.String)"
fullName: "com.azure.identity.AzureCliCredentialBuilder.tenantId(String tenantId)"
name: "tenantId(String tenantId)"
nameWithType: "AzureCliCredentialBuilder.tenantId(String tenantId)"
summary: "Sets the tenant ID of the application."
parameters:
- description: "the tenant ID of the application."
name: "tenantId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AzureCliCredentialBuilder tenantId(String tenantId)"
desc: "Sets the tenant ID of the application."
returns:
description: "An updated instance of this builder with the tenant id set as specified."
type: "<xref href=\"com.azure.identity.AzureCliCredentialBuilder?alt=com.azure.identity.AzureCliCredentialBuilder&text=AzureCliCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureCliCredential\"></xref>.\n\nThe Azure CLI is a command-line tool that allows users to manage Azure resources from their local machine or terminal. It allows users to [authenticate interactively][] as a user and/or a service principal against [Microsoft Entra ID][]. The AzureCliCredential authenticates in a development environment and acquires a token on behalf of the logged-in user or service principal in Azure CLI. It acts as the Azure CLI logged in user or service principal and executes an Azure CLI command underneath to authenticate the application against Microsoft Entra ID.\n\n**Sample: Construct IntelliJCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzureCliCredential\"></xref>, using the <xref uid=\"com.azure.identity.AzureCliCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzureCliCredentialBuilder\"></xref> to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.\n\n```java\nTokenCredential azureCliCredential = new AzureCliCredentialBuilder()\n .build();\n```\n\n\n[authenticate interactively]: https://learn.microsoft.com/cli/azure/authenticate-azure-cli\n[Microsoft Entra ID]: https://learn.microsoft.com/entra/fundamentals/"
metadata: {}
package: "com.azure.identity"
artifact: com.azure:azure-identity:1.12.1