次の方法で共有


Microsoft.DataFactory ファクトリ/資格情報 2018-06-01

Bicep リソース定義

factories/credentials リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DataFactory/factories/credentials リソースを作成するには、次の Bicep をテンプレートに追加します。

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
  }
}

資格情報オブジェクト

プロパティを設定して、オブジェクトの型を指定します。

ManagedIdentityの場合は、次の値を使用します。

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

ServicePrincipalを する場合は、次を使用します。

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

プロパティ値

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 では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。
種類のリソースのシンボリック名: ファクトリ
プロパティ 資格情報のプロパティ。 資格情報の (必須)

AzureKeyVaultSecretReference

名前 形容 価値
シークレット名 Azure Key Vault 内のシークレットの名前。 型: string (または resultType 文字列を含む式)。 any (必須)
秘密バージョン Azure Key Vault のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 型: string (または resultType 文字列を含む式)。 任意
Azure Key Vault のリンクされたサービス リファレンス。 LinkedServiceReference (必須)
種類 シークレットの種類。 string (必須)

資格 情報

名前 形容 価値
注釈 資格情報の説明に使用できるタグの一覧。 どれでも[]
形容 資格情報の説明。
種類 ManagedIdentityCredentialの型 'ManagedIdentity' に設定します。 ServicePrincipalCredential'ServicePrincipal' に設定します。 「ManagedIdentity」
'ServicePrincipal' (必須)

LinkedServiceReference (リンク サービス参照)

名前 形容 価値
パラメーター LinkedService の引数。 ParameterValueSpecification の
referenceName(リファレンスネーム) LinkedService 名を参照します。 string (必須)
種類 リンクされたサービス参照の種類。 'LinkedServiceReference' (必須)

ManagedIdentityCredential の

名前 形容 価値
種類 資格情報の種類。 'ManagedIdentity' (必須)
タイププロパティ マネージド ID 資格情報のプロパティ。 ManagedIdentityTypeProperties の

ManagedIdentityTypeプロパティ

名前 形容 価値
リソースID ユーザー割り当てマネージド ID のリソース ID

パラメータ値仕様

名前 形容 価値

サービスプリンシパル資格情報

名前 形容 価値
種類 資格情報の種類。 'ServicePrincipal' (必須)
タイププロパティ サービス プリンシパルの資格情報のプロパティ。 ServicePrincipalCredentialTypeProperties (必須)

ServicePrincipalCredentialTypeProperties の

名前 形容 価値
サービスプリンシパルID (servicePrincipalId) 認証に使用されるサービス プリンシパルのアプリ ID 任意
servicePrincipalKey(サービスプリンシパルキー) 認証に使用されるサービス プリンシパルのキー。 AzureKeyVaultSecretReference
テナント サービス プリンシパルが属しているテナントの ID 任意

ARM テンプレート リソース定義

factories/credentials リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 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": {}
  }
}

プロパティ値

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'

AzureKeyVaultSecretReference

名前 形容 価値
シークレット名 Azure Key Vault 内のシークレットの名前。 型: string (または resultType 文字列を含む式)。 any (必須)
秘密バージョン Azure Key Vault のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 型: string (または resultType 文字列を含む式)。 任意
Azure Key Vault のリンクされたサービス リファレンス。 LinkedServiceReference (必須)
種類 シークレットの種類。 string (必須)

資格 情報

名前 形容 価値
注釈 資格情報の説明に使用できるタグの一覧。 どれでも[]
形容 資格情報の説明。
種類 ManagedIdentityCredentialの型 'ManagedIdentity' に設定します。 ServicePrincipalCredential'ServicePrincipal' に設定します。 「ManagedIdentity」
'ServicePrincipal' (必須)

LinkedServiceReference (リンク サービス参照)

名前 形容 価値
パラメーター LinkedService の引数。 ParameterValueSpecification の
referenceName(リファレンスネーム) LinkedService 名を参照します。 string (必須)
種類 リンクされたサービス参照の種類。 'LinkedServiceReference' (必須)

ManagedIdentityCredential の

名前 形容 価値
種類 資格情報の種類。 'ManagedIdentity' (必須)
タイププロパティ マネージド ID 資格情報のプロパティ。 ManagedIdentityTypeProperties の

ManagedIdentityTypeプロパティ

名前 形容 価値
リソースID ユーザー割り当てマネージド ID のリソース ID

パラメータ値仕様

名前 形容 価値

サービスプリンシパル資格情報

名前 形容 価値
種類 資格情報の種類。 'ServicePrincipal' (必須)
タイププロパティ サービス プリンシパルの資格情報のプロパティ。 ServicePrincipalCredentialTypeProperties (必須)

ServicePrincipalCredentialTypeProperties の

名前 形容 価値
サービスプリンシパルID (servicePrincipalId) 認証に使用されるサービス プリンシパルのアプリ ID 任意
servicePrincipalKey(サービスプリンシパルキー) 認証に使用されるサービス プリンシパルのキー。 AzureKeyVaultSecretReference
テナント サービス プリンシパルが属しているテナントの ID 任意

使用例

Terraform (AzAPI プロバイダー) リソース定義

factories/credentials リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DataFactory/factories/credentials リソースを作成するには、次の Terraform をテンプレートに追加します。

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
    }
  }
}

資格情報オブジェクト

プロパティを設定して、オブジェクトの型を指定します。

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 = ?
  }
}

プロパティ値

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」

AzureKeyVaultSecretReference

名前 形容 価値
シークレット名 Azure Key Vault 内のシークレットの名前。 型: string (または resultType 文字列を含む式)。 any (必須)
秘密バージョン Azure Key Vault のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 型: string (または resultType 文字列を含む式)。 任意
Azure Key Vault のリンクされたサービス リファレンス。 LinkedServiceReference (必須)
種類 シークレットの種類。 string (必須)

資格 情報

名前 形容 価値
注釈 資格情報の説明に使用できるタグの一覧。 どれでも[]
形容 資格情報の説明。
種類 ManagedIdentityCredentialの型 'ManagedIdentity' に設定します。 ServicePrincipalCredential'ServicePrincipal' に設定します。 「ManagedIdentity」
'ServicePrincipal' (必須)

LinkedServiceReference (リンク サービス参照)

名前 形容 価値
パラメーター LinkedService の引数。 ParameterValueSpecification の
referenceName(リファレンスネーム) LinkedService 名を参照します。 string (必須)
種類 リンクされたサービス参照の種類。 'LinkedServiceReference' (必須)

ManagedIdentityCredential の

名前 形容 価値
種類 資格情報の種類。 'ManagedIdentity' (必須)
タイププロパティ マネージド ID 資格情報のプロパティ。 ManagedIdentityTypeProperties の

ManagedIdentityTypeプロパティ

名前 形容 価値
リソースID ユーザー割り当てマネージド ID のリソース ID

パラメータ値仕様

名前 形容 価値

サービスプリンシパル資格情報

名前 形容 価値
種類 資格情報の種類。 'ServicePrincipal' (必須)
タイププロパティ サービス プリンシパルの資格情報のプロパティ。 ServicePrincipalCredentialTypeProperties (必須)

ServicePrincipalCredentialTypeProperties の

名前 形容 価値
サービスプリンシパルID (servicePrincipalId) 認証に使用されるサービス プリンシパルのアプリ ID 任意
servicePrincipalKey(サービスプリンシパルキー) 認証に使用されるサービス プリンシパルのキー。 AzureKeyVaultSecretReference
テナント サービス プリンシパルが属しているテナントの ID 任意