Compartilhar via


Microsoft.DataFactory factories/credentials 2018-06-01

Definição de recurso do Bicep

O tipo de recurso factories/credentials pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DataFactory/factories/credentials, adicione o Bicep a seguir ao seu modelo.

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 credencial

Defina a propriedade tipo para especificar o 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 propriedade

AzureKeyVaultSecretReference

Nome Descrição Valor
secretName O nome do segredo no Azure Key Vault. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType). any (obrigatório)
secretVersion A versão do segredo no Azure Key Vault. O valor padrão é a versão mais recente do segredo. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType). qualquer
loja A referência de serviço vinculado do Azure Key Vault. LinkedServiceReference (obrigatório)
tipo Tipo do segredo. cadeia de caracteres (obrigatório)

Credencial

Nome Descrição Valor
Anotações Lista de marcas que podem ser usadas para descrever a Credencial. any[]
descrição Descrição da credencial. corda
tipo Defina como 'ManagedIdentity' para o tipo ManagedIdentityCredential. Defina como 'ServicePrincipal' para o tipo ServicePrincipalCredential . 'ManagedIdentity'
'ServicePrincipal' (obrigatório)

LinkedServiceReference

Nome Descrição Valor
Parâmetros Argumentos para LinkedService. ParameterValueSpecification
referenceName Nome do LinkedService de referência. cadeia de caracteres (obrigatório)
tipo Tipo de referência de serviço vinculado. 'LinkedServiceReference' (obrigatório)

ManagedIdentityCredential

Nome Descrição Valor
tipo Tipo de credencial. 'ManagedIdentity' (obrigatório)
typeProperties Propriedades de credencial de identidade gerenciada. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nome Descrição Valor
resourceId A ID do recurso da identidade gerenciada atribuída pelo usuário corda

Microsoft.DataFactory/factories/credentials

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para o recurso do tipo: fábricas de
Propriedades Propriedades de credenciais. de Credencial (obrigatório)

ParameterValueSpecification

Nome Descrição Valor

ServicePrincipalCredential

Nome Descrição Valor
tipo Tipo de credencial. 'ServicePrincipal' (obrigatório)
typeProperties Propriedades de credencial da Entidade de Serviço. ServicePrincipalCredentialTypeProperties (obrigatório)

ServicePrincipalCredentialTypeProperties

Nome Descrição Valor
servicePrincipalId A ID do aplicativo da entidade de serviço usada para autenticar qualquer
servicePrincipalKey A chave da entidade de serviço usada para autenticar. AzureKeyVaultSecretReference
inquilino A ID do locatário ao qual a entidade de serviço pertence qualquer

Definição de recurso de modelo do ARM

O tipo de recurso factories/credentials pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DataFactory/factories/credentials, adicione o JSON a seguir ao modelo.

{
  "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 credencial

Defina a propriedade tipo para especificar o 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 propriedade

AzureKeyVaultSecretReference

Nome Descrição Valor
secretName O nome do segredo no Azure Key Vault. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType). any (obrigatório)
secretVersion A versão do segredo no Azure Key Vault. O valor padrão é a versão mais recente do segredo. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType). qualquer
loja A referência de serviço vinculado do Azure Key Vault. LinkedServiceReference (obrigatório)
tipo Tipo do segredo. cadeia de caracteres (obrigatório)

Credencial

Nome Descrição Valor
Anotações Lista de marcas que podem ser usadas para descrever a Credencial. any[]
descrição Descrição da credencial. corda
tipo Defina como 'ManagedIdentity' para o tipo ManagedIdentityCredential. Defina como 'ServicePrincipal' para o tipo ServicePrincipalCredential . 'ManagedIdentity'
'ServicePrincipal' (obrigatório)

LinkedServiceReference

Nome Descrição Valor
Parâmetros Argumentos para LinkedService. ParameterValueSpecification
referenceName Nome do LinkedService de referência. cadeia de caracteres (obrigatório)
tipo Tipo de referência de serviço vinculado. 'LinkedServiceReference' (obrigatório)

ManagedIdentityCredential

Nome Descrição Valor
tipo Tipo de credencial. 'ManagedIdentity' (obrigatório)
typeProperties Propriedades de credencial de identidade gerenciada. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nome Descrição Valor
resourceId A ID do recurso da identidade gerenciada atribuída pelo usuário corda

Microsoft.DataFactory/factories/credentials

Nome Descrição Valor
apiVersion A versão da API '2018-06-01'
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (obrigatório)
Propriedades Propriedades de credenciais. de Credencial (obrigatório)
tipo O tipo de recurso 'Microsoft.DataFactory/factories/credentials'

ParameterValueSpecification

Nome Descrição Valor

ServicePrincipalCredential

Nome Descrição Valor
tipo Tipo de credencial. 'ServicePrincipal' (obrigatório)
typeProperties Propriedades de credencial da Entidade de Serviço. ServicePrincipalCredentialTypeProperties (obrigatório)

ServicePrincipalCredentialTypeProperties

Nome Descrição Valor
servicePrincipalId A ID do aplicativo da entidade de serviço usada para autenticar qualquer
servicePrincipalKey A chave da entidade de serviço usada para autenticar. AzureKeyVaultSecretReference
inquilino A ID do locatário ao qual a entidade de serviço pertence qualquer

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso factories/credentials pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DataFactory/factories/credentials, adicione o Terraform a seguir ao seu modelo.

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 credencial

Defina a propriedade tipo para especificar o 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 propriedade

AzureKeyVaultSecretReference

Nome Descrição Valor
secretName O nome do segredo no Azure Key Vault. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType). any (obrigatório)
secretVersion A versão do segredo no Azure Key Vault. O valor padrão é a versão mais recente do segredo. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType). qualquer
loja A referência de serviço vinculado do Azure Key Vault. LinkedServiceReference (obrigatório)
tipo Tipo do segredo. cadeia de caracteres (obrigatório)

Credencial

Nome Descrição Valor
Anotações Lista de marcas que podem ser usadas para descrever a Credencial. any[]
descrição Descrição da credencial. corda
tipo Defina como 'ManagedIdentity' para o tipo ManagedIdentityCredential. Defina como 'ServicePrincipal' para o tipo ServicePrincipalCredential . 'ManagedIdentity'
'ServicePrincipal' (obrigatório)

LinkedServiceReference

Nome Descrição Valor
Parâmetros Argumentos para LinkedService. ParameterValueSpecification
referenceName Nome do LinkedService de referência. cadeia de caracteres (obrigatório)
tipo Tipo de referência de serviço vinculado. 'LinkedServiceReference' (obrigatório)

ManagedIdentityCredential

Nome Descrição Valor
tipo Tipo de credencial. 'ManagedIdentity' (obrigatório)
typeProperties Propriedades de credencial de identidade gerenciada. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nome Descrição Valor
resourceId A ID do recurso da identidade gerenciada atribuída pelo usuário corda

Microsoft.DataFactory/factories/credentials

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: fábricas
Propriedades Propriedades de credenciais. de Credencial (obrigatório)
tipo O tipo de recurso "Microsoft.DataFactory/factories/credentials@2018-06-01"

ParameterValueSpecification

Nome Descrição Valor

ServicePrincipalCredential

Nome Descrição Valor
tipo Tipo de credencial. 'ServicePrincipal' (obrigatório)
typeProperties Propriedades de credencial da Entidade de Serviço. ServicePrincipalCredentialTypeProperties (obrigatório)

ServicePrincipalCredentialTypeProperties

Nome Descrição Valor
servicePrincipalId A ID do aplicativo da entidade de serviço usada para autenticar qualquer
servicePrincipalKey A chave da entidade de serviço usada para autenticar. AzureKeyVaultSecretReference
inquilino A ID do locatário ao qual a entidade de serviço pertence qualquer