你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DataFactory 工厂/凭据 2018-06-01
Bicep 资源定义
工厂/凭据资源类型可以使用目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DataFactory/factories/credentials 资源，请将以下 Bicep 添加到模板。
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
}
}
凭据对象
设置 类型 属性以指定对象的类型。
对于 ManagedIdentity，请使用：
{
type: 'ManagedIdentity'
typeProperties: {
resourceId: 'string'
}
}
对于 ServicePrincipal，请使用：
{
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)
}
}
属性值
AzureKeyVaultSecretReference
| 名字 | 描述 | 价值 |
|---|---|---|
| secretName | Azure Key Vault 中机密的名称。 类型：字符串（或带有 resultType 字符串的表达式）。 | 任何（必需） |
| secretVersion | Azure Key Vault 中的机密版本。 默认值为最新版本的机密。 类型：字符串（或带有 resultType 字符串的表达式）。 | 任何 |
| 商店 | Azure Key Vault 链接服务参考。 | LinkedServiceReference（必需） |
| 类型 | 机密的类型。 | string （必需） |
凭据
| 名字 | 描述 | 价值 |
|---|---|---|
| 附注 | 可用于描述凭据的标记列表。 | any[] |
| 描述 | 凭据说明。 | 字符串 |
| 类型 | 对于 type ManagedIdentityCredential，设置为“ManagedIdentity”。 对于 type ServicePrincipalCredential，设置为“ServicePrincipal”。 | “ManagedIdentity” “ServicePrincipal”（必需） |
LinkedServiceReference
| 名字 | 描述 | 价值 |
|---|---|---|
| 参数 | LinkedService 的参数。 | ParameterValueSpecification |
| referenceName | 引用 LinkedService 名称。 | string （必需） |
| 类型 | 链接服务引用类型。 | “LinkedServiceReference”（必需） |
ManagedIdentityCredential
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 凭据的类型。 | “ManagedIdentity”（必需） |
| typeProperties | 托管标识凭据属性。 | ManagedIdentityTypeProperties |
ManagedIdentityTypeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 用户分配的托管标识的资源 ID | 字符串 |
Microsoft.DataFactory/factories/credentials
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 127 模式 = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ （必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：工厂 |
| 性能 | 凭据的属性。 | 凭据（必需） |
ParameterValueSpecification
| 名字 | 描述 | 价值 |
|---|
ServicePrincipalCredential
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 凭据的类型。 | “ServicePrincipal”（必需） |
| typeProperties | 服务主体凭据属性。 | ServicePrincipalCredentialTypeProperties （必需） |
ServicePrincipalCredentialTypeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| servicePrincipalId | 用于进行身份验证的服务主体的应用 ID | 任何 |
| servicePrincipalKey | 用于进行身份验证的服务主体的密钥。 | AzureKeyVaultSecretReference |
| 房客 | 服务主体所属的租户的 ID | 任何 |
ARM 模板资源定义
工厂/凭据资源类型可以使用目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DataFactory/factories/credentials 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DataFactory/factories/credentials",
"apiVersion": "2018-06-01",
"name": "string",
"properties": {
"annotations": [ {} ],
"description": "string",
"type": "string"
// For remaining properties, see Credential objects
}
}
凭据对象
设置 类型 属性以指定对象的类型。
对于 ManagedIdentity，请使用：
{
"type": "ManagedIdentity",
"typeProperties": {
"resourceId": "string"
}
}
对于 ServicePrincipal，请使用：
{
"type": "ServicePrincipal",
"typeProperties": {
"servicePrincipalId": {},
"servicePrincipalKey": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"tenant": {}
}
}
属性值
AzureKeyVaultSecretReference
| 名字 | 描述 | 价值 |
|---|---|---|
| secretName | Azure Key Vault 中机密的名称。 类型：字符串（或带有 resultType 字符串的表达式）。 | 任何（必需） |
| secretVersion | Azure Key Vault 中的机密版本。 默认值为最新版本的机密。 类型：字符串（或带有 resultType 字符串的表达式）。 | 任何 |
| 商店 | Azure Key Vault 链接服务参考。 | LinkedServiceReference（必需） |
| 类型 | 机密的类型。 | string （必需） |
凭据
| 名字 | 描述 | 价值 |
|---|---|---|
| 附注 | 可用于描述凭据的标记列表。 | any[] |
| 描述 | 凭据说明。 | 字符串 |
| 类型 | 对于 type ManagedIdentityCredential，设置为“ManagedIdentity”。 对于 type ServicePrincipalCredential，设置为“ServicePrincipal”。 | “ManagedIdentity” “ServicePrincipal”（必需） |
LinkedServiceReference
| 名字 | 描述 | 价值 |
|---|---|---|
| 参数 | LinkedService 的参数。 | ParameterValueSpecification |
| referenceName | 引用 LinkedService 名称。 | string （必需） |
| 类型 | 链接服务引用类型。 | “LinkedServiceReference”（必需） |
ManagedIdentityCredential
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 凭据的类型。 | “ManagedIdentity”（必需） |
| typeProperties | 托管标识凭据属性。 | ManagedIdentityTypeProperties |
ManagedIdentityTypeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 用户分配的托管标识的资源 ID | 字符串 |
Microsoft.DataFactory/factories/credentials
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-06-01' |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 127 模式 = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ （必需） |
| 性能 | 凭据的属性。 | 凭据（必需） |
| 类型 | 资源类型 | “Microsoft.DataFactory/factories/credentials” |
ParameterValueSpecification
| 名字 | 描述 | 价值 |
|---|
ServicePrincipalCredential
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 凭据的类型。 | “ServicePrincipal”（必需） |
| typeProperties | 服务主体凭据属性。 | ServicePrincipalCredentialTypeProperties （必需） |
ServicePrincipalCredentialTypeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| servicePrincipalId | 用于进行身份验证的服务主体的应用 ID | 任何 |
| servicePrincipalKey | 用于进行身份验证的服务主体的密钥。 | AzureKeyVaultSecretReference |
| 房客 | 服务主体所属的租户的 ID | 任何 |
Terraform （AzAPI 提供程序）资源定义
工厂/凭据资源类型可以使用目标操作进行部署：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DataFactory/factories/credentials 资源，请将以下 Terraform 添加到模板。
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
}
})
}
凭据对象
设置 类型 属性以指定对象的类型。
对于 ManagedIdentity，请使用：
{
type = "ManagedIdentity"
typeProperties = {
resourceId = "string"
}
}
对于 ServicePrincipal，请使用：
{
type = "ServicePrincipal"
typeProperties = {
servicePrincipalId = ?
servicePrincipalKey = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
tenant = ?
}
}
属性值
AzureKeyVaultSecretReference
| 名字 | 描述 | 价值 |
|---|---|---|
| secretName | Azure Key Vault 中机密的名称。 类型：字符串（或带有 resultType 字符串的表达式）。 | 任何（必需） |
| secretVersion | Azure Key Vault 中的机密版本。 默认值为最新版本的机密。 类型：字符串（或带有 resultType 字符串的表达式）。 | 任何 |
| 商店 | Azure Key Vault 链接服务参考。 | LinkedServiceReference（必需） |
| 类型 | 机密的类型。 | string （必需） |
凭据
| 名字 | 描述 | 价值 |
|---|---|---|
| 附注 | 可用于描述凭据的标记列表。 | any[] |
| 描述 | 凭据说明。 | 字符串 |
| 类型 | 对于 type ManagedIdentityCredential，设置为“ManagedIdentity”。 对于 type ServicePrincipalCredential，设置为“ServicePrincipal”。 | “ManagedIdentity” “ServicePrincipal”（必需） |
LinkedServiceReference
| 名字 | 描述 | 价值 |
|---|---|---|
| 参数 | LinkedService 的参数。 | ParameterValueSpecification |
| referenceName | 引用 LinkedService 名称。 | string （必需） |
| 类型 | 链接服务引用类型。 | “LinkedServiceReference”（必需） |
ManagedIdentityCredential
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 凭据的类型。 | “ManagedIdentity”（必需） |
| typeProperties | 托管标识凭据属性。 | ManagedIdentityTypeProperties |
ManagedIdentityTypeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 用户分配的托管标识的资源 ID | 字符串 |
Microsoft.DataFactory/factories/credentials
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 127 模式 = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：工厂 |
| 性能 | 凭据的属性。 | 凭据（必需） |
| 类型 | 资源类型 | “Microsoft.DataFactory/factories/credentials@2018-06-01” |
ParameterValueSpecification
| 名字 | 描述 | 价值 |
|---|
ServicePrincipalCredential
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 凭据的类型。 | “ServicePrincipal”（必需） |
| typeProperties | 服务主体凭据属性。 | ServicePrincipalCredentialTypeProperties （必需） |
ServicePrincipalCredentialTypeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| servicePrincipalId | 用于进行身份验证的服务主体的应用 ID | 任何 |
| servicePrincipalKey | 用于进行身份验证的服务主体的密钥。 | AzureKeyVaultSecretReference |
| 房客 | 服务主体所属的租户的 ID | 任何 |