Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. containerregistry
  5. getCredentialSet
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.containerregistry.getCredentialSet

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the properties of the specified credential set resource. Azure REST API version: 2023-01-01-preview.

Other available API versions: 2023-06-01-preview, 2023-07-01, 2023-08-01-preview, 2023-11-01-preview, 2024-11-01-preview.

Using getCredentialSet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCredentialSet(args: GetCredentialSetArgs, opts?: InvokeOptions): Promise<GetCredentialSetResult>
function getCredentialSetOutput(args: GetCredentialSetOutputArgs, opts?: InvokeOptions): Output<GetCredentialSetResult>
Copy
def get_credential_set(credential_set_name: Optional[str] = None,
                       registry_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCredentialSetResult
def get_credential_set_output(credential_set_name: Optional[pulumi.Input[str]] = None,
                       registry_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCredentialSetResult]
Copy
func LookupCredentialSet(ctx *Context, args *LookupCredentialSetArgs, opts ...InvokeOption) (*LookupCredentialSetResult, error)
func LookupCredentialSetOutput(ctx *Context, args *LookupCredentialSetOutputArgs, opts ...InvokeOption) LookupCredentialSetResultOutput
Copy

> Note: This function is named LookupCredentialSet in the Go SDK.

public static class GetCredentialSet 
{
    public static Task<GetCredentialSetResult> InvokeAsync(GetCredentialSetArgs args, InvokeOptions? opts = null)
    public static Output<GetCredentialSetResult> Invoke(GetCredentialSetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCredentialSetResult> getCredentialSet(GetCredentialSetArgs args, InvokeOptions options)
public static Output<GetCredentialSetResult> getCredentialSet(GetCredentialSetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:containerregistry:getCredentialSet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CredentialSetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the credential set.
RegistryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the container registry.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CredentialSetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the credential set.
RegistryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the container registry.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
credentialSetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the credential set.
registryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the container registry.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
credentialSetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the credential set.
registryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the container registry.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
credential_set_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the credential set.
registry_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the container registry.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
credentialSetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the credential set.
registryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the container registry.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getCredentialSet Result

The following output properties are available:

CreationDate string
The creation date of credential store resource.
Id string
The resource ID.
Name string
The name of the resource.
ProvisioningState string
Provisioning state of the resource.
SystemData Pulumi.AzureNative.ContainerRegistry.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
AuthCredentials List<Pulumi.AzureNative.ContainerRegistry.Outputs.AuthCredentialResponse>
List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
Identity Pulumi.AzureNative.ContainerRegistry.Outputs.IdentityPropertiesResponse
Identities associated with the resource. This is used to access the KeyVault secrets.
LoginServer string
The credentials are stored for this upstream or login server.
CreationDate string
The creation date of credential store resource.
Id string
The resource ID.
Name string
The name of the resource.
ProvisioningState string
Provisioning state of the resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
AuthCredentials []AuthCredentialResponse
List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
Identity IdentityPropertiesResponse
Identities associated with the resource. This is used to access the KeyVault secrets.
LoginServer string
The credentials are stored for this upstream or login server.
creationDate String
The creation date of credential store resource.
id String
The resource ID.
name String
The name of the resource.
provisioningState String
Provisioning state of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
authCredentials List<AuthCredentialResponse>
List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
identity IdentityPropertiesResponse
Identities associated with the resource. This is used to access the KeyVault secrets.
loginServer String
The credentials are stored for this upstream or login server.
creationDate string
The creation date of credential store resource.
id string
The resource ID.
name string
The name of the resource.
provisioningState string
Provisioning state of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
authCredentials AuthCredentialResponse[]
List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
identity IdentityPropertiesResponse
Identities associated with the resource. This is used to access the KeyVault secrets.
loginServer string
The credentials are stored for this upstream or login server.
creation_date str
The creation date of credential store resource.
id str
The resource ID.
name str
The name of the resource.
provisioning_state str
Provisioning state of the resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
auth_credentials Sequence[AuthCredentialResponse]
List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
identity IdentityPropertiesResponse
Identities associated with the resource. This is used to access the KeyVault secrets.
login_server str
The credentials are stored for this upstream or login server.
creationDate String
The creation date of credential store resource.
id String
The resource ID.
name String
The name of the resource.
provisioningState String
Provisioning state of the resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
authCredentials List<Property Map>
List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
identity Property Map
Identities associated with the resource. This is used to access the KeyVault secrets.
loginServer String
The credentials are stored for this upstream or login server.

Supporting Types

AuthCredentialResponse

CredentialHealth This property is required. Pulumi.AzureNative.ContainerRegistry.Inputs.CredentialHealthResponse
This provides data pertaining to the health of the auth credential.
Name string
The name of the credential.
PasswordSecretIdentifier string
KeyVault Secret URI for accessing the password.
UsernameSecretIdentifier string
KeyVault Secret URI for accessing the username.
CredentialHealth This property is required. CredentialHealthResponse
This provides data pertaining to the health of the auth credential.
Name string
The name of the credential.
PasswordSecretIdentifier string
KeyVault Secret URI for accessing the password.
UsernameSecretIdentifier string
KeyVault Secret URI for accessing the username.
credentialHealth This property is required. CredentialHealthResponse
This provides data pertaining to the health of the auth credential.
name String
The name of the credential.
passwordSecretIdentifier String
KeyVault Secret URI for accessing the password.
usernameSecretIdentifier String
KeyVault Secret URI for accessing the username.
credentialHealth This property is required. CredentialHealthResponse
This provides data pertaining to the health of the auth credential.
name string
The name of the credential.
passwordSecretIdentifier string
KeyVault Secret URI for accessing the password.
usernameSecretIdentifier string
KeyVault Secret URI for accessing the username.
credential_health This property is required. CredentialHealthResponse
This provides data pertaining to the health of the auth credential.
name str
The name of the credential.
password_secret_identifier str
KeyVault Secret URI for accessing the password.
username_secret_identifier str
KeyVault Secret URI for accessing the username.
credentialHealth This property is required. Property Map
This provides data pertaining to the health of the auth credential.
name String
The name of the credential.
passwordSecretIdentifier String
KeyVault Secret URI for accessing the password.
usernameSecretIdentifier String
KeyVault Secret URI for accessing the username.

CredentialHealthResponse

ErrorCode string
Error code representing the health check error.
ErrorMessage string
Descriptive message representing the health check error.
Status string
The health status of credential.
ErrorCode string
Error code representing the health check error.
ErrorMessage string
Descriptive message representing the health check error.
Status string
The health status of credential.
errorCode String
Error code representing the health check error.
errorMessage String
Descriptive message representing the health check error.
status String
The health status of credential.
errorCode string
Error code representing the health check error.
errorMessage string
Descriptive message representing the health check error.
status string
The health status of credential.
error_code str
Error code representing the health check error.
error_message str
Descriptive message representing the health check error.
status str
The health status of credential.
errorCode String
Error code representing the health check error.
errorMessage String
Descriptive message representing the health check error.
status String
The health status of credential.

IdentityPropertiesResponse

PrincipalId string
The principal ID of resource identity.
TenantId string
The tenant ID of resource.
Type string
The identity type.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.ContainerRegistry.Inputs.UserIdentityPropertiesResponse>
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
PrincipalId string
The principal ID of resource identity.
TenantId string
The tenant ID of resource.
Type string
The identity type.
UserAssignedIdentities map[string]UserIdentityPropertiesResponse
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId String
The principal ID of resource identity.
tenantId String
The tenant ID of resource.
type String
The identity type.
userAssignedIdentities Map<String,UserIdentityPropertiesResponse>
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId string
The principal ID of resource identity.
tenantId string
The tenant ID of resource.
type string
The identity type.
userAssignedIdentities {[key: string]: UserIdentityPropertiesResponse}
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principal_id str
The principal ID of resource identity.
tenant_id str
The tenant ID of resource.
type str
The identity type.
user_assigned_identities Mapping[str, UserIdentityPropertiesResponse]
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId String
The principal ID of resource identity.
tenantId String
The tenant ID of resource.
type String
The identity type.
userAssignedIdentities Map<Property Map>
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource modification (UTC).
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource modification (UTC).
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserIdentityPropertiesResponse

ClientId string
The client id of user assigned identity.
PrincipalId string
The principal id of user assigned identity.
ClientId string
The client id of user assigned identity.
PrincipalId string
The principal id of user assigned identity.
clientId String
The client id of user assigned identity.
principalId String
The principal id of user assigned identity.
clientId string
The client id of user assigned identity.
principalId string
The principal id of user assigned identity.
client_id str
The client id of user assigned identity.
principal_id str
The principal id of user assigned identity.
clientId String
The client id of user assigned identity.
principalId String
The principal id of user assigned identity.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native