Condividi tramite

Microsoft.DataFactory factory/credentials 2018-06-01

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa factory/credenziali può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DataFactory/factory/credentials, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.DataFactory/factories/credentials@2018-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    annotations: [
      any(Azure.Bicep.Types.Concrete.AnyType)
    ]
    description: 'string'
    type: 'string'
    // For remaining properties, see Credential objects
  }
}

Oggetti credenziali

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per ManagedIdentity, usare:

{
  type: 'ManagedIdentity'
  typeProperties: {
    resourceId: 'string'
  }
}

Per ServicePrincipal, usare:

{
  type: 'ServicePrincipal'
  typeProperties: {
    servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
    servicePrincipalKey: {
      secretName: any(Azure.Bicep.Types.Concrete.AnyType)
      secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
      store: {
        parameters: {
          {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
        }
        referenceName: 'string'
        type: 'string'
      }
      type: 'string'
    }
    tenant: any(Azure.Bicep.Types.Concrete.AnyType)
  }
}

Valori delle proprietà

AzureKeyVaultSecretReference

Nome Descrizione Valore
secretName Nome del segreto in Azure Key Vault. Tipo: stringa (o Espressione con stringa resultType). any (obbligatorio)
secretVersion Versione del segreto in Azure Key Vault. Il valore predefinito è la versione più recente del segreto. Tipo: stringa (o Espressione con stringa resultType). qualunque
negozio Informazioni di riferimento sul servizio collegato di Azure Key Vault. LinkedServiceReference (obbligatorio)
digitare Tipo del segreto. stringa (obbligatorio)

Credenziale

Nome Descrizione Valore
Annotazioni Elenco di tag che possono essere usati per descrivere le credenziali. any[]
descrizione Descrizione delle credenziali. corda
digitare Impostare su "ManagedIdentity" per il tipo ManagedIdentityCredential. Impostare su 'ServicePrincipal' per il tipo ServicePrincipalCredential. 'ManagedIdentity'
'ServicePrincipal' (obbligatorio)

LinkedServiceReference

Nome Descrizione Valore
Parametri Argomenti per LinkedService. ParameterValueSpecification
referenceName Fare riferimento al nome LinkedService. stringa (obbligatorio)
digitare Tipo di riferimento del servizio collegato. 'LinkedServiceReference' (obbligatorio)

ManagedIdentityCredential

Nome Descrizione Valore
digitare Tipo di credenziale. 'ManagedIdentity' (obbligatorio)
typeProperties Proprietà delle credenziali dell'identità gestita. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nome Descrizione Valore
resourceId ID risorsa dell'identità gestita assegnata dall'utente corda

Microsoft.DataFactory/factory/credentials

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 127
Pattern = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: factory
proprietà Proprietà delle credenziali. credenziali (obbligatorio)

ParameterValueSpecification

Nome Descrizione Valore

ServicePrincipalCredential

Nome Descrizione Valore
digitare Tipo di credenziale. 'ServicePrincipal' (obbligatorio)
typeProperties Proprietà delle credenziali dell'entità servizio. ServicePrincipalCredentialTypeProperties (obbligatorio)

ServicePrincipalCredentialTypeProperties

Nome Descrizione Valore
servicePrincipalId ID app dell'entità servizio usata per l'autenticazione qualunque
servicePrincipalKey Chiave dell'entità servizio usata per l'autenticazione. azureKeyVaultSecretReference
inquilino ID del tenant a cui appartiene l'entità servizio qualunque

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa factory/credenziali può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DataFactory/factory/credentials, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DataFactory/factories/credentials",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "annotations": [ {} ],
    "description": "string",
    "type": "string"
    // For remaining properties, see Credential objects
  }
}

Oggetti credenziali

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per ManagedIdentity, usare:

{
  "type": "ManagedIdentity",
  "typeProperties": {
    "resourceId": "string"
  }
}

Per ServicePrincipal, usare:

{
  "type": "ServicePrincipal",
  "typeProperties": {
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "string"
      },
      "type": "string"
    },
    "tenant": {}
  }
}

Valori delle proprietà

AzureKeyVaultSecretReference

Nome Descrizione Valore
secretName Nome del segreto in Azure Key Vault. Tipo: stringa (o Espressione con stringa resultType). any (obbligatorio)
secretVersion Versione del segreto in Azure Key Vault. Il valore predefinito è la versione più recente del segreto. Tipo: stringa (o Espressione con stringa resultType). qualunque
negozio Informazioni di riferimento sul servizio collegato di Azure Key Vault. LinkedServiceReference (obbligatorio)
digitare Tipo del segreto. stringa (obbligatorio)

Credenziale

Nome Descrizione Valore
Annotazioni Elenco di tag che possono essere usati per descrivere le credenziali. any[]
descrizione Descrizione delle credenziali. corda
digitare Impostare su "ManagedIdentity" per il tipo ManagedIdentityCredential. Impostare su 'ServicePrincipal' per il tipo ServicePrincipalCredential. 'ManagedIdentity'
'ServicePrincipal' (obbligatorio)

LinkedServiceReference

Nome Descrizione Valore
Parametri Argomenti per LinkedService. ParameterValueSpecification
referenceName Fare riferimento al nome LinkedService. stringa (obbligatorio)
digitare Tipo di riferimento del servizio collegato. 'LinkedServiceReference' (obbligatorio)

ManagedIdentityCredential

Nome Descrizione Valore
digitare Tipo di credenziale. 'ManagedIdentity' (obbligatorio)
typeProperties Proprietà delle credenziali dell'identità gestita. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nome Descrizione Valore
resourceId ID risorsa dell'identità gestita assegnata dall'utente corda

Microsoft.DataFactory/factory/credentials

Nome Descrizione Valore
apiVersion Versione dell'API '2018-06-01'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 127
Pattern = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (obbligatorio)
proprietà Proprietà delle credenziali. credenziali (obbligatorio)
digitare Tipo di risorsa 'Microsoft.DataFactory/factory/credentials'

ParameterValueSpecification

Nome Descrizione Valore

ServicePrincipalCredential

Nome Descrizione Valore
digitare Tipo di credenziale. 'ServicePrincipal' (obbligatorio)
typeProperties Proprietà delle credenziali dell'entità servizio. ServicePrincipalCredentialTypeProperties (obbligatorio)

ServicePrincipalCredentialTypeProperties

Nome Descrizione Valore
servicePrincipalId ID app dell'entità servizio usata per l'autenticazione qualunque
servicePrincipalKey Chiave dell'entità servizio usata per l'autenticazione. azureKeyVaultSecretReference
inquilino ID del tenant a cui appartiene l'entità servizio qualunque

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa factory/credenziali può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DataFactory/factory/credentials, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/credentials@2018-06-01"
  name = "string"
  body = jsonencode({
    properties = {
      annotations = [
        ?
      ]
      description = "string"
      type = "string"
      // For remaining properties, see Credential objects
    }
  })
}

Oggetti credenziali

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per ManagedIdentity, usare:

{
  type = "ManagedIdentity"
  typeProperties = {
    resourceId = "string"
  }
}

Per ServicePrincipal, usare:

{
  type = "ServicePrincipal"
  typeProperties = {
    servicePrincipalId = ?
    servicePrincipalKey = {
      secretName = ?
      secretVersion = ?
      store = {
        parameters = {
          {customized property} = ?
        }
        referenceName = "string"
        type = "string"
      }
      type = "string"
    }
    tenant = ?
  }
}

Valori delle proprietà

AzureKeyVaultSecretReference

Nome Descrizione Valore
secretName Nome del segreto in Azure Key Vault. Tipo: stringa (o Espressione con stringa resultType). any (obbligatorio)
secretVersion Versione del segreto in Azure Key Vault. Il valore predefinito è la versione più recente del segreto. Tipo: stringa (o Espressione con stringa resultType). qualunque
negozio Informazioni di riferimento sul servizio collegato di Azure Key Vault. LinkedServiceReference (obbligatorio)
digitare Tipo del segreto. stringa (obbligatorio)

Credenziale

Nome Descrizione Valore
Annotazioni Elenco di tag che possono essere usati per descrivere le credenziali. any[]
descrizione Descrizione delle credenziali. corda
digitare Impostare su "ManagedIdentity" per il tipo ManagedIdentityCredential. Impostare su 'ServicePrincipal' per il tipo ServicePrincipalCredential. 'ManagedIdentity'
'ServicePrincipal' (obbligatorio)

LinkedServiceReference

Nome Descrizione Valore
Parametri Argomenti per LinkedService. ParameterValueSpecification
referenceName Fare riferimento al nome LinkedService. stringa (obbligatorio)
digitare Tipo di riferimento del servizio collegato. 'LinkedServiceReference' (obbligatorio)

ManagedIdentityCredential

Nome Descrizione Valore
digitare Tipo di credenziale. 'ManagedIdentity' (obbligatorio)
typeProperties Proprietà delle credenziali dell'identità gestita. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nome Descrizione Valore
resourceId ID risorsa dell'identità gestita assegnata dall'utente corda

Microsoft.DataFactory/factory/credentials

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 127
Pattern = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: factory
proprietà Proprietà delle credenziali. credenziali (obbligatorio)
digitare Tipo di risorsa "Microsoft.DataFactory/factory/credentials@2018-06-01"

ParameterValueSpecification

Nome Descrizione Valore

ServicePrincipalCredential

Nome Descrizione Valore
digitare Tipo di credenziale. 'ServicePrincipal' (obbligatorio)
typeProperties Proprietà delle credenziali dell'entità servizio. ServicePrincipalCredentialTypeProperties (obbligatorio)

ServicePrincipalCredentialTypeProperties

Nome Descrizione Valore
servicePrincipalId ID app dell'entità servizio usata per l'autenticazione qualunque
servicePrincipalKey Chiave dell'entità servizio usata per l'autenticazione. azureKeyVaultSecretReference
inquilino ID del tenant a cui appartiene l'entità servizio qualunque