Integration Runtimes - Get

Referensi

Service:: Synapse

API Version:: 2021-06-01-preview

Mendapatkan runtime integrasi
Mendapatkan runtime integrasi

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

Parameter URI

Name	In	Required	Type	Description
integrationRuntimeName	path	True	string	Nama runtime integrasi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
workspaceName	path	True	string	Nama ruang kerja.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Name	Required	Type	Description
If-None-Match		string	ETag entitas runtime integrasi. Seharusnya hanya ditentukan untuk mendapatkan. Jika ETag cocok dengan tag entitas yang ada, atau jika * disediakan, maka tidak ada konten yang akan dikembalikan.

Respons

Name	Type	Description
200 OK	IntegrationRuntimeResource	OK.
Other Status Codes		Tidak dimodifikasi.
Other Status Codes	ErrorResponse	Respons kesalahan yang diterima dari operasi runtime integrasi GET.

Contoh

Get integration runtime

Sample Request

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

import com.azure.core.util.Context;

/** Samples for IntegrationRuntimes Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Get.json
     */
    /**
     * Sample code: Get integration runtime.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void getIntegrationRuntime(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .integrationRuntimes()
            .getWithResponse(
                "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", null, Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Get.json
func ExampleIntegrationRuntimesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armsynapse.NewIntegrationRuntimesClient("12345678-1234-1234-1234-12345678abc", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"exampleResourceGroup",
		"exampleWorkspace",
		"exampleIntegrationRuntime",
		&armsynapse.IntegrationRuntimesClientGetOptions{IfNoneMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get an integration runtime
 *
 * @summary Get an integration runtime
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Get.json
 */
async function getIntegrationRuntime() {
  const subscriptionId = "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = "exampleResourceGroup";
  const workspaceName = "exampleWorkspace";
  const integrationRuntimeName = "exampleIntegrationRuntime";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.get(
    resourceGroupName,
    workspaceName,
    integrationRuntimeName
  );
  console.log(result);
}

getIntegrationRuntime().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 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

Response Body

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

Status code:: 304

Status code:: default

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

Definisi

DataFlowComputeType	Jenis komputasi kluster yang akan menjalankan pekerjaan aliran data.
EntityReference	Referensi entitas.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
IntegrationRuntimeComputeProperties	Properti sumber daya komputasi untuk runtime integrasi terkelola.
IntegrationRuntimeCustomSetupScriptProperties	Properti skrip penyiapan kustom untuk runtime integrasi khusus terkelola.
IntegrationRuntimeDataFlowProperties	Properti aliran data untuk runtime integrasi terkelola.
IntegrationRuntimeDataProxyProperties	Properti proksi data untuk runtime integrasi khusus terkelola.
IntegrationRuntimeEdition	Edisi untuk Integration Runtime SSIS
IntegrationRuntimeEntityReferenceType	Jenis entitas yang dirujuk ini.
IntegrationRuntimeLicenseType	Jenis lisensi untuk membawa skenario lisensi Anda sendiri.
IntegrationRuntimeResource	Jenis sumber daya runtime integrasi.
IntegrationRuntimeSsisCatalogInfo	Informasi katalog untuk runtime integrasi khusus terkelola.
IntegrationRuntimeSsisCatalogPricingTier	Tingkat harga untuk database katalog. Nilai yang valid dapat ditemukan di https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	Properti SSIS untuk runtime integrasi terkelola.
IntegrationRuntimeState	Status runtime integrasi.
IntegrationRuntimeType	Jenis runtime integrasi.
IntegrationRuntimeVNetProperties	Properti VNet untuk runtime integrasi terkelola.
LinkedIntegrationRuntimeKeyAuthorization	Runtime integrasi jenis otorisasi utama.
LinkedIntegrationRuntimeRbacAuthorization	Runtime integrasi jenis otorisasi kontrol akses berbasis peran (RBAC).
ManagedIntegrationRuntime	Runtime integrasi terkelola, termasuk runtime integrasi khusus terkelola dan elastis terkelola.
SecureString	Azure Synapse definisi string aman. Nilai string akan ditutupi dengan tanda bintang '*' selama panggilan Get atau List API.
SelfHostedIntegrationRuntime	Runtime integrasi yang dihost sendiri.

DataFlowComputeType

Jenis komputasi kluster yang akan menjalankan pekerjaan aliran data.

Name	Type	Description
ComputeOptimized	string
General	string
MemoryOptimized	string

EntityReference

Referensi entitas.

Name	Type	Description
referenceName	string	Nama entitas yang dirujuk ini.
type	IntegrationRuntimeEntityReferenceType	Jenis entitas yang dirujuk ini.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Name	Type	Description
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Name	Type	Description
error	ErrorDetail	Objek kesalahan.

IntegrationRuntimeComputeProperties

Properti sumber daya komputasi untuk runtime integrasi terkelola.

Name	Type	Description
dataFlowProperties	IntegrationRuntimeDataFlowProperties	Properti aliran data untuk runtime integrasi terkelola.
location	string	Lokasi untuk runtime integrasi terkelola. Wilayah yang didukung dapat ditemukan pada https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
maxParallelExecutionsPerNode	integer	Jumlah eksekusi paralel maksimum per simpul untuk runtime integrasi terkelola.
nodeSize	string	Persyaratan ukuran simpul untuk runtime integrasi terkelola.
numberOfNodes	integer	Jumlah simpul yang diperlukan untuk runtime integrasi terkelola.
vNetProperties	IntegrationRuntimeVNetProperties	Properti VNet untuk runtime integrasi terkelola.

IntegrationRuntimeCustomSetupScriptProperties

Properti skrip penyiapan kustom untuk runtime integrasi khusus terkelola.

Name	Type	Description
blobContainerUri	string	URI kontainer blob Azure yang berisi skrip penyiapan kustom.
sasToken	SecureString	Token SAS dari kontainer blob Azure.

IntegrationRuntimeDataFlowProperties

Properti aliran data untuk runtime integrasi terkelola.

Name	Type	Description
cleanup	boolean	Kluster tidak akan didaur ulang dan akan digunakan dalam aktivitas aliran data berikutnya yang dijalankan hingga TTL (time to live) tercapai jika ini ditetapkan sebagai false. Defaultnya adalah true.
computeType	DataFlowComputeType	Jenis komputasi kluster yang akan menjalankan pekerjaan aliran data.
coreCount	integer	Jumlah inti kluster yang akan menjalankan pekerjaan aliran data. Nilai yang didukung adalah: 8, 16, 32, 48, 80, 144 dan 272.
timeToLive	integer	Pengaturan time to live (dalam menit) kluster yang akan menjalankan pekerjaan aliran data.

IntegrationRuntimeDataProxyProperties

Properti proksi data untuk runtime integrasi khusus terkelola.

Name	Type	Description
connectVia	EntityReference	Referensi runtime integrasi yang dihost sendiri.
path	string	Jalur untuk berisi data bertahap di penyimpanan Blob.
stagingLinkedService	EntityReference	Referensi layanan tertaut penahapan.

IntegrationRuntimeEdition

Edisi untuk Integration Runtime SSIS

Name	Type	Description
Enterprise	string
Standard	string

IntegrationRuntimeEntityReferenceType

Jenis entitas yang dirujuk ini.

Name	Type	Description
IntegrationRuntimeReference	string
LinkedServiceReference	string

IntegrationRuntimeLicenseType

Jenis lisensi untuk membawa skenario lisensi Anda sendiri.

Name	Type	Description
BasePrice	string
LicenseIncluded	string

IntegrationRuntimeResource

Jenis sumber daya runtime integrasi.

Name	Type	Description
etag	string	Sumber Daya Etag.
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Properti runtime integrasi.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Informasi katalog untuk runtime integrasi khusus terkelola.

Name	Type	Description
catalogAdminPassword	SecureString	Kata sandi akun pengguna administrator database katalog.
catalogAdminUserName	string	Nama pengguna administrator database katalog.
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	Tingkat harga untuk database katalog. Nilai yang valid dapat ditemukan di https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint	string	URL server database katalog.

IntegrationRuntimeSsisCatalogPricingTier

Tingkat harga untuk database katalog. Nilai yang valid dapat ditemukan di https://azure.microsoft.com/en-us/pricing/details/sql-database/

Name	Type	Description
Basic	string
Premium	string
PremiumRS	string
Standard	string

IntegrationRuntimeSsisProperties

Properti SSIS untuk runtime integrasi terkelola.

Name	Type	Description
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Informasi katalog untuk runtime integrasi khusus terkelola.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Properti skrip penyiapan kustom untuk runtime integrasi khusus terkelola.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Properti proksi data untuk runtime integrasi khusus terkelola.
edition	IntegrationRuntimeEdition	Edisi untuk Integration Runtime SSIS
expressCustomSetupProperties	CustomSetupBase[]	Penyiapan kustom tanpa properti skrip untuk runtime integrasi SSIS.
licenseType	IntegrationRuntimeLicenseType	Jenis lisensi untuk membawa skenario lisensi Anda sendiri.

IntegrationRuntimeState

Status runtime integrasi.

Name	Type	Description
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeType

Jenis runtime integrasi.

Name	Type	Description
Managed	string
SelfHosted	string

IntegrationRuntimeVNetProperties

Properti VNet untuk runtime integrasi terkelola.

Name	Type	Description
publicIPs	string[]	ID sumber daya dari alamat IP publik yang akan digunakan runtime integrasi ini.
subnet	string	Nama subnet yang akan bergabung dengan runtime integrasi ini.
subnetId	string	ID subnet, tempat runtime integrasi Azure-SSIS ini akan bergabung.
vNetId	string	ID VNet yang akan bergabung dengan runtime integrasi ini.

LinkedIntegrationRuntimeKeyAuthorization

Runtime integrasi jenis otorisasi utama.

Name	Type	Description
authorizationType	string: Key	Jenis otorisasi untuk berbagi runtime integrasi.
key	SecureString	Kunci yang digunakan untuk otorisasi.

LinkedIntegrationRuntimeRbacAuthorization

Runtime integrasi jenis otorisasi kontrol akses berbasis peran (RBAC).

Name	Type	Description
authorizationType	string: RBAC	Jenis otorisasi untuk berbagi runtime integrasi.
resourceId	string	Pengidentifikasi sumber daya runtime integrasi yang akan dibagikan.

ManagedIntegrationRuntime

Runtime integrasi terkelola, termasuk runtime integrasi khusus terkelola dan elastis terkelola.

Name	Type	Description
description	string	Deskripsi runtime integrasi.
managedVirtualNetwork.id	string	Id jaringan virtual terkelola.
managedVirtualNetwork.referenceName	string	Nama referensi jaringan virtual terkelola.
managedVirtualNetwork.type	string	Jenis jaringan virtual terkelola.
state	IntegrationRuntimeState	Status runtime integrasi, hanya berlaku untuk runtime integrasi khusus terkelola.
type	string: Managed	Jenis runtime integrasi.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	Sumber daya komputasi untuk runtime integrasi terkelola.
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	Properti SSIS untuk runtime integrasi terkelola.

SecureString

Azure Synapse definisi string aman. Nilai string akan ditutupi dengan tanda bintang '*' selama panggilan Get atau List API.

Name	Type	Description
type	string: SecureString	Jenis rahasia.
value	string	Nilai string aman.

SelfHostedIntegrationRuntime

Runtime integrasi yang dihost sendiri.

Name	Type	Description
description	string	Deskripsi runtime integrasi.
type	string: SelfHosted	Jenis runtime integrasi.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Jenis runtime integrasi tertaut dari pabrik data