Factorías/credenciales de Microsoft.DataFactory 2018-06-01

2025-06-27

más reciente
2018-06-01

Definición de recursos de Bicep

El tipo de recurso factorys/credentials se puede implementar con operaciones que tienen como destino:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DataFactory/factorys/credentials, agregue el siguiente bicep a la plantilla.

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

Objetos de credenciales

Establezca el tipo propiedad para especificar el tipo de objeto.

Para managedIdentity, use:

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

Para ServicePrincipal, use:

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

Valores de propiedad

Microsoft.DataFactory/factorys/credentials

Nombre	Descripción	Valor
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 127 Patrón = `^([_A-Za-z0-9]\|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$` (obligatorio)
padre	En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para obtener más información, consulte recurso secundario fuera del recurso primario.	Nombre simbólico del recurso de tipo: generadores
Propiedades	Propiedades de las credenciales.	de credenciales (obligatorio)

AzureKeyVaultSecretReference

Nombre	Descripción	Valor
nombreSecreto	Nombre del secreto en Azure Key Vault. Tipo: cadena (o Expresión con cadena resultType).	any (obligatorio)
secretVersion	Versión del secreto en Azure Key Vault. El valor predeterminado es la versión más reciente del secreto. Tipo: cadena (o Expresión con cadena resultType).	cualquier
tienda	Referencia del servicio vinculado de Azure Key Vault.	LinkedServiceReference (obligatorio)
tipo	Tipo del secreto.	string (obligatorio)

Credencial

Nombre	Descripción	Valor
Anotaciones	Lista de etiquetas que se pueden usar para describir la credencial.	Cualquiera[]
descripción	Descripción de las credenciales.	cuerda
tipo	Establezca en "ManagedIdentity" para el tipo ManagedIdentityCredential. Establezca en "ServicePrincipal" para el tipo ServicePrincipalCredential.	'Identidad administrada' 'ServicePrincipal' (obligatorio)

LinkedServiceReference (Referencia de servicio)

Nombre	Descripción	Valor
Parámetros	Argumentos para LinkedService.	ParameterValueSpecification
referenceName	Haga referencia al nombre de LinkedService.	string (obligatorio)
tipo	Tipo de referencia de servicio vinculado.	'LinkedServiceReference' (obligatorio)

Credencial de Identidad Gestionada

Nombre	Descripción	Valor
tipo	Tipo de credencial.	'ManagedIdentity' (obligatorio)
typeProperties	Propiedades de credenciales de identidad administrada.	ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nombre	Descripción	Valor
identificador de recurso	Identificador de recurso de la identidad administrada asignada por el usuario	cuerda

ParameterValueSpecification

Nombre	Descripción	Valor

ServicePrincipalCredential

Nombre	Descripción	Valor
tipo	Tipo de credencial.	'ServicePrincipal' (obligatorio)
typeProperties	Propiedades de credenciales de entidad de servicio.	ServicePrincipalCredentialTypeProperties (obligatorio)

ServicePrincipalCredentialTypeProperties

Nombre	Descripción	Valor
servicePrincipalId	El identificador de aplicación de la entidad de servicio que se usa para autenticarse	cualquier
servicePrincipalKey	Clave de la entidad de servicio que se usa para autenticarse.	AzureKeyVaultSecretReference
arrendatario	Identificador del inquilino al que pertenece la entidad de servicio.	cualquier

Definición de recursos de plantilla de ARM

El tipo de recurso factorys/credentials se puede implementar con operaciones que tienen como destino:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DataFactory/factorys/credentials, agregue el siguiente JSON a la plantilla.

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

Objetos de credenciales

Establezca el tipo propiedad para especificar el tipo de objeto.

Para managedIdentity, use:

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

Para ServicePrincipal, use:

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

Valores de propiedad

Microsoft.DataFactory/factorys/credentials

Nombre	Descripción	Valor
apiVersion	La versión de api	'2018-06-01'
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 127 Patrón = `^([_A-Za-z0-9]\|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$` (obligatorio)
Propiedades	Propiedades de las credenciales.	de credenciales (obligatorio)
tipo	El tipo de recurso	"Microsoft.DataFactory/factorys/credentials"

AzureKeyVaultSecretReference

Nombre	Descripción	Valor
nombreSecreto	Nombre del secreto en Azure Key Vault. Tipo: cadena (o Expresión con cadena resultType).	any (obligatorio)
secretVersion	Versión del secreto en Azure Key Vault. El valor predeterminado es la versión más reciente del secreto. Tipo: cadena (o Expresión con cadena resultType).	cualquier
tienda	Referencia del servicio vinculado de Azure Key Vault.	LinkedServiceReference (obligatorio)
tipo	Tipo del secreto.	string (obligatorio)

Credencial

Nombre	Descripción	Valor
Anotaciones	Lista de etiquetas que se pueden usar para describir la credencial.	Cualquiera[]
descripción	Descripción de las credenciales.	cuerda
tipo	Establezca en "ManagedIdentity" para el tipo ManagedIdentityCredential. Establezca en "ServicePrincipal" para el tipo ServicePrincipalCredential.	'Identidad administrada' 'ServicePrincipal' (obligatorio)

LinkedServiceReference (Referencia de servicio)

Nombre	Descripción	Valor
Parámetros	Argumentos para LinkedService.	ParameterValueSpecification
referenceName	Haga referencia al nombre de LinkedService.	string (obligatorio)
tipo	Tipo de referencia de servicio vinculado.	'LinkedServiceReference' (obligatorio)

Credencial de Identidad Gestionada

Nombre	Descripción	Valor
tipo	Tipo de credencial.	'ManagedIdentity' (obligatorio)
typeProperties	Propiedades de credenciales de identidad administrada.	ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nombre	Descripción	Valor
identificador de recurso	Identificador de recurso de la identidad administrada asignada por el usuario	cuerda

ParameterValueSpecification

Nombre	Descripción	Valor

ServicePrincipalCredential

Nombre	Descripción	Valor
tipo	Tipo de credencial.	'ServicePrincipal' (obligatorio)
typeProperties	Propiedades de credenciales de entidad de servicio.	ServicePrincipalCredentialTypeProperties (obligatorio)

ServicePrincipalCredentialTypeProperties

Nombre	Descripción	Valor
servicePrincipalId	El identificador de aplicación de la entidad de servicio que se usa para autenticarse	cualquier
servicePrincipalKey	Clave de la entidad de servicio que se usa para autenticarse.	AzureKeyVaultSecretReference
arrendatario	Identificador del inquilino al que pertenece la entidad de servicio.	cualquier

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso factorys/credentials se puede implementar con operaciones que tienen como destino:

grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DataFactory/factorys/credentials, agregue el siguiente terraform a la plantilla.

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

Objetos de credenciales

Establezca el tipo propiedad para especificar el tipo de objeto.

Para managedIdentity, use:

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

Para ServicePrincipal, use:

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

Valores de propiedad

Microsoft.DataFactory/factorys/credentials

Nombre	Descripción	Valor
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 127 Patrón = `^([_A-Za-z0-9]\|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$` (obligatorio)
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: factorías de
Propiedades	Propiedades de las credenciales.	de credenciales (obligatorio)
tipo	El tipo de recurso	"Microsoft.DataFactory/factorys/credentials@2018-06-01"

AzureKeyVaultSecretReference

Nombre	Descripción	Valor
nombreSecreto	Nombre del secreto en Azure Key Vault. Tipo: cadena (o Expresión con cadena resultType).	any (obligatorio)
secretVersion	Versión del secreto en Azure Key Vault. El valor predeterminado es la versión más reciente del secreto. Tipo: cadena (o Expresión con cadena resultType).	cualquier
tienda	Referencia del servicio vinculado de Azure Key Vault.	LinkedServiceReference (obligatorio)
tipo	Tipo del secreto.	string (obligatorio)

Credencial

Nombre	Descripción	Valor
Anotaciones	Lista de etiquetas que se pueden usar para describir la credencial.	Cualquiera[]
descripción	Descripción de las credenciales.	cuerda
tipo	Establezca en "ManagedIdentity" para el tipo ManagedIdentityCredential. Establezca en "ServicePrincipal" para el tipo ServicePrincipalCredential.	'Identidad administrada' 'ServicePrincipal' (obligatorio)

LinkedServiceReference (Referencia de servicio)

Nombre	Descripción	Valor
Parámetros	Argumentos para LinkedService.	ParameterValueSpecification
referenceName	Haga referencia al nombre de LinkedService.	string (obligatorio)
tipo	Tipo de referencia de servicio vinculado.	'LinkedServiceReference' (obligatorio)

Credencial de Identidad Gestionada

Nombre	Descripción	Valor
tipo	Tipo de credencial.	'ManagedIdentity' (obligatorio)
typeProperties	Propiedades de credenciales de identidad administrada.	ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nombre	Descripción	Valor
identificador de recurso	Identificador de recurso de la identidad administrada asignada por el usuario	cuerda

ParameterValueSpecification

Nombre	Descripción	Valor

ServicePrincipalCredential

Nombre	Descripción	Valor
tipo	Tipo de credencial.	'ServicePrincipal' (obligatorio)
typeProperties	Propiedades de credenciales de entidad de servicio.	ServicePrincipalCredentialTypeProperties (obligatorio)

ServicePrincipalCredentialTypeProperties

Nombre	Descripción	Valor
servicePrincipalId	El identificador de aplicación de la entidad de servicio que se usa para autenticarse	cualquier
servicePrincipalKey	Clave de la entidad de servicio que se usa para autenticarse.	AzureKeyVaultSecretReference
arrendatario	Identificador del inquilino al que pertenece la entidad de servicio.	cualquier

Compartir a través de

Factorías/credenciales de Microsoft.DataFactory 2018-06-01

Definición de recursos de Bicep

Formato de recurso

Objetos de credenciales

Valores de propiedad

Microsoft.DataFactory/factorys/credentials

AzureKeyVaultSecretReference

Credencial

LinkedServiceReference (Referencia de servicio)

Credencial de Identidad Gestionada

ManagedIdentityTypeProperties

ParameterValueSpecification

ServicePrincipalCredential

ServicePrincipalCredentialTypeProperties

Definición de recursos de plantilla de ARM

Formato de recurso

Objetos de credenciales

Valores de propiedad

Microsoft.DataFactory/factorys/credentials

AzureKeyVaultSecretReference

Credencial

LinkedServiceReference (Referencia de servicio)

Credencial de Identidad Gestionada

ManagedIdentityTypeProperties

ParameterValueSpecification

ServicePrincipalCredential

ServicePrincipalCredentialTypeProperties

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Objetos de credenciales

Valores de propiedad

Microsoft.DataFactory/factorys/credentials

AzureKeyVaultSecretReference

Credencial

LinkedServiceReference (Referencia de servicio)

Credencial de Identidad Gestionada

ManagedIdentityTypeProperties

ParameterValueSpecification

ServicePrincipalCredential

ServicePrincipalCredentialTypeProperties

Comentarios

Recursos adicionales