Package com.microsoft.azure.util
Class AzureCredentials
- java.lang.Object
-
- com.cloudbees.plugins.credentials.BaseCredentials
-
- com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
-
- com.microsoft.azure.util.AzureBaseCredentials
-
- com.microsoft.azure.util.AzureCredentials
-
- All Implemented Interfaces:
com.cloudbees.plugins.credentials.common.IdCredentials
,com.cloudbees.plugins.credentials.common.StandardCredentials
,com.cloudbees.plugins.credentials.Credentials
,ExtensionPoint
,Describable<com.cloudbees.plugins.credentials.Credentials>
,Serializable
public class AzureCredentials extends AzureBaseCredentials
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AzureCredentials.DescriptorImpl
static class
AzureCredentials.ServicePrincipal
static class
AzureCredentials.ValidationException
-
Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, Secret clientSecret)
AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, String clientSecret)
Deprecated.AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, String clientSecret, String oauth2TokenEndpoint, String serviceManagementURL, String authenticationEndpoint, String resourceManagerEndpoint, String graphEndpoint)
Deprecated.Leave for backward compatibility.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static com.azure.security.keyvault.secrets.SecretClient
createKeyVaultClient(com.azure.core.credential.TokenCredential credential, String keyVaultUrl)
String
getActiveDirectoryEndpoint()
String
getAuthenticationEndpoint()
Deprecated.String
getAzureEnvionmentName()
Deprecated.com.azure.core.management.AzureEnvironment
getAzureEnvironment()
String
getAzureEnvironmentName()
String
getCertificateId()
String
getClientId()
Secret
getClientSecret()
static com.azure.core.credential.TokenCredential
getCredentialById(Item owner, String credentialId)
String
getGraphEndpoint()
String
getManagementEndpoint()
String
getOauth2TokenEndpoint()
Deprecated.use tenant related methods instead.String
getPlainClientSecret()
String
getResourceManagerEndpoint()
String
getServiceManagementURL()
Deprecated.static AzureCredentials.ServicePrincipal
getServicePrincipal(String credentialsId)
Deprecated.String
getSubscriptionId()
static com.azure.core.credential.TokenCredential
getSystemCredentialById(String credentialID)
Only checks the system provider for credentials.String
getTenant()
static com.azure.core.credential.TokenCredential
getTokenCredential(AzureBaseCredentials credentials)
void
setActiveDirectoryEndpoint(String activeDirectoryEndpoint)
void
setAuthenticationEndpoint(String authenticationEndpoint)
Deprecated.void
setAzureEnvironmentName(String azureEnvironmentName)
void
setCertificateId(String certificateId)
void
setGraphEndpoint(String graphEndpoint)
void
setManagementEndpoint(String managementEndpoint)
void
setOauth2TokenEndpoint(String oauth2TokenEndpoint)
Deprecated.use tenant related methods instead.void
setResourceManagerEndpoint(String resourceManagerEndpoint)
void
setServiceManagementURL(String serviceManagementURL)
Deprecated.void
setTenant(String tenant)
-
Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
equals, getDescription, getId, hashCode
-
Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials
getDescriptor, getScope
-
-
-
-
Constructor Detail
-
AzureCredentials
@Deprecated public AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, String clientSecret)
Deprecated.
-
AzureCredentials
@DataBoundConstructor public AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, Secret clientSecret)
-
AzureCredentials
@Deprecated public AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, String clientSecret, String oauth2TokenEndpoint, String serviceManagementURL, String authenticationEndpoint, String resourceManagerEndpoint, String graphEndpoint)
Deprecated.Leave for backward compatibility.
-
-
Method Detail
-
getServicePrincipal
@Deprecated public static AzureCredentials.ServicePrincipal getServicePrincipal(String credentialsId)
Deprecated.
-
createKeyVaultClient
public static com.azure.security.keyvault.secrets.SecretClient createKeyVaultClient(com.azure.core.credential.TokenCredential credential, String keyVaultUrl)
-
getSystemCredentialById
public static com.azure.core.credential.TokenCredential getSystemCredentialById(String credentialID)
Only checks the system provider for credentials. Use if you need to bypass other providers, e.g. in a credential provider.
-
getTokenCredential
public static com.azure.core.credential.TokenCredential getTokenCredential(AzureBaseCredentials credentials)
-
getCredentialById
public static com.azure.core.credential.TokenCredential getCredentialById(Item owner, String credentialId)
-
getSubscriptionId
public String getSubscriptionId()
- Specified by:
getSubscriptionId
in classAzureBaseCredentials
-
getClientId
public String getClientId()
-
getClientSecret
public Secret getClientSecret()
-
getPlainClientSecret
public String getPlainClientSecret()
-
setCertificateId
@DataBoundSetter public void setCertificateId(String certificateId)
-
getCertificateId
public String getCertificateId()
-
getTenant
public String getTenant()
-
setTenant
@DataBoundSetter public void setTenant(String tenant)
-
getOauth2TokenEndpoint
@Deprecated public String getOauth2TokenEndpoint()
Deprecated.use tenant related methods instead.For backward compatibility.
-
setOauth2TokenEndpoint
@DataBoundSetter @Deprecated public void setOauth2TokenEndpoint(String oauth2TokenEndpoint)
Deprecated.use tenant related methods instead.Set the Oauth2 token endpoint for backward compatibility only.- Parameters:
oauth2TokenEndpoint
- the endpoint value in the form "https://login.windows.net/<TenantId>"
-
getAzureEnvionmentName
@Deprecated public String getAzureEnvionmentName()
Deprecated.typo.
-
getAzureEnvironmentName
public String getAzureEnvironmentName()
- Specified by:
getAzureEnvironmentName
in classAzureBaseCredentials
-
setAzureEnvironmentName
@DataBoundSetter public void setAzureEnvironmentName(String azureEnvironmentName)
-
getServiceManagementURL
@Deprecated public String getServiceManagementURL()
Deprecated.
-
getManagementEndpoint
public String getManagementEndpoint()
- Specified by:
getManagementEndpoint
in classAzureBaseCredentials
-
setServiceManagementURL
@DataBoundSetter @Deprecated public void setServiceManagementURL(String serviceManagementURL)
Deprecated.
-
setManagementEndpoint
@DataBoundSetter public void setManagementEndpoint(String managementEndpoint)
-
getAuthenticationEndpoint
@Deprecated public String getAuthenticationEndpoint()
Deprecated.
-
getActiveDirectoryEndpoint
public String getActiveDirectoryEndpoint()
- Specified by:
getActiveDirectoryEndpoint
in classAzureBaseCredentials
-
setAuthenticationEndpoint
@DataBoundSetter @Deprecated public void setAuthenticationEndpoint(String authenticationEndpoint)
Deprecated.
-
setActiveDirectoryEndpoint
@DataBoundSetter public void setActiveDirectoryEndpoint(String activeDirectoryEndpoint)
-
getResourceManagerEndpoint
public String getResourceManagerEndpoint()
- Specified by:
getResourceManagerEndpoint
in classAzureBaseCredentials
-
setResourceManagerEndpoint
@DataBoundSetter public void setResourceManagerEndpoint(String resourceManagerEndpoint)
-
getAzureEnvironment
public com.azure.core.management.AzureEnvironment getAzureEnvironment()
- Specified by:
getAzureEnvironment
in classAzureBaseCredentials
-
getGraphEndpoint
public String getGraphEndpoint()
- Specified by:
getGraphEndpoint
in classAzureBaseCredentials
-
setGraphEndpoint
@DataBoundSetter public void setGraphEndpoint(String graphEndpoint)
-
-