com.microsoft.azure.util

类 AzureCredentialsBinding

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.credentialsbinding.MultiBinding<C>>

org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

com.microsoft.azure.util.AzureCredentialsBinding

所有已实现的接口:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>>

public class AzureCredentialsBinding
extends org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

Custom binding for AzureCredentials to support reading Azure service principal in both freestyle and pipeline using Credentials Binding plugin. There're two ways to construct this binding: 1. With defaults, which will read specified service principal into four predefined environment variables: AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_TENANT_ID. Sample pipeline code: withCredentials([azureServicePrincipal('credentials_id')]) { sh 'az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET -t $AZURE_TENANT_ID' } 2. With custom name, where you can control the names of the variables. Sample pipeline code: withCredentials([azureServicePrincipal(credentialsId: 'credentials_id', subscriptionIdVariable: 'SUBS_ID', clientIdVariable: 'CLIENT_ID', clientSecretVariable: 'CLIENT_SECRET', tenantIdVariable: 'TENANT_ID')]) { sh 'az login --service-principal -u $CLIENT_ID -p $CLIENT_SECRET -t $TENANT_ID' }

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	AzureCredentialsBinding.DescriptorImpl

从类继承的嵌套类/接口 org.jenkinsci.plugins.credentialsbinding.MultiBinding

org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment, org.jenkinsci.plugins.credentialsbinding.MultiBinding.NullUnbinder, org.jenkinsci.plugins.credentialsbinding.MultiBinding.Unbinder

从接口继承的嵌套类/接口 hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_CLIENT_ID_VARIABLE
static String	DEFAULT_CLIENT_SECRET_VARIABLE
static String	DEFAULT_SUBSCRIPTION_ID_VARIABLE
static String	DEFAULT_TENANT_ID_VARIABLE

构造器概要

构造器

构造器和说明
AzureCredentialsBinding(String credentialsId)

方法概要

限定符和类型	方法和说明
org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment	bind(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
String	getClientIdVariable()
String	getClientSecretVariable()
String	getSubscriptionIdVariable()
String	getTenantIdVariable()
void	setClientIdVariable(String clientIdVariable)
void	setClientSecretVariable(String clientSecretVariable)
void	setSubscriptionIdVariable(String subscriptionIdVariable)
void	setTenantIdVariable(String tenantIdVariable)
protected Class<AzureCredentials>	type()
Set<String>	variables()

从类继承的方法 org.jenkinsci.plugins.credentialsbinding.MultiBinding

getCredentials, getCredentialsId, getDescriptor, getPatternStringForSecrets

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_SUBSCRIPTION_ID_VARIABLE

public static final String DEFAULT_SUBSCRIPTION_ID_VARIABLE

另请参阅:

常量字段值

DEFAULT_CLIENT_ID_VARIABLE

public static final String DEFAULT_CLIENT_ID_VARIABLE

另请参阅:

常量字段值

DEFAULT_CLIENT_SECRET_VARIABLE

public static final String DEFAULT_CLIENT_SECRET_VARIABLE

另请参阅:

常量字段值

DEFAULT_TENANT_ID_VARIABLE

public static final String DEFAULT_TENANT_ID_VARIABLE

另请参阅:

常量字段值

构造器详细资料

AzureCredentialsBinding

@DataBoundConstructor
public AzureCredentialsBinding(String credentialsId)

方法详细资料

setSubscriptionIdVariable

@DataBoundSetter
public final void setSubscriptionIdVariable(String subscriptionIdVariable)

setClientIdVariable

@DataBoundSetter
public final void setClientIdVariable(String clientIdVariable)

setClientSecretVariable

@DataBoundSetter
public final void setClientSecretVariable(String clientSecretVariable)

setTenantIdVariable

@DataBoundSetter
public final void setTenantIdVariable(String tenantIdVariable)

getSubscriptionIdVariable

public final String getSubscriptionIdVariable()

getClientIdVariable

public final String getClientIdVariable()

getClientSecretVariable

public final String getClientSecretVariable()

getTenantIdVariable

public final String getTenantIdVariable()

type

protected final Class<AzureCredentials> type()

指定者:

type 在类中 org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

bind

public final org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment bind(@Nonnull
                                                                                         hudson.model.Run<?,?> build,
                                                                                         hudson.FilePath workspace,
                                                                                         hudson.Launcher launcher,
                                                                                         hudson.model.TaskListener listener)
                                                                                  throws IOException,
                                                                                         InterruptedException

指定者:

bind 在类中 org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

抛出:

IOException

InterruptedException

variables

public final Set<String> variables()

指定者:

variables 在类中 org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>