Integration Runtimes - Get

Serviço:: Synapse

Versão da API:: 2021-06-01

Obter runtime de integração
Obter um runtime de integração

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}?api-version=2021-06-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
integrationRuntimeName	path	True	string	Nome do runtime de integração
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
workspaceName	path	True	string	O nome do workspace.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-None-Match		string	ETag da entidade de runtime de integração. Só deve ser especificado para obter. Se a ETag corresponder à marca de entidade existente ou se * tiver sido fornecida, nenhum conteúdo será retornado.

Respostas

Nome	Tipo	Description
200 OK	IntegrationRuntimeResource	OKEY.
Other Status Codes		Não modificado.
Other Status Codes	ErrorResponse	Uma resposta de erro recebida da operação get integration runtime.

Exemplos

Get integration runtime

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleIntegrationRuntime?api-version=2021-06-01

Resposta de exemplo

Código de status:: 200

Date: Mon, 22 Apr 2019 18:33:47 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11997
x-ms-request-id: ad824326-e577-4a47-a092-2e621c4d59d9
x-ms-correlation-request-id: ad824326-e577-4a47-a092-2e621c4d59d9

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime",
  "name": "exampleIntegrationRuntime",
  "type": "Microsoft.Synapse/workspaces/integrationruntimes",
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  },
  "etag": "15003c4f-0000-0200-0000-5cbe090b0000"
}

Código de status:: 304

Código de status:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definições

Nome	Description
DataFlowComputeType	Tipo de computação do cluster que executará o trabalho de fluxo de dados.
EntityReference	A referência de entidade.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IntegrationRuntimeComputeProperties	As propriedades do recurso de computação para o runtime de integração gerenciada.
IntegrationRuntimeCustomerVirtualNetwork	A definição e as propriedades da rede virtual à qual o runtime de integração Azure-SSIS ingressará.
IntegrationRuntimeCustomSetupScriptProperties	Propriedades de script de configuração personalizada para um runtime de integração dedicado gerenciado.
IntegrationRuntimeDataFlowProperties	Propriedades de fluxo de dados para runtime de integração gerenciada.
IntegrationRuntimeDataProxyProperties	Propriedades de proxy de dados para um runtime de integração dedicado gerenciado.
IntegrationRuntimeEdition	A edição do SSIS Integration Runtime
IntegrationRuntimeEntityReferenceType	O tipo dessa entidade referenciada.
IntegrationRuntimeLicenseType	Tipo de licença para trazer seu próprio cenário de licença.
IntegrationRuntimeResource	Tipo de recurso de runtime de integração.
IntegrationRuntimeSsisCatalogInfo	Informações de catálogo para o runtime de integração dedicado gerenciado.
IntegrationRuntimeSsisCatalogPricingTier	O tipo de preço do banco 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 runtime de integração gerenciada.
IntegrationRuntimeState	O estado do runtime de integração.
IntegrationRuntimeType	O tipo de runtime de integração.
IntegrationRuntimeVNetProperties	Propriedades de VNet para runtime de integração gerenciada.
LinkedIntegrationRuntimeKeyAuthorization	O runtime de integração do tipo de autorização de chave.
LinkedIntegrationRuntimeRbacAuthorization	O runtime de integração do tipo de autorização RBAC (controle de acesso baseado em função).
ManagedIntegrationRuntime	Runtime de integração gerenciada, incluindo runtimes de integração dedicados gerenciados e elásticos gerenciados.
SecureString	Definição de cadeia de caracteres segura do Azure Synapse. O valor da cadeia de caracteres será mascarado com asteriscos '*' durante as chamadas à API Get ou List.
SelfHostedIntegrationRuntime	Runtime de integração auto-hospedada.

DataFlowComputeType

Enumeração

Tipo de computação do cluster que executará o trabalho de fluxo de dados.

Valor	Description
General
MemoryOptimized
ComputeOptimized

EntityReference

Objeto

A referência de entidade.

Nome	Tipo	Description
referenceName	string	O nome dessa entidade referenciada.
type	IntegrationRuntimeEntityReferenceType	O tipo dessa entidade referenciada.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IntegrationRuntimeComputeProperties

Objeto

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

Nome	Tipo	Description
dataFlowProperties	IntegrationRuntimeDataFlowProperties	Propriedades de fluxo de dados para runtime de integração gerenciada.
location	string	O local do runtime de integração gerenciada. As regiões com suporte podem ser encontradas no https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
maxParallelExecutionsPerNode	integer (int32) minimum: 1	Contagem máxima de execuções paralelas por nó para runtime de integração gerenciada.
nodeSize	string	O requisito de tamanho do nó para o runtime de integração gerenciada.
numberOfNodes	integer (int32) minimum: 1	O número necessário de nós para o runtime de integração gerenciada.
vNetProperties	IntegrationRuntimeVNetProperties	Propriedades de VNet para runtime de integração gerenciada.

IntegrationRuntimeCustomerVirtualNetwork

Objeto

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

Nome	Tipo	Description
subnetId	string	A ID da sub-rede à qual o runtime de integração Azure-SSIS ingressará.

IntegrationRuntimeCustomSetupScriptProperties

Objeto

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

Nome	Tipo	Description
blobContainerUri	string	O URI do contêiner de blob do Azure que contém o script de configuração personalizado.
sasToken	SecureString	O token SAS do contêiner de blob do Azure.

IntegrationRuntimeDataFlowProperties

Objeto

Propriedades de fluxo de dados para runtime de integração gerenciada.

Nome	Tipo	Description
computeType	DataFlowComputeType	Tipo de computação do cluster que executará o trabalho de fluxo de dados.
coreCount	integer (int32)	Contagem principal do cluster que executará o trabalho de fluxo de dados. Os valores com suporte são: 8, 16, 32, 48, 80, 144 e 272.
timeToLive	integer (int32) minimum: 0	Configuração de tempo de vida útil (em minutos) do cluster que executará o trabalho de fluxo de dados.

IntegrationRuntimeDataProxyProperties

Objeto

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

Nome	Tipo	Description
connectVia	EntityReference	A referência de runtime de integração auto-hospedada.
path	string	O caminho para conter os dados em etapas no Armazenamento de Blobs.
stagingLinkedService	EntityReference	A referência de serviço vinculado de preparo.

IntegrationRuntimeEdition

Enumeração

A edição do SSIS Integration Runtime

Valor	Description
Standard
Enterprise

IntegrationRuntimeEntityReferenceType

Enumeração

O tipo dessa entidade referenciada.

Valor	Description
IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

Enumeração

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

Valor	Description
BasePrice
LicenseIncluded

IntegrationRuntimeResource

Objeto

Tipo de recurso de runtime de integração.

Nome	Tipo	Description
etag	string	Etag de recurso.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Propriedades do runtime de integração.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Objeto

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

Nome	Tipo	Description
catalogAdminPassword	SecureString	A senha da conta de usuário do administrador do banco de dados do catálogo.
catalogAdminUserName	string minLength: 1 maxLength: 128	O nome de usuário do administrador do banco de dados do catálogo.
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	O tipo de preço do banco 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	A URL do servidor de banco de dados do catálogo.

IntegrationRuntimeSsisCatalogPricingTier

Enumeração

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

Valor	Description
Basic
Standard
Premium
PremiumRS

IntegrationRuntimeSsisProperties

Objeto

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

Nome	Tipo	Description
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Informações de catálogo para o runtime de integração dedicado gerenciado.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Propriedades de script de configuração personalizada para um runtime de integração dedicado gerenciado.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Propriedades de proxy de dados para um runtime de integração dedicado gerenciado.
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 seu próprio cenário de licença.

IntegrationRuntimeState

Enumeração

O estado do runtime de integração.

Valor	Description
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeType

Enumeração

O tipo de runtime de integração.

Valor	Description
Managed
SelfHosted

IntegrationRuntimeVNetProperties

Objeto

Propriedades de VNet para runtime de integração gerenciada.

Nome	Tipo	Description
publicIPs	string[]	IDs de recurso dos endereços IP públicos que esse runtime de integração usará.
subnet	string	O nome da sub-rede que esse runtime de integração unirá.
subnetId	string	A ID da sub-rede à qual esse Azure-SSIS runtime de integração será ingressado.
vNetId	string	A ID da VNet que esse runtime de integração unirá.

LinkedIntegrationRuntimeKeyAuthorization

Objeto

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

Nome	Tipo	Description
authorizationType	string: Key	O tipo de autorização para compartilhamento de runtime de integração.
key	SecureString	A chave usada para autorização.

LinkedIntegrationRuntimeRbacAuthorization

Objeto

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

Nome	Tipo	Description
authorizationType	string: RBAC	O tipo de autorização para compartilhamento de runtime de integração.
resourceId	string	O identificador de recurso do runtime de integração a ser compartilhado.

ManagedIntegrationRuntime

Objeto

Runtime de integração gerenciada, incluindo runtimes de integração dedicados gerenciados e elásticos gerenciados.

Nome	Tipo	Description
description	string	Descrição do runtime de integração.
managedVirtualNetwork.id	string	A ID da rede virtual gerenciada.
managedVirtualNetwork.referenceName	string	O nome de referência da rede virtual gerenciada
managedVirtualNetwork.type	string	O tipo da rede virtual gerenciada.
provisioningState	IntegrationRuntimeState	Estado de runtime de integração, válido apenas para o runtime de integração dedicado gerenciado.
type	string: Managed	Tipo de runtime de integração.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	O recurso de computação para runtime de integração gerenciada.
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	O nome da rede virtual à qual o runtime de integração Azure-SSIS ingressará
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	Propriedades do SSIS para runtime de integração gerenciada.

SecureString

Objeto

Definição de cadeia de caracteres segura do Azure Synapse. O valor da cadeia de caracteres será mascarado com asteriscos '*' durante as chamadas à API Get ou List.

Nome	Tipo	Description
type	string: SecureString	Tipo do segredo.
value	string	Valor da cadeia de caracteres segura.

SelfHostedIntegrationRuntime

Objeto

Runtime de integração auto-hospedada.

Nome	Tipo	Description
description	string	Descrição do runtime de integração.
type	string: SelfHosted	Tipo de runtime de integração.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Tipo de runtime de integração vinculada do data factory