Udostępnij za pośrednictwem

Microsoft.DataFactory factory/credentials 2018-06-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu fabryk/poświadczeń można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DataFactory/factory/credentials, dodaj następujący kod Bicep do szablonu.

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

Obiekty poświadczeń

Ustaw właściwość , aby określić typ obiektu.

W przypadku ManagedIdentityużyj:

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

W przypadku ServicePrincipalużyj:

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

Wartości właściwości

AzureKeyVaultSecretReference

Nazwa Opis Wartość
secretName Nazwa wpisu tajnego w usłudze Azure Key Vault. Typ: ciąg (lub wyrażenie z ciągiem resultType). dowolna (wymagana)
secretVersion Wersja wpisu tajnego w usłudze Azure Key Vault. Wartość domyślna to najnowsza wersja wpisu tajnego. Typ: ciąg (lub wyrażenie z ciągiem resultType). jakikolwiek
sklep Dokumentacja połączonej usługi Azure Key Vault. LinkedServiceReference (wymagane)
typ Typ wpisu tajnego. ciąg (wymagany)

Poświadczeń

Nazwa Opis Wartość
Adnotacje Lista tagów, których można użyć do opisywania poświadczeń. any[]
opis Opis poświadczeń. struna
typ Ustaw wartość "ManagedIdentity" dla typu ManagedIdentityCredential. Ustaw wartość "ServicePrincipal" dla typu ServicePrincipalCredential. "ManagedIdentity"
"ServicePrincipal" (wymagane)

LinkedServiceReference

Nazwa Opis Wartość
Parametry Argumenty dla usługi LinkedService. ParameterValueSpecification
referenceName Odwołaj się do nazwy połączonej usługi. ciąg (wymagany)
typ Typ odwołania połączonej usługi. "LinkedServiceReference" (wymagane)

ManagedIdentityCredential

Nazwa Opis Wartość
typ Typ poświadczeń. "ManagedIdentity" (wymagane)
typeProperties Właściwości poświadczeń tożsamości zarządzanej. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nazwa Opis Wartość
resourceId Identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika struna

Microsoft.DataFactory/factory/credentials

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 127
Wzorzec = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (wymagane)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: fabryki
Właściwości Właściwości poświadczeń. poświadczeń (wymagane)

ParametrValueSpecification

Nazwa Opis Wartość

ServicePrincipalCredential

Nazwa Opis Wartość
typ Typ poświadczeń. "ServicePrincipal" (wymagane)
typeProperties Właściwości poświadczeń jednostki usługi. ServicePrincipalCredentialTypeProperties (wymagane)

ServicePrincipalCredentialTypeProperties

Nazwa Opis Wartość
servicePrincipalId Identyfikator aplikacji jednostki usługi używanej do uwierzytelniania jakikolwiek
servicePrincipalKey Klucz jednostki usługi używanej do uwierzytelniania. AzureKeyVaultSecretReference
dzierżawca Identyfikator dzierżawy, do której należy jednostka usługi jakikolwiek

Definicja zasobu szablonu usługi ARM

Typ zasobu fabryk/poświadczeń można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DataFactory/factory/credentials, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DataFactory/factories/credentials",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "annotations": [ {} ],
    "description": "string",
    "type": "string"
    // For remaining properties, see Credential objects
  }
}

Obiekty poświadczeń

Ustaw właściwość , aby określić typ obiektu.

W przypadku ManagedIdentityużyj:

{
  "type": "ManagedIdentity",
  "typeProperties": {
    "resourceId": "string"
  }
}

W przypadku ServicePrincipalużyj:

{
  "type": "ServicePrincipal",
  "typeProperties": {
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "string"
      },
      "type": "string"
    },
    "tenant": {}
  }
}

Wartości właściwości

AzureKeyVaultSecretReference

Nazwa Opis Wartość
secretName Nazwa wpisu tajnego w usłudze Azure Key Vault. Typ: ciąg (lub wyrażenie z ciągiem resultType). dowolna (wymagana)
secretVersion Wersja wpisu tajnego w usłudze Azure Key Vault. Wartość domyślna to najnowsza wersja wpisu tajnego. Typ: ciąg (lub wyrażenie z ciągiem resultType). jakikolwiek
sklep Dokumentacja połączonej usługi Azure Key Vault. LinkedServiceReference (wymagane)
typ Typ wpisu tajnego. ciąg (wymagany)

Poświadczeń

Nazwa Opis Wartość
Adnotacje Lista tagów, których można użyć do opisywania poświadczeń. any[]
opis Opis poświadczeń. struna
typ Ustaw wartość "ManagedIdentity" dla typu ManagedIdentityCredential. Ustaw wartość "ServicePrincipal" dla typu ServicePrincipalCredential. "ManagedIdentity"
"ServicePrincipal" (wymagane)

LinkedServiceReference

Nazwa Opis Wartość
Parametry Argumenty dla usługi LinkedService. ParameterValueSpecification
referenceName Odwołaj się do nazwy połączonej usługi. ciąg (wymagany)
typ Typ odwołania połączonej usługi. "LinkedServiceReference" (wymagane)

ManagedIdentityCredential

Nazwa Opis Wartość
typ Typ poświadczeń. "ManagedIdentity" (wymagane)
typeProperties Właściwości poświadczeń tożsamości zarządzanej. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nazwa Opis Wartość
resourceId Identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika struna

Microsoft.DataFactory/factory/credentials

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2018-06-01'
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 127
Wzorzec = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (wymagane)
Właściwości Właściwości poświadczeń. poświadczeń (wymagane)
typ Typ zasobu "Microsoft.DataFactory/factory/credentials"

ParametrValueSpecification

Nazwa Opis Wartość

ServicePrincipalCredential

Nazwa Opis Wartość
typ Typ poświadczeń. "ServicePrincipal" (wymagane)
typeProperties Właściwości poświadczeń jednostki usługi. ServicePrincipalCredentialTypeProperties (wymagane)

ServicePrincipalCredentialTypeProperties

Nazwa Opis Wartość
servicePrincipalId Identyfikator aplikacji jednostki usługi używanej do uwierzytelniania jakikolwiek
servicePrincipalKey Klucz jednostki usługi używanej do uwierzytelniania. AzureKeyVaultSecretReference
dzierżawca Identyfikator dzierżawy, do której należy jednostka usługi jakikolwiek

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu fabryk/poświadczeń można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DataFactory/factory/credentials, dodaj następujący program Terraform do szablonu.

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

Obiekty poświadczeń

Ustaw właściwość , aby określić typ obiektu.

W przypadku ManagedIdentityużyj:

{
  type = "ManagedIdentity"
  typeProperties = {
    resourceId = "string"
  }
}

W przypadku ServicePrincipalużyj:

{
  type = "ServicePrincipal"
  typeProperties = {
    servicePrincipalId = ?
    servicePrincipalKey = {
      secretName = ?
      secretVersion = ?
      store = {
        parameters = {
          {customized property} = ?
        }
        referenceName = "string"
        type = "string"
      }
      type = "string"
    }
    tenant = ?
  }
}

Wartości właściwości

AzureKeyVaultSecretReference

Nazwa Opis Wartość
secretName Nazwa wpisu tajnego w usłudze Azure Key Vault. Typ: ciąg (lub wyrażenie z ciągiem resultType). dowolna (wymagana)
secretVersion Wersja wpisu tajnego w usłudze Azure Key Vault. Wartość domyślna to najnowsza wersja wpisu tajnego. Typ: ciąg (lub wyrażenie z ciągiem resultType). jakikolwiek
sklep Dokumentacja połączonej usługi Azure Key Vault. LinkedServiceReference (wymagane)
typ Typ wpisu tajnego. ciąg (wymagany)

Poświadczeń

Nazwa Opis Wartość
Adnotacje Lista tagów, których można użyć do opisywania poświadczeń. any[]
opis Opis poświadczeń. struna
typ Ustaw wartość "ManagedIdentity" dla typu ManagedIdentityCredential. Ustaw wartość "ServicePrincipal" dla typu ServicePrincipalCredential. "ManagedIdentity"
"ServicePrincipal" (wymagane)

LinkedServiceReference

Nazwa Opis Wartość
Parametry Argumenty dla usługi LinkedService. ParameterValueSpecification
referenceName Odwołaj się do nazwy połączonej usługi. ciąg (wymagany)
typ Typ odwołania połączonej usługi. "LinkedServiceReference" (wymagane)

ManagedIdentityCredential

Nazwa Opis Wartość
typ Typ poświadczeń. "ManagedIdentity" (wymagane)
typeProperties Właściwości poświadczeń tożsamości zarządzanej. ManagedIdentityTypeProperties

ManagedIdentityTypeProperties

Nazwa Opis Wartość
resourceId Identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika struna

Microsoft.DataFactory/factory/credentials

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 127
Wzorzec = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: fabryki
Właściwości Właściwości poświadczeń. poświadczeń (wymagane)
typ Typ zasobu "Microsoft.DataFactory/factory/credentials@2018-06-01"

ParametrValueSpecification

Nazwa Opis Wartość

ServicePrincipalCredential

Nazwa Opis Wartość
typ Typ poświadczeń. "ServicePrincipal" (wymagane)
typeProperties Właściwości poświadczeń jednostki usługi. ServicePrincipalCredentialTypeProperties (wymagane)

ServicePrincipalCredentialTypeProperties

Nazwa Opis Wartość
servicePrincipalId Identyfikator aplikacji jednostki usługi używanej do uwierzytelniania jakikolwiek
servicePrincipalKey Klucz jednostki usługi używanej do uwierzytelniania. AzureKeyVaultSecretReference
dzierżawca Identyfikator dzierżawy, do której należy jednostka usługi jakikolwiek