Integration Runtimes - Get

Serviço:: Synapse

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

Obtenha tempo de execução de integração
Obtenha um tempo de execução 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 do URI

Name	Em	Necessário	Tipo	Description
integrationRuntimeName	path	True	string	Nome do tempo de execução da 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 espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-None-Match		string	ETag da entidade de tempo de execução de integração. Só deve ser especificado para get. Se a ETag corresponder à tag de entidade existente, ou se * foi fornecido, nenhum conteúdo será retornado.

Respostas

Name	Tipo	Description
200 OK	IntegrationRuntimeResource	OK.
Other Status Codes		Não modificado.
Other Status Codes	ErrorResponse	Uma resposta de erro recebida da operação de tempo de execução de integração GET.

Exemplos

Get integration runtime

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 304

Código de estado:: default

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

Definições

Name	Description
DataFlowComputeType	Tipo de computação do cluster que executará o trabalho de fluxo de dados.
EntityReference	A referência da entidade.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IntegrationRuntimeComputeProperties	As propriedades do recurso de computação para o tempo de execução da integração gerenciada.
IntegrationRuntimeCustomerVirtualNetwork	A definição e as propriedades da rede virtual à qual Azure-SSIS tempo de execução de integração se juntará.
IntegrationRuntimeCustomSetupScriptProperties	Propriedades de script de configuração personalizadas para um tempo de execução de integração dedicado gerenciado.
IntegrationRuntimeDataFlowProperties	Propriedades de fluxo de dados para tempo de execução de integração gerenciada.
IntegrationRuntimeDataProxyProperties	Propriedades de proxy de dados para um tempo de execução de integração dedicado gerenciado.
IntegrationRuntimeEdition	A edição para o SSIS Integration Runtime
IntegrationRuntimeEntityReferenceType	O tipo desta entidade referenciada.
IntegrationRuntimeLicenseType	Tipo de licença para trazer seu próprio cenário de licença.
IntegrationRuntimeResource	Tipo de recurso de tempo de execução de integração.
IntegrationRuntimeSsisCatalogInfo	Informações de catálogo para tempo de execução de integração dedicada gerenciada.
IntegrationRuntimeSsisCatalogPricingTier	A camada de preços para o banco de dados de catálogo. Os valores válidos podem ser encontrados em https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	Propriedades SSIS para tempo de execução de integração gerenciada.
IntegrationRuntimeState	O estado do tempo de execução da integração.
IntegrationRuntimeType	O tipo de tempo de execução da integração.
IntegrationRuntimeVNetProperties	Propriedades de VNet para tempo de execução de integração gerenciada.
LinkedIntegrationRuntimeKeyAuthorization	O tempo de execução de integração do tipo de autorização de chave.
LinkedIntegrationRuntimeRbacAuthorization	O tempo de execução de integração do tipo de autorização RBAC (controle de acesso baseado em função).
ManagedIntegrationRuntime	Tempo de execução de integração gerenciado, incluindo tempos de execução de integração gerenciados elásticos e dedicados gerenciados.
SecureString	Definição de cadeia de caracteres segura do Azure Synapse. O valor da cadeia de caracteres será mascarado com asteriscos '*' durante chamadas de API Get ou List.
SelfHostedIntegrationRuntime	Tempo de execução de integração auto-hospedado.

DataFlowComputeType

Enumeração

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

Valor	Description
General
MemoryOptimized
ComputeOptimized

EntityReference

Object

A referência da entidade.

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

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

IntegrationRuntimeComputeProperties

Object

As propriedades do recurso de computação para o tempo de execução da integração gerenciada.

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

IntegrationRuntimeCustomerVirtualNetwork

Object

A definição e as propriedades da rede virtual à qual Azure-SSIS tempo de execução de integração se juntará.

Name	Tipo	Description
subnetId	string	A ID da sub-rede à qual Azure-SSIS tempo de execução de integração se juntará.

IntegrationRuntimeCustomSetupScriptProperties

Object

Propriedades de script de configuração personalizadas para um tempo de execução de integração dedicado gerenciado.

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

IntegrationRuntimeDataFlowProperties

Object

Propriedades de fluxo de dados para tempo de execução de integração gerenciada.

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

IntegrationRuntimeDataProxyProperties

Object

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

Name	Tipo	Description
connectVia	EntityReference	A referência de tempo de execução de integração auto-hospedada.
path	string	O caminho para conter os dados em estágios no armazenamento de Blob.
stagingLinkedService	EntityReference	A referência de serviço vinculado de preparo.

IntegrationRuntimeEdition

Enumeração

A edição para o SSIS Integration Runtime

Valor	Description
Standard
Enterprise

IntegrationRuntimeEntityReferenceType

Enumeração

O tipo desta 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

Object

Tipo de recurso de tempo de execução de integração.

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

IntegrationRuntimeSsisCatalogInfo

Object

Informações de catálogo para tempo de execução de integração dedicada gerenciada.

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

A camada de preços para o banco de dados de 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

Object

Propriedades SSIS para tempo de execução de integração gerenciada.

Name	Tipo	Description
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Informações de catálogo para tempo de execução de integração dedicada gerenciada.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Propriedades de script de configuração personalizadas para um tempo de execução de integração dedicado gerenciado.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Propriedades de proxy de dados para um tempo de execução de integração dedicado gerenciado.
edition	IntegrationRuntimeEdition	A edição para o SSIS Integration Runtime
expressCustomSetupProperties	CustomSetupBase[]	Configuração personalizada sem propriedades de script para um tempo de execução de integração SSIS.
licenseType	IntegrationRuntimeLicenseType	Tipo de licença para trazer seu próprio cenário de licença.

IntegrationRuntimeState

Enumeração

O estado do tempo de execução da integração.

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

IntegrationRuntimeType

Enumeração

O tipo de tempo de execução da integração.

Valor	Description
Managed
SelfHosted

IntegrationRuntimeVNetProperties

Object

Propriedades de VNet para tempo de execução de integração gerenciada.

Name	Tipo	Description
publicIPs	string[]	IDs de recursos dos endereços IP públicos que esse tempo de execução de integração usará.
subnet	string	O nome da sub-rede à qual esse tempo de execução de integração se juntará.
subnetId	string	A ID da sub-rede, à qual esse tempo de execução de integração Azure-SSIS será associado.
vNetId	string	A ID da VNet à qual esse tempo de execução de integração se juntará.

LinkedIntegrationRuntimeKeyAuthorization

Object

O tempo de execução de integração do tipo de autorização de chave.

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

LinkedIntegrationRuntimeRbacAuthorization

Object

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

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

ManagedIntegrationRuntime

Object

Tempo de execução de integração gerenciado, incluindo tempos de execução de integração gerenciados elásticos e dedicados gerenciados.

Name	Tipo	Description
description	string	Descrição do tempo de execução da 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 de rede virtual gerenciada.
provisioningState	IntegrationRuntimeState	Estado do tempo de execução da integração, válido apenas para o tempo de execução da integração dedicada gerenciada.
type	string: Managed	Tipo de tempo de execução de integração.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	O recurso de computação para tempo de execução de integração gerenciada.
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	O nome da rede virtual à qual Azure-SSIS tempo de execução de integração se unirá
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	Propriedades SSIS para tempo de execução de integração gerenciada.

SecureString

Object

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

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

SelfHostedIntegrationRuntime

Object

Tempo de execução de integração auto-hospedado.

Name	Tipo	Description
description	string	Descrição do tempo de execução da integração.
type	string: SelfHosted	Tipo de tempo de execução de integração.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Tipo de tempo de execução de integração vinculado do data factory