Microsoft.DataFactory factoryies/credentials 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 中的秘密名稱。 Type：string （或 expression with resultType string） 。 | 任何 （必要） |
| secretVersion | Azure Key Vault 中的秘密版本。 預設值是最新版本的秘密。 Type：string （或 expression with resultType string） 。 | 任何 |
| 商店 | Azure Key Vault 鏈接服務參考。 | LinkedServiceReference （必要） |
| 類型 | 秘密的類型。 | 字串 （必要） |
憑據
| 名字 | 描述 | 價值 |
|---|---|---|
| 附註 | 可用於描述認證的標記清單。 | any[] |
| 描述 | 認證描述。 | 字串 |
| 類型 | 針對 ManagedIdentity ManagedIdentityCredential 類型設定為 'ManagedIdentity'，。 針對 servicePrincipalcredential 類型 設定為 'ServicePrincipal'，。 | 'ManagedIdentity' 'ServicePrincipal' （必要） |
LinkedServiceReference
| 名字 | 描述 | 價值 |
|---|---|---|
| 參數 | LinkedService 的自變數。 | ParameterValueSpecification |
| referenceName | 參考 LinkedService 名稱。 | 字串 （必要） |
| 類型 | 連結服務參考類型。 | 'LinkedServiceReference' （必要） |
ManagedIdentityCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 認證類型。 | 'ManagedIdentity' （必要） |
| typeProperties | 受控識別認證屬性。 | ManagedIdentityTypeProperties |
ManagedIdentityTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| resourceId | 使用者指派受控識別的資源標識碼 | 字串 |
Microsoft.DataFactory/factories/credentials
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^([_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 | 用來驗證之服務主體的應用程式識別碼 | 任何 |
| servicePrincipalKey | 用來驗證的服務主體金鑰。 | AzureKeyVaultSecretReference |
| 房客 | 服務主體所屬租用戶的標識碼 | 任何 |
ARM 樣本資源定義
工廠/認證資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DataFactory/factoryies/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 中的秘密名稱。 Type：string （或 expression with resultType string） 。 | 任何 （必要） |
| secretVersion | Azure Key Vault 中的秘密版本。 預設值是最新版本的秘密。 Type：string （或 expression with resultType string） 。 | 任何 |
| 商店 | Azure Key Vault 鏈接服務參考。 | LinkedServiceReference （必要） |
| 類型 | 秘密的類型。 | 字串 （必要） |
憑據
| 名字 | 描述 | 價值 |
|---|---|---|
| 附註 | 可用於描述認證的標記清單。 | any[] |
| 描述 | 認證描述。 | 字串 |
| 類型 | 針對 ManagedIdentity ManagedIdentityCredential 類型設定為 'ManagedIdentity'，。 針對 servicePrincipalcredential 類型 設定為 'ServicePrincipal'，。 | 'ManagedIdentity' 'ServicePrincipal' （必要） |
LinkedServiceReference
| 名字 | 描述 | 價值 |
|---|---|---|
| 參數 | LinkedService 的自變數。 | ParameterValueSpecification |
| referenceName | 參考 LinkedService 名稱。 | 字串 （必要） |
| 類型 | 連結服務參考類型。 | 'LinkedServiceReference' （必要） |
ManagedIdentityCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 認證類型。 | 'ManagedIdentity' （必要） |
| typeProperties | 受控識別認證屬性。 | ManagedIdentityTypeProperties |
ManagedIdentityTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| resourceId | 使用者指派受控識別的資源標識碼 | 字串 |
Microsoft.DataFactory/factories/credentials
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2018-06-01' |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^([_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 | 用來驗證之服務主體的應用程式識別碼 | 任何 |
| servicePrincipalKey | 用來驗證的服務主體金鑰。 | AzureKeyVaultSecretReference |
| 房客 | 服務主體所屬租用戶的標識碼 | 任何 |
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 中的秘密名稱。 Type：string （或 expression with resultType string） 。 | 任何 （必要） |
| secretVersion | Azure Key Vault 中的秘密版本。 預設值是最新版本的秘密。 Type：string （或 expression with resultType string） 。 | 任何 |
| 商店 | Azure Key Vault 鏈接服務參考。 | LinkedServiceReference （必要） |
| 類型 | 秘密的類型。 | 字串 （必要） |
憑據
| 名字 | 描述 | 價值 |
|---|---|---|
| 附註 | 可用於描述認證的標記清單。 | any[] |
| 描述 | 認證描述。 | 字串 |
| 類型 | 針對 ManagedIdentity ManagedIdentityCredential 類型設定為 'ManagedIdentity'，。 針對 servicePrincipalcredential 類型 設定為 'ServicePrincipal'，。 | 'ManagedIdentity' 'ServicePrincipal' （必要） |
LinkedServiceReference
| 名字 | 描述 | 價值 |
|---|---|---|
| 參數 | LinkedService 的自變數。 | ParameterValueSpecification |
| referenceName | 參考 LinkedService 名稱。 | 字串 （必要） |
| 類型 | 連結服務參考類型。 | 'LinkedServiceReference' （必要） |
ManagedIdentityCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 認證類型。 | 'ManagedIdentity' （必要） |
| typeProperties | 受控識別認證屬性。 | ManagedIdentityTypeProperties |
ManagedIdentityTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| resourceId | 使用者指派受控識別的資源標識碼 | 字串 |
Microsoft.DataFactory/factories/credentials
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：處理站 |
| 性能 | 認證的屬性。 | 認證 （必要） |
| 類型 | 資源類型 | “Microsoft.DataFactory/factories/credentials@2018-06-01” |
ParameterValueSpecification
| 名字 | 描述 | 價值 |
|---|
ServicePrincipalCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 認證類型。 | 'ServicePrincipal' （必要） |
| typeProperties | 服務主體認證屬性。 | ServicePrincipalCredentialTypeProperties （必要） |
ServicePrincipalCredentialTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| servicePrincipalId | 用來驗證之服務主體的應用程式識別碼 | 任何 |
| servicePrincipalKey | 用來驗證的服務主體金鑰。 | AzureKeyVaultSecretReference |
| 房客 | 服務主體所屬租用戶的標識碼 | 任何 |