Compartir a través de


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

Definición de recursos de Bicep

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

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(Azure.Bicep.Types.Concrete.AnyType)
    ]
    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(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)
  }
}

Valores de propiedad

AzureKeyVaultSecretReference

Nombre Descripción Valor
secretName 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. any[]
descripción Descripción de las credenciales. cuerda
tipo Establezca en "ManagedIdentity" para el tipo ManagedIdentityCredential. Establezca en "ServicePrincipal" para el tipo ServicePrincipalCredential. 'ManagedIdentity'
'ServicePrincipal' (obligatorio)

LinkedServiceReference

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)

ManagedIdentityCredential

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

ManagedIdentityTypeProperties

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

Microsoft.DataFactory/factorys/credentials

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
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)

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:

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

AzureKeyVaultSecretReference

Nombre Descripción Valor
secretName 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. any[]
descripción Descripción de las credenciales. cuerda
tipo Establezca en "ManagedIdentity" para el tipo ManagedIdentityCredential. Establezca en "ServicePrincipal" para el tipo ServicePrincipalCredential. 'ManagedIdentity'
'ServicePrincipal' (obligatorio)

LinkedServiceReference

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)

ManagedIdentityCredential

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

ManagedIdentityTypeProperties

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

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 = 1
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"

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 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"
  body = jsonencode({
    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

AzureKeyVaultSecretReference

Nombre Descripción Valor
secretName 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. any[]
descripción Descripción de las credenciales. cuerda
tipo Establezca en "ManagedIdentity" para el tipo ManagedIdentityCredential. Establezca en "ServicePrincipal" para el tipo ServicePrincipalCredential. 'ManagedIdentity'
'ServicePrincipal' (obligatorio)

LinkedServiceReference

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)

ManagedIdentityCredential

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

ManagedIdentityTypeProperties

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

Microsoft.DataFactory/factorys/credentials

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
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"

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