Partilhar via


Integration Runtimes - Create Or Update

Cria ou atualiza um runtime de integração.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}?api-version=2018-06-01

Parâmetros do URI

Name Em Necessário Tipo Description
factoryName
path True

string

O nome da fábrica.

Padrão Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

integrationRuntimeName
path True

string

O nome do runtime de integração.

Padrão Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

O nome do grupo de recursos.

Padrão Regex: ^[-\w\._\(\)]+$

subscriptionId
path True

string

O identificador da subscrição.

api-version
query True

string

A versão da API.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match

string

ETag da entidade de runtime de integração. Só deve ser especificado para atualização, para o qual deve corresponder à entidade existente ou pode ser * para atualização incondicional.

Corpo do Pedido

Name Necessário Tipo Description
properties True IntegrationRuntime:

Propriedades do runtime de integração.

Respostas

Name Tipo Description
200 OK

IntegrationRuntimeResource

OK.

Other Status Codes

CloudError

Uma resposta de erro recebida da operação put integration runtime.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

IntegrationRuntimes_Create

Pedido de amostra

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime?api-version=2018-06-01

{
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  }
}

Resposta da amostra

Date: Wed, 13 Jun 2018 22:20:47 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1197
x-ms-request-id: 125c07fa-e39a-4541-885f-5019631a5ecd
x-ms-correlation-request-id: 125c07fa-e39a-4541-885f-5019631a5ecd
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime",
  "name": "exampleIntegrationRuntime",
  "type": "Microsoft.DataFactory/factories/integrationruntimes",
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  },
  "etag": "000046c4-0000-0000-0000-5b2198bf0000"
}

Definições

Name Description
CloudError

O objeto que define a estrutura de uma resposta de erro Azure Data Factory.

CopyComputeScaleProperties

Propriedades CopyComputeScale para o runtime de integração gerido.

CredentialReference

Tipo de referência de credenciais.

CredentialReferenceType

Tipo de referência de credenciais.

CustomProperties

As propriedades personalizadas são utilizadas para otimizar o desempenho do runtime do fluxo de dados.

DataFlowComputeType

Tipo de computação do cluster que irá executar a tarefa de fluxo de dados.

EntityReference

A referência da entidade.

IntegrationRuntimeComputeProperties

As propriedades do recurso de computação para o runtime de integração gerido.

IntegrationRuntimeCustomerVirtualNetwork

A definição e as propriedades da rede virtual à qual o runtime de integração do Azure-SSIS será associado.

IntegrationRuntimeCustomSetupScriptProperties

Propriedades do script de configuração personalizada para um runtime de integração dedicado gerido.

IntegrationRuntimeDataFlowProperties

Propriedades do fluxo de dados para o runtime de integração gerido.

IntegrationRuntimeDataProxyProperties

Propriedades de proxy de dados para um runtime de integração dedicado gerido.

IntegrationRuntimeEdition

A edição do SSIS Integration Runtime

IntegrationRuntimeEntityReferenceType

O tipo desta entidade referenciada.

IntegrationRuntimeLicenseType

Tipo de licença para trazer o seu próprio cenário de licença.

IntegrationRuntimeResource

Tipo de recurso do runtime de integração.

IntegrationRuntimeSsisCatalogInfo

Informações de catálogo para o runtime de integração dedicado gerido.

IntegrationRuntimeSsisCatalogPricingTier

O escalão de preço da base de dados do catálogo. Os valores válidos podem ser encontrados em https://azure.microsoft.com/en-us/pricing/details/sql-database/

IntegrationRuntimeSsisProperties

Propriedades do SSIS para o runtime de integração gerido.

IntegrationRuntimeState

O estado do runtime de integração.

IntegrationRuntimeType

O tipo de runtime de integração.

IntegrationRuntimeVNetProperties

Propriedades da VNet para o runtime de integração gerido.

LinkedIntegrationRuntimeKeyAuthorization

O runtime de integração do tipo de autorização chave.

LinkedIntegrationRuntimeRbacAuthorization

O runtime de integração do tipo de autorização do controlo de acesso baseado em funções (RBAC).

ManagedIntegrationRuntime

Runtime de integração gerido, incluindo runtimes de integração dedicados e elásticos geridos.

ManagedVirtualNetworkReference

Tipo de referência de Rede Virtual gerido.

ManagedVirtualNetworkReferenceType

Tipo de referência de Rede Virtual gerido.

PackageStore

Arquivo de pacotes para o runtime de integração do SSIS.

PipelineExternalComputeScaleProperties

Propriedades PipelineExternalComputeScale para o runtime de integração gerido.

SecureString

Azure Data Factory definição de cadeia segura. O valor da cadeia será mascarado com asteriscos '*' durante as chamadas à API Get ou List.

SelfHostedIntegrationRuntime

Runtime de integração autoalojado.

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Data Factory.

Name Tipo Description
error.code

string

Código de erro.

error.details

CloudError[]

Matriz com detalhes de erro adicionais.

error.message

string

Mensagem de erro.

error.target

string

Nome/caminho da propriedade no pedido associado ao erro.

CopyComputeScaleProperties

Propriedades CopyComputeScale para o runtime de integração gerido.

Name Tipo Description
dataIntegrationUnit

integer

Definição de número DIU reservada para a execução da atividade de cópia. Os valores suportados são múltiplos de 4 no intervalo 4-256.

timeToLive

integer

Definição de tempo de vida (em minutos) do runtime de integração que irá executar a atividade de cópia.

CredentialReference

Tipo de referência de credenciais.

Name Tipo Description
referenceName

string

Nome da credencial de referência.

type

CredentialReferenceType

Tipo de referência de credenciais.

CredentialReferenceType

Tipo de referência de credenciais.

Name Tipo Description
CredentialReference

string

CustomProperties

As propriedades personalizadas são utilizadas para otimizar o desempenho do runtime do fluxo de dados.

Name Tipo Description
name

string

Nome da propriedade personalizada.

value

string

Valor da propriedade personalizada.

DataFlowComputeType

Tipo de computação do cluster que irá executar a tarefa de fluxo de dados.

Name Tipo Description
ComputeOptimized

string

General

string

MemoryOptimized

string

EntityReference

A referência da entidade.

Name Tipo Description
referenceName

string

O nome desta entidade referenciada.

type

IntegrationRuntimeEntityReferenceType

O tipo desta entidade referenciada.

IntegrationRuntimeComputeProperties

As propriedades do recurso de computação para o runtime de integração gerido.

Name Tipo Description
copyComputeScaleProperties

CopyComputeScaleProperties

Propriedades CopyComputeScale para o runtime de integração gerido.

dataFlowProperties

IntegrationRuntimeDataFlowProperties

Propriedades do fluxo de dados para o runtime de integração gerido.

location

string

A localização do runtime de integração gerido. As regiões suportadas podem ser encontradas em https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities

maxParallelExecutionsPerNode

integer

Contagem máxima de execuções paralelas por nó para o runtime de integração gerido.

nodeSize

string

O requisito de tamanho do nó para o runtime de integração gerido.

numberOfNodes

integer

O número necessário de nós para o runtime de integração gerido.

pipelineExternalComputeScaleProperties

PipelineExternalComputeScaleProperties

Propriedades PipelineExternalComputeScale para o runtime de integração gerido.

vNetProperties

IntegrationRuntimeVNetProperties

Propriedades da VNet para o runtime de integração gerido.

IntegrationRuntimeCustomerVirtualNetwork

A definição e as propriedades da rede virtual à qual o runtime de integração do Azure-SSIS será associado.

Name Tipo Description
subnetId

string

O ID da sub-rede à qual o runtime de integração do Azure-SSIS será associado.

IntegrationRuntimeCustomSetupScriptProperties

Propriedades do script de configuração personalizada para um runtime de integração dedicado gerido.

Name Tipo Description
blobContainerUri

string

O URI do contentor de blobs do Azure que contém o script de configuração personalizada.

sasToken

SecureString

O token de SAS do contentor de blobs do Azure.

IntegrationRuntimeDataFlowProperties

Propriedades do fluxo de dados para o runtime de integração gerido.

Name Tipo Description
cleanup

boolean

O cluster não será reciclado e será utilizado na próxima execução da atividade do fluxo de dados até que o TTL (time to live) seja atingido se estiver definido como falso. A predefinição é verdadeiro.

computeType

DataFlowComputeType

Tipo de computação do cluster que irá executar a tarefa de fluxo de dados.

coreCount

integer

Contagem de núcleos do cluster que irá executar a tarefa de fluxo de dados. Os valores suportados são: 8, 16, 32, 48, 80, 144 e 272.

customProperties

CustomProperties[]

As propriedades personalizadas são utilizadas para otimizar o desempenho do runtime do fluxo de dados.

timeToLive

integer

Definição time to live (em minutos) do cluster que irá executar a tarefa de fluxo de dados.

IntegrationRuntimeDataProxyProperties

Propriedades de proxy de dados para um runtime de integração dedicado gerido.

Name Tipo Description
connectVia

EntityReference

A referência do runtime de integração autoalojado.

path

string

O caminho para conter os dados faseados no armazenamento de Blobs.

stagingLinkedService

EntityReference

A referência do serviço ligado de teste.

IntegrationRuntimeEdition

A edição do SSIS Integration Runtime

Name Tipo Description
Enterprise

string

Standard

string

IntegrationRuntimeEntityReferenceType

O tipo desta entidade referenciada.

Name Tipo Description
IntegrationRuntimeReference

string

LinkedServiceReference

string

IntegrationRuntimeLicenseType

Tipo de licença para trazer o seu próprio cenário de licença.

Name Tipo Description
BasePrice

string

LicenseIncluded

string

IntegrationRuntimeResource

Tipo de recurso do runtime de integração.

Name Tipo Description
etag

string

A Etag identifica a alteração no recurso.

id

string

O identificador do recurso.

name

string

O nome do recurso.

properties IntegrationRuntime:

Propriedades do runtime de integração.

type

string

O tipo de recurso.

IntegrationRuntimeSsisCatalogInfo

Informações de catálogo para o runtime de integração dedicado gerido.

Name Tipo Description
catalogAdminPassword

SecureString

A palavra-passe da conta de utilizador administrador da base de dados do catálogo.

catalogAdminUserName

string

O nome de utilizador administrador da base de dados de catálogo.

catalogPricingTier

IntegrationRuntimeSsisCatalogPricingTier

O escalão de preço da base de dados do catálogo. Os valores válidos podem ser encontrados em https://azure.microsoft.com/en-us/pricing/details/sql-database/

catalogServerEndpoint

string

O URL do servidor da base de dados do catálogo.

dualStandbyPairName

string

O nome do par de reserva duplo do Azure-SSIS Integration Runtimes para suportar a ativação pós-falha do SSISDB.

IntegrationRuntimeSsisCatalogPricingTier

O escalão de preço da base de dados do catálogo. Os valores válidos podem ser encontrados em https://azure.microsoft.com/en-us/pricing/details/sql-database/

Name Tipo Description
Basic

string

Premium

string

PremiumRS

string

Standard

string

IntegrationRuntimeSsisProperties

Propriedades do SSIS para o runtime de integração gerido.

Name Tipo Description
catalogInfo

IntegrationRuntimeSsisCatalogInfo

Informações de catálogo para o runtime de integração dedicado gerido.

credential

CredentialReference

A referência de credenciais que contém informações de autenticação.

customSetupScriptProperties

IntegrationRuntimeCustomSetupScriptProperties

Propriedades do script de configuração personalizada para um runtime de integração dedicado gerido.

dataProxyProperties

IntegrationRuntimeDataProxyProperties

Propriedades de proxy de dados para um runtime de integração dedicado gerido.

edition

IntegrationRuntimeEdition

A edição do SSIS Integration Runtime

expressCustomSetupProperties

CustomSetupBase[]

Configuração personalizada sem propriedades de script para um runtime de integração do SSIS.

licenseType

IntegrationRuntimeLicenseType

Tipo de licença para trazer o seu próprio cenário de licença.

packageStores

PackageStore[]

Arquivos de pacotes para a Integration Runtime do SSIS.

IntegrationRuntimeState

O estado do runtime de integração.

Name Tipo Description
AccessDenied

string

Initial

string

Limited

string

NeedRegistration

string

Offline

string

Online

string

Started

string

Starting

string

Stopped

string

Stopping

string

IntegrationRuntimeType

O tipo de runtime de integração.

Name Tipo Description
Managed

string

SelfHosted

string

IntegrationRuntimeVNetProperties

Propriedades da VNet para o runtime de integração gerido.

Name Tipo Description
publicIPs

string[]

IDs de recursos dos endereços IP públicos que este runtime de integração irá utilizar.

subnet

string

O nome da sub-rede a que este runtime de integração será associado.

subnetId

string

O ID da sub-rede ao qual este runtime de integração do Azure-SSIS será associado.

vNetId

string

O ID da VNet à qual este runtime de integração será associado.

LinkedIntegrationRuntimeKeyAuthorization

O runtime de integração do tipo de autorização chave.

Name Tipo Description
authorizationType string:

Key

O tipo de autorização para a partilha do runtime de integração.

key

SecureString

A chave utilizada para autorização.

LinkedIntegrationRuntimeRbacAuthorization

O runtime de integração do tipo de autorização do controlo de acesso baseado em funções (RBAC).

Name Tipo Description
authorizationType string:

RBAC

O tipo de autorização para a partilha do runtime de integração.

credential

CredentialReference

A referência de credenciais que contém informações de autenticação.

resourceId

string

O identificador de recurso do runtime de integração a ser partilhado.

ManagedIntegrationRuntime

Runtime de integração gerido, incluindo runtimes de integração dedicados e elásticos geridos.

Name Tipo Description
description

string

Descrição do runtime de integração.

managedVirtualNetwork

ManagedVirtualNetworkReference

Referência de Rede Virtual gerida.

state

IntegrationRuntimeState

Estado do runtime de integração, apenas válido para o runtime de integração dedicado gerido.

type string:

Managed

Tipo de runtime de integração.

typeProperties.computeProperties

IntegrationRuntimeComputeProperties

O recurso de computação para o runtime de integração gerido.

typeProperties.customerVirtualNetwork

IntegrationRuntimeCustomerVirtualNetwork

O nome da rede virtual à qual o runtime de integração do Azure-SSIS será associado

typeProperties.ssisProperties

IntegrationRuntimeSsisProperties

Propriedades do SSIS para o runtime de integração gerido.

ManagedVirtualNetworkReference

Tipo de referência de Rede Virtual gerido.

Name Tipo Description
referenceName

string

Referência do nome ManagedVirtualNetwork.

type

ManagedVirtualNetworkReferenceType

Tipo de referência de Rede Virtual gerido.

ManagedVirtualNetworkReferenceType

Tipo de referência de Rede Virtual gerido.

Name Tipo Description
ManagedVirtualNetworkReference

string

PackageStore

Arquivo de pacotes para o runtime de integração do SSIS.

Name Tipo Description
name

string

O nome do arquivo de pacotes

packageStoreLinkedService

EntityReference

A referência do serviço ligado do arquivo de pacotes.

PipelineExternalComputeScaleProperties

Propriedades PipelineExternalComputeScale para o runtime de integração gerido.

Name Tipo Description
numberOfExternalNodes

integer

Número dos nós externos, que devem ser superiores a 0 e inferiores a 11.

numberOfPipelineNodes

integer

Número de nós de pipeline, que devem ser superiores a 0 e inferiores a 11.

timeToLive

integer

Definição time to live (em minutos) do runtime de integração que irá executar o pipeline e a atividade externa.

SecureString

Azure Data Factory definição de cadeia segura. O valor da cadeia será mascarado com asteriscos '*' durante as chamadas à API Get ou List.

Name Tipo Description
type string:

SecureString

Tipo de segredo.

value

string

Valor da cadeia segura.

SelfHostedIntegrationRuntime

Runtime de integração autoalojado.

Name Tipo Description
description

string

Descrição do runtime de integração.

type string:

SelfHosted

Tipo de runtime de integração.

typeProperties.linkedInfo LinkedIntegrationRuntimeType:

A definição base de um runtime de integração ligado.

typeProperties.selfContainedInteractiveAuthoringEnabled

boolean

Uma opção alternativa para garantir a função de criação interativa quando o runtime de integração autoalojado não consegue estabelecer uma ligação com o Azure Relay.