Credential - Get

Referencia

Szolgáltatás:: Purview

API-verzió:: 2023-09-01

Lekéri a hitelesítő adatokat.

GET {endpoint}/scan/credentials/{credentialName}?api-version=2023-09-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
credentialName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	A hitelesítő adatok neve.
endpoint	path	True	string (url)	A purview-fiók vizsgálati végpontja. Példa: https://{accountName}.purview.azure.com.
api-version	query	True	string	A használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	Credential: AccountKeyAuthAzureKeyVaultCredential BasicAuthAzureKeyVaultCredential RoleARNCredential ServicePrincipalAzureKeyVaultCredential SqlAuthAzureKeyVaultCredential ConsumerKeyAuthAzureKeyVaultCredential DelegatedAuthAzureKeyVaultCredential ManagedIdentityAzureKeyVaultCredential	Siker.
Other Status Codes	ErrorResponseModel	Hibaválasz érkezett a scannelési szolgáltatástól. Fejlécek x-ms-error-code: string

Name

Típus

Description

200 OK

Credential:

AccountKeyAuthAzureKeyVaultCredential
BasicAuthAzureKeyVaultCredential
RoleARNCredential
ServicePrincipalAzureKeyVaultCredential
SqlAuthAzureKeyVaultCredential
ConsumerKeyAuthAzureKeyVaultCredential
DelegatedAuthAzureKeyVaultCredential
ManagedIdentityAzureKeyVaultCredential

Siker.

Other Status Codes

ErrorResponseModel

Hibaválasz érkezett a scannelési szolgáltatástól.

Fejlécek

x-ms-error-code: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Credential_Get

Mintakérelem

HTTP

GET {endpoint}/scan/credentials/myCredential?api-version=2023-09-01

Mintaválasz

Állapotkód:: 200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "name": "myCredential",
  "kind": "BasicAuth",
  "properties": {
    "description": "test description"
  }
}

Definíciók

Name	Description
AccountKeyAuthAzureKeyVaultCredential	Hitelesítő adattípus, amely a hitelesítéshez fiókkulcsot használ.
AccountKeyCredentialProperties	A fiókkulcs hitelesítő adatainak tulajdonságai.
BasicAuthAzureKeyVaultCredential	Alapszintű hitelesítést használó hitelesítő adattípus.
ConsumerKeyAuthAzureKeyVaultCredential	Hitelesítő adattípus, amely a hitelesítéshez a fogyasztó által megadott kulcsot és titkos kulcsot használja.
ConsumerKeyCredentialProperties	A fogyasztói kulcs hitelesítő adatainak tulajdonságai.
CredentialType	A hitelesítő adatok típusa.
DelegatedAuthAzureKeyVaultCredential	Hitelesítő adattípus, amely ügyfél-azonosítót használ a hitelesítéshez.
DelegatedAuthCredentialProperties	A delegált hitelesítési hitelesítő adatok tulajdonságai.
ErrorModel	A hibamodell.
ErrorResponseModel	A hibaválasz-modell.
KeyVaultSecret	A kulcstartó titkos kulcsa.
KeyVaultSecretAccountKeyCredentialTypeProperties	A Key Vault titkos fiókkulcs-hitelesítő adatainak tulajdonságai.
KeyVaultSecretConsumerKeyCredentialTypeProperties	A key vault titkos fogyasztói kulcs hitelesítő adatainak típustulajdonságai.
KeyVaultSecretDelegatedAuthCredentialTypeProperties	A kulcstartó titkos kulcstartó által delegált hitelesítő adatainak típustulajdonságai.
KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties	A key vault titkos felügyelt identitásának Azure Key Vault-hitelesítő adatainak típustulajdonságai.
KeyVaultSecretServicePrinipalCredentialTypeProperties	A Key Vault titkos szolgáltatás egyszerű hitelesítő adatainak típustulajdonságai.
KeyVaultSecretUserPassCredentialTypeProperties	A Key Vault titkos felhasználói hitelesítő adatainak tulajdonságai.
ManagedIdentityAzureKeyVaultCredential	Hitelesítő adattípus, amely a hitelesítéshez felhasználó által hozzárendelt felügyelt identitásokat használ.
ManagedIdentityAzureKeyVaultCredentialProperties	A felügyelt identitás azure Key Vault-hitelesítő adatainak tulajdonságai.
RoleARNCredential	Hitelesítő adattípus, amely a hitelesítéshez fiókazonosítót, külső azonosítót és szerepkör-ARN-t használ.
RoleARNCredentialProperties	Az ARN szerepkör hitelesítő adatainak tulajdonságai.
RoleARNCredentialTypeProperties	Az ARN szerepkör hitelesítő adatainak típustulajdonságai.
ServicePrincipalAzureKeyVaultCredential	Hitelesítő adattípus, amely bérlőazonosítót és szolgáltatásnév-azonosítót használ a hitelesítéshez.
ServicePrincipalAzureKeyVaultCredentialProperties	A szolgáltatásnév Azure Key Vault-hitelesítő adatainak tulajdonságai.
SqlAuthAzureKeyVaultCredential	Hitelesítő adattípus, amely az SQL-t használja a hitelesítéshez.
Store	A boltba.
UserPassCredentialProperties	A felhasználói hitelesítő adatok tulajdonságai.

AccountKeyAuthAzureKeyVaultCredential

Objektum

Hitelesítő adattípus, amely a hitelesítéshez fiókkulcsot használ.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: AccountKey	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	AccountKeyCredentialProperties	A fiókkulcs hitelesítésének tulajdonságai Az Azure Key Vault hitelesítő adatai.

AccountKeyCredentialProperties

Objektum

A fiókkulcs hitelesítő adatainak tulajdonságai.

Name	Típus	Description
description	string
typeProperties	KeyVaultSecretAccountKeyCredentialTypeProperties	A fiókkulcs hitelesítő adatainak típustulajdonságai.

BasicAuthAzureKeyVaultCredential

Objektum

Alapszintű hitelesítést használó hitelesítő adattípus.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: BasicAuth	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	UserPassCredentialProperties	Az Azure Key Vault alapszintű hitelesítő adatainak tulajdonságai.

ConsumerKeyAuthAzureKeyVaultCredential

Objektum

Hitelesítő adattípus, amely a hitelesítéshez a fogyasztó által megadott kulcsot és titkos kulcsot használja.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: ConsumerKeyAuth	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	ConsumerKeyCredentialProperties	A fogyasztói kulcs hitelesítő adatainak tulajdonságai.

ConsumerKeyCredentialProperties

Objektum

A fogyasztói kulcs hitelesítő adatainak tulajdonságai.

Name	Típus	Description
description	string	A hitelesítő adatok tulajdonságainak leírása.
typeProperties	KeyVaultSecretConsumerKeyCredentialTypeProperties	A key vault titkos fogyasztói kulcs hitelesítő adatainak típustulajdonságai.

CredentialType

Enumerálás

A hitelesítő adatok típusa.

Érték	Description
AccountKey	a hitelesítő adat típusa fiókkulcs
AmazonARN	a hitelesítő adat típusa amazon ARN
BasicAuth	a hitelesítő adat típusa alapszintű hitelesítés
ConsumerKeyAuth	a hitelesítő adat típusa a Fogyasztói kulcs hitelesítése
DelegatedAuth	a hitelesítő adat típusa delegált hitelesítésű
ManagedIdentity	a hitelesítő adat típusa felügyelt identitás
ServicePrincipal	a hitelesítő adat típusa szolgáltatásnév
SqlAuth	a hitelesítő adat típusa sql-hitelesítés

DelegatedAuthAzureKeyVaultCredential

Objektum

Hitelesítő adattípus, amely ügyfél-azonosítót használ a hitelesítéshez.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: DelegatedAuth	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	DelegatedAuthCredentialProperties	A delegált hitelesítésű Azure Key Vault-hitelesítő adatok tulajdonságai.

DelegatedAuthCredentialProperties

Objektum

A delegált hitelesítési hitelesítő adatok tulajdonságai.

Name	Típus	Description
description	string
typeProperties	KeyVaultSecretDelegatedAuthCredentialTypeProperties	A kulcstartó titkos kulcstartó által delegált hitelesítő adatainak típustulajdonságai.

ErrorModel

Objektum

A hibamodell.

Name	Típus	Description
code	string	Egyedi hibakód, amely azonosítja az adott hibát.
details	ErrorModel[]	Beágyazott ErrorModel-objektumok tömbje, amely további hibaadatokat biztosít.
message	string	Egy emberi olvasásra alkalmas hibaüzenet, amely további részleteket tartalmaz a hibáról.
target	string	Az adott összetevő, amelyhez a hiba társítva van.

ErrorResponseModel

Objektum

A hibaválasz-modell.

Name	Típus	Description
error	ErrorModel	A hibamodell.

KeyVaultSecret

Objektum

A kulcstartó titkos kulcsa.

Name	Típus	Description
secretName	string	A key vault titkos neve.
secretVersion	string	A key vault titkos verziója.
store	Store	A boltba.
type	string	A kulcstartó titkos kulcsának típusa.

KeyVaultSecretAccountKeyCredentialTypeProperties

Objektum

A Key Vault titkos fiókkulcs-hitelesítő adatainak tulajdonságai.

Name	Típus	Description
accountKey	KeyVaultSecret	A key vault titkos fiókkulcs hitelesítő adatainak típusa.

KeyVaultSecretConsumerKeyCredentialTypeProperties

Objektum

A key vault titkos fogyasztói kulcs hitelesítő adatainak típustulajdonságai.

Name	Típus	Description
consumerKey	string	A key vault titkos fogyasztói kulcs hitelesítő adatainak tulajdonságainak fogyasztói kulcsa.
consumerSecret	KeyVaultSecret	A key vault titkos fogyasztói kulcs hitelesítő adatainak tulajdonságainak fogyasztói titkos kulcsa.
password	KeyVaultSecret	A key vault titkos fogyasztói kulcs hitelesítő adatainak tulajdonságainak jelszava.
user	string	Felhasználónév.

KeyVaultSecretDelegatedAuthCredentialTypeProperties

Objektum

A kulcstartó titkos kulcstartó által delegált hitelesítő adatainak típustulajdonságai.

Name	Típus	Description
clientId	string	Hitelesítő adattípus, amely a hitelesítéshez fiókazonosítót, külső azonosítót és szerepkör-ARN-t használ.
password	KeyVaultSecret	Kulcstartó titkos kulcsa.
user	string	Felhasználónév.

KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties

Objektum

A key vault titkos felügyelt identitásának Azure Key Vault-hitelesítő adatainak típustulajdonságai.

Name	Típus	Description
principalId	string	A key vault titkos felügyelt identitásának Azure Key Vault hitelesítőadat-típustulajdonságainak fő azonosítója.
resourceId	string	A key vault titkos felügyelt identitásának Azure Key Vault hitelesítőadat-típustulajdonságainak erőforrás-azonosítója.
tenantId	string	A key vault titkos felügyelt identitásának bérlőazonosítója, az Azure Key Vault hitelesítőadat-típusának tulajdonságai.

KeyVaultSecretServicePrinipalCredentialTypeProperties

Objektum

A Key Vault titkos szolgáltatás egyszerű hitelesítő adatainak típustulajdonságai.

Name	Típus	Description
servicePrincipalId	string	A Key Vault titkos szolgáltatásnév hitelesítő adatainak szolgáltatásnév-azonosítója.
servicePrincipalKey	KeyVaultSecret	A kulcstartó titkos kulcsa.
tenant	string

KeyVaultSecretUserPassCredentialTypeProperties

Objektum

A Key Vault titkos felhasználói hitelesítő adatainak tulajdonságai.

Name	Típus	Description
password	KeyVaultSecret	A key vault titkos felhasználói hitelesítő adatainak jelszava.
user	string	Felhasználónév.

ManagedIdentityAzureKeyVaultCredential

Objektum

Hitelesítő adattípus, amely a hitelesítéshez felhasználó által hozzárendelt felügyelt identitásokat használ.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: ManagedIdentity	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	ManagedIdentityAzureKeyVaultCredentialProperties	A felügyelt identitás azure Key Vault-hitelesítő adatainak tulajdonságai.

ManagedIdentityAzureKeyVaultCredentialProperties

Objektum

A felügyelt identitás azure Key Vault-hitelesítő adatainak tulajdonságai.

Name	Típus	Description
description	string
typeProperties	KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties	A felügyelt identitás Azure Key Vault hitelesítő adatainak típustulajdonságai.

RoleARNCredential

Objektum

Hitelesítő adattípus, amely a hitelesítéshez fiókazonosítót, külső azonosítót és szerepkör-ARN-t használ.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: AmazonARN	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	RoleARNCredentialProperties	Az ARN szerepkör hitelesítő adatainak tulajdonságai.

RoleARNCredentialProperties

Objektum

Az ARN szerepkör hitelesítő adatainak tulajdonságai.

Name	Típus	Description
description	string	Az ARN szerepkör hitelesítő adatainak leírása.
typeProperties	RoleARNCredentialTypeProperties	Az ARN szerepkör hitelesítő adatainak típustulajdonságai.

RoleARNCredentialTypeProperties

Objektum

Az ARN szerepkör hitelesítő adatainak típustulajdonságai.

Name	Típus	Description
roleARN	string	A szerepkör ARN hitelesítő adatainak szerepkör-ARN-tulajdonsága.

ServicePrincipalAzureKeyVaultCredential

Objektum

Hitelesítő adattípus, amely bérlőazonosítót és szolgáltatásnév-azonosítót használ a hitelesítéshez.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: ServicePrincipal	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	ServicePrincipalAzureKeyVaultCredentialProperties	A szolgáltatásnév Azure Key Vault-hitelesítő adatainak tulajdonságai.

ServicePrincipalAzureKeyVaultCredentialProperties

Objektum

A szolgáltatásnév Azure Key Vault-hitelesítő adatainak tulajdonságai.

Name	Típus	Description
description	string
typeProperties	KeyVaultSecretServicePrinipalCredentialTypeProperties	A Key Vault titkos szolgáltatás egyszerű hitelesítő adatainak típustulajdonságai.

SqlAuthAzureKeyVaultCredential

Objektum

Hitelesítő adattípus, amely az SQL-t használja a hitelesítéshez.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
kind	string: SqlAuth	A hitelesítő adatok fajtája.
name	string	Az erőforrás neve.
properties	UserPassCredentialProperties	A felhasználói hitelesítő adatok tulajdonságai.

Store

Objektum

A boltba.

Name	Típus	Description
referenceName	string	Az áruház hivatkozási neve.
type	string	Az áruház típusa.

UserPassCredentialProperties

Objektum

A felhasználói hitelesítő adatok tulajdonságai.

Name	Típus	Description
description	string
typeProperties	KeyVaultSecretUserPassCredentialTypeProperties	A Key Vault titkos felhasználói hitelesítő adatainak tulajdonságai.

Megosztás a következőn keresztül:

Credential - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Credential_Get

Mintakérelem

Mintaválasz

Definíciók

AccountKeyAuthAzureKeyVaultCredential

AccountKeyCredentialProperties

BasicAuthAzureKeyVaultCredential

ConsumerKeyAuthAzureKeyVaultCredential

ConsumerKeyCredentialProperties

CredentialType

DelegatedAuthAzureKeyVaultCredential

DelegatedAuthCredentialProperties

ErrorModel

ErrorResponseModel

KeyVaultSecret

KeyVaultSecretAccountKeyCredentialTypeProperties

KeyVaultSecretConsumerKeyCredentialTypeProperties

KeyVaultSecretDelegatedAuthCredentialTypeProperties

KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties

KeyVaultSecretServicePrinipalCredentialTypeProperties

KeyVaultSecretUserPassCredentialTypeProperties

ManagedIdentityAzureKeyVaultCredential

ManagedIdentityAzureKeyVaultCredentialProperties

RoleARNCredential

RoleARNCredentialProperties

RoleARNCredentialTypeProperties

ServicePrincipalAzureKeyVaultCredential

ServicePrincipalAzureKeyVaultCredentialProperties

SqlAuthAzureKeyVaultCredential

Store

UserPassCredentialProperties