Share via

CustomRegistryCredentials Class

  • Reference
Package:
com.azure.resourcemanager.containerregistry.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-containerregistry:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.containerregistry.models.CustomRegistryCredentials

Implements

JsonSerializable<CustomRegistryCredentials>

public final class CustomRegistryCredentials
implements JsonSerializable<CustomRegistryCredentials>

Describes the credentials that will be used to access a custom registry during a run.

Constructor Summary

Constructor Description
CustomRegistryCredentials()

Creates an instance of CustomRegistryCredentials class.

Method Summary

Modifier and Type Method and Description
static CustomRegistryCredentials fromJson(JsonReader jsonReader)

Reads an instance of CustomRegistryCredentials from the JsonReader.
String identity()

Get the identity property: Indicates the managed identity assigned to the custom credential.
SecretObject password()

Get the password property: The password for logging into the custom registry.
JsonWriter toJson(JsonWriter jsonWriter)
SecretObject username()

Get the username property: The username for logging into the custom registry.
void validate()

Validates the instance.
CustomRegistryCredentials withIdentity(String identity)

Set the identity property: Indicates the managed identity assigned to the custom credential.
CustomRegistryCredentials withPassword(SecretObject password)

Set the password property: The password for logging into the custom registry.
CustomRegistryCredentials withUsername(SecretObject username)

Set the username property: The username for logging into the custom registry.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CustomRegistryCredentials

public CustomRegistryCredentials()

Creates an instance of CustomRegistryCredentials class.

Method Details

fromJson

public static CustomRegistryCredentials fromJson(JsonReader jsonReader)

Reads an instance of CustomRegistryCredentials from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CustomRegistryCredentials if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the CustomRegistryCredentials.

identity

public String identity()

Get the identity property: Indicates the managed identity assigned to the custom credential. If a user-assigned identity this value is the Client ID. If a system-assigned identity, the value will be `system`. In the case of a system-assigned identity, the Client ID will be determined by the runner. This identity may be used to authenticate to key vault to retrieve credentials or it may be the only source of authentication used for accessing the registry.

Returns:

the identity value.

password

public SecretObject password()

Get the password property: The password for logging into the custom registry. The password is a secret object that allows multiple ways of providing the value for it.

Returns:

the password value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

username

public SecretObject username()

Get the username property: The username for logging into the custom registry.

Returns:

the username value.

validate

public void validate()

Validates the instance.

withIdentity

public CustomRegistryCredentials withIdentity(String identity)

Set the identity property: Indicates the managed identity assigned to the custom credential. If a user-assigned identity this value is the Client ID. If a system-assigned identity, the value will be `system`. In the case of a system-assigned identity, the Client ID will be determined by the runner. This identity may be used to authenticate to key vault to retrieve credentials or it may be the only source of authentication used for accessing the registry.

Parameters:

identity - the identity value to set.

Returns:

the CustomRegistryCredentials object itself.

withPassword

public CustomRegistryCredentials withPassword(SecretObject password)

Set the password property: The password for logging into the custom registry. The password is a secret object that allows multiple ways of providing the value for it.

Parameters:

password - the password value to set.

Returns:

the CustomRegistryCredentials object itself.

withUsername

public CustomRegistryCredentials withUsername(SecretObject username)

Set the username property: The username for logging into the custom registry.

Parameters:

username - the username value to set.

Returns:

the CustomRegistryCredentials object itself.

Applies to