Skip to content

Latest commit

 

History

History
122 lines (110 loc) · 3.44 KB

readCredential.md

File metadata and controls

122 lines (110 loc) · 3.44 KB

pv credential read

Command Reference > credential > read

Description

Get a credential.

Syntax

pv scan readCredential [--credentialName=<val>]

Required Arguments

None

Optional Arguments

--credentialName (string)
The name of the credential.

API Mapping

Get all credentials.

GET https://{accountName}.purview.azure.com/scan/credentials

Get a credential by name.

GET https://{accountName}.purview.azure.com/scan/credentials/{credentialName}

Examples

Get all credentials.

pv scan readCredential
Sample response. 

{
    "value": [
        {
            "etag": "1902bb63-0000-0d00-0000-621b7a0a0000",
            "id": "/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/scanning-prod-westeurope/providers/Microsoft.Purview/accounts/YOUR_PURVIEW_ACCOUNT/credentials/basic_credential",
            "name": "basic_credential",
            "properties": {
                "type": "BasicAuth",
                "typeProperties": {
                    "password": {
                        "secretName": "my-secret-name",
                        "secretVersion": "",
                        "store": {
                            "referenceName": "my_key_vault",
                            "type": "LinkedServiceReference"
                        },
                        "type": "AzureKeyVaultSecret"
                    },
                    "user": "username"
                }
            },
            "type": "Microsoft.Purview/accounts/credentials"
        },
        {
            "etag": "19026b66-0000-0d00-0000-621b7a290000",
            "id": "/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/scanning-prod-westeurope/providers/Microsoft.Purview/accounts/YOUR_PURVIEW_ACCOUNT/credentials/sql_auth",
            "name": "sql_auth",
            "properties": {
                "type": "SqlAuth",
                "typeProperties": {
                    "password": {
                        "secretName": "sql-secret-name",
                        "secretVersion": "",
                        "store": {
                            "referenceName": "my_key_vault",
                            "type": "LinkedServiceReference"
                        },
                        "type": "AzureKeyVaultSecret"
                    },
                    "user": "sql-user-name"
                }
            },
            "type": "Microsoft.Purview/accounts/credentials"
        }
    ]
}

Get a credential by name.

pv credential read --credentialName "basic_credential"
Sample response. 

{
    "etag": "1902bb63-0000-0d00-0000-621b7a0a0000",
    "id": "/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/scanning-prod-westeurope/providers/Microsoft.Purview/accounts/YOUR_PURVIEW_ACCOUNT/credentials/basic_credential",
    "name": "basic_credential",
    "properties": {
        "type": "BasicAuth",
        "typeProperties": {
            "password": {
                "secretName": "my-secret-name",
                "secretVersion": "",
                "store": {
                    "referenceName": "my_key_vault",
                    "type": "LinkedServiceReference"
                },
                "type": "AzureKeyVaultSecret"
            },
            "user": "username"
        }
    },
    "type": "Microsoft.Purview/accounts/credentials"
}