Integration Runtimes - Start

Referensi

Service:: Synapse

API Version:: 2021-06-01-preview

Memulai runtime integrasi
Memulai runtime integrasi

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start?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.

Respons

Name	Type	Description
200 OK	IntegrationRuntimeStatusResponse	OK.
202 Accepted		Diterima.
Other Status Codes	ErrorResponse	Respons kesalahan yang diterima dari layanan Azure Synapse.

Contoh

Start integration runtime

Sample Request

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

import com.azure.core.util.Context;

/** Samples for IntegrationRuntimes Start. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Start.json
     */
    /**
     * Sample code: Start integration runtime.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void startIntegrationRuntime(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .integrationRuntimes()
            .start("exampleResourceGroup", "exampleWorkspace", "exampleManagedIntegrationRuntime", 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_Start.json
func ExampleIntegrationRuntimesClient_BeginStart() {
	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)
	}
	poller, err := client.BeginStart(ctx,
		"exampleResourceGroup",
		"exampleWorkspace",
		"exampleManagedIntegrationRuntime",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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 Start an integration runtime
 *
 * @summary Start an integration runtime
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Start.json
 */
async function startIntegrationRuntime() {
  const subscriptionId = "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = "exampleResourceGroup";
  const workspaceName = "exampleWorkspace";
  const integrationRuntimeName = "exampleManagedIntegrationRuntime";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.beginStartAndWait(
    resourceGroupName,
    workspaceName,
    integrationRuntimeName
  );
  console.log(result);
}

startIntegrationRuntime().catch(console.error);

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

Sample Response

Status code:: 200

Date: Wed, 13 Jun 2018 21:33:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14912
x-ms-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677
x-ms-correlation-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677

Response Body

{
  "name": "exampleManagedIntegrationRuntime",
  "properties": {
    "dataFactoryName": "exampleWorkspaceName",
    "type": "Managed",
    "state": "Started",
    "typeProperties": {
      "nodes": [],
      "otherErrors": [],
      "createTime": "2018-06-13T21:11:01.8695494Z"
    }
  }
}

Status code:: 202

Definisi

ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
IntegrationRuntimeAutoUpdate	Status pembaruan otomatis runtime integrasi.
IntegrationRuntimeInternalChannelEncryptionMode	Ini digunakan untuk mengatur mode enkripsi untuk saluran komunikasi node-node (ketika ada lebih dari 2 simpul runtime integrasi yang dihost sendiri).
IntegrationRuntimeState	Status runtime integrasi.
IntegrationRuntimeStatusResponse	Respons status runtime integrasi.
IntegrationRuntimeType	Jenis runtime integrasi.
IntegrationRuntimeUpdateResult	Hasil dari pembaruan simpul runtime integrasi terakhir.
LinkedIntegrationRuntime	Informasi runtime integrasi tertaut.
ManagedIntegrationRuntimeError	Definisi kesalahan untuk runtime integrasi terkelola.
ManagedIntegrationRuntimeNode	Properti simpul runtime integrasi.
ManagedIntegrationRuntimeNodeStatus	Status simpul runtime integrasi terkelola.
ManagedIntegrationRuntimeOperationResult	Properti hasil operasi runtime integrasi terkelola.
ManagedIntegrationRuntimeStatus	Status runtime integrasi terkelola.
SelfHostedIntegrationRuntimeNode	Properti simpul runtime integrasi yang dihost sendiri.
SelfHostedIntegrationRuntimeNodeStatus	Status simpul runtime integrasi.
SelfHostedIntegrationRuntimeStatus	Status runtime integrasi yang dihost sendiri.

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.

IntegrationRuntimeAutoUpdate

Status pembaruan otomatis runtime integrasi.

Name	Type	Description
Off	string
On	string

IntegrationRuntimeInternalChannelEncryptionMode

Ini digunakan untuk mengatur mode enkripsi untuk saluran komunikasi node-node (ketika ada lebih dari 2 simpul runtime integrasi yang dihost sendiri).

Name	Type	Description
NotEncrypted	string
NotSet	string
SslEncrypted	string

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

IntegrationRuntimeStatusResponse

Respons status runtime integrasi.

Name	Type	Description
name	string	Nama runtime integrasi.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Properti runtime integrasi.

IntegrationRuntimeType

Jenis runtime integrasi.

Name	Type	Description
Managed	string
SelfHosted	string

IntegrationRuntimeUpdateResult

Hasil dari pembaruan simpul runtime integrasi terakhir.

Name	Type	Description
Fail	string
None	string
Succeed	string

LinkedIntegrationRuntime

Informasi runtime integrasi tertaut.

Name	Type	Description
createTime	string	Waktu pembuatan runtime integrasi tertaut.
dataFactoryLocation	string	Lokasi ruang kerja tempat runtime integrasi tertaut berada.
dataFactoryName	string	Nama ruang kerja tempat runtime integrasi tertaut berada.
name	string	Nama runtime integrasi yang ditautkan.
subscriptionId	string	ID langganan tempat runtime integrasi tertaut berada.

ManagedIntegrationRuntimeError

Definisi kesalahan untuk runtime integrasi terkelola.

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan.
parameters	string[]	Parameter kesalahan runtime integrasi terkelola.
time	string	Waktu kesalahan terjadi.

ManagedIntegrationRuntimeNode

Properti simpul runtime integrasi.

Name	Type	Description
errors	ManagedIntegrationRuntimeError[]	Kesalahan yang terjadi pada simpul runtime integrasi ini.
nodeId	string	Id node runtime integrasi terkelola.
status	ManagedIntegrationRuntimeNodeStatus	Status simpul runtime integrasi terkelola.

ManagedIntegrationRuntimeNodeStatus

Status simpul runtime integrasi terkelola.

Name	Type	Description
Available	string
Recycling	string
Starting	string
Unavailable	string

ManagedIntegrationRuntimeOperationResult

Properti hasil operasi runtime integrasi terkelola.

Name	Type	Description
activityId	string	Id aktivitas untuk permintaan operasi.
errorCode	string	Kode kesalahan.
parameters	string[]	Parameter kesalahan runtime integrasi terkelola.
result	string	Hasil operasi.
startTime	string	Waktu mulai operasi.
type	string	Jenis operasi. Bisa jadi mulai atau berhenti.

ManagedIntegrationRuntimeStatus

Status runtime integrasi terkelola.

Name	Type	Description
dataFactoryName	string	Nama ruang kerja tempat runtime integrasi berada.
state	IntegrationRuntimeState	Status runtime integrasi.
type	string: Managed	Jenis runtime integrasi.
typeProperties.createTime	string	Waktu saat runtime integrasi dibuat, dalam format ISO8601.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	Hasil operasi terakhir yang terjadi pada runtime integrasi ini.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	Daftar simpul untuk runtime integrasi terkelola.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	Kesalahan yang terjadi pada runtime integrasi ini.

SelfHostedIntegrationRuntimeNode

Properti simpul runtime integrasi yang dihost sendiri.

Name	Type	Description
capabilities	object	Kamus kemampuan runtime integrasi
concurrentJobsLimit	integer	Pekerjaan bersamaan maksimum pada simpul runtime integrasi.
expiryTime	string	Waktu di mana runtime integrasi akan kedaluwarsa dalam format ISO8601.
hostServiceUri	string	URI untuk komputer host runtime integrasi.
isActiveDispatcher	boolean	Menunjukkan apakah simpul ini adalah dispatcher aktif untuk permintaan runtime integrasi.
lastConnectTime	string	Waktu terbaru saat runtime integrasi tersambung dalam format ISO8601.
lastEndUpdateTime	string	Terakhir kali untuk akhir pembaruan node runtime integrasi.
lastStartTime	string	Waktu simpul terakhir dimulai.
lastStartUpdateTime	string	Terakhir kali untuk mulai pembaruan simpul runtime integrasi.
lastStopTime	string	Waktu henti simpul runtime integrasi terakhir.
lastUpdateResult	IntegrationRuntimeUpdateResult	Hasil dari pembaruan simpul runtime integrasi terakhir.
machineName	string	Nama mesin simpul runtime integrasi.
maxConcurrentJobs	integer	Pekerjaan bersamaan maksimum dalam runtime integrasi ini.
nodeName	string	Nama simpul runtime integrasi.
registerTime	string	Waktu saat simpul runtime integrasi terdaftar dalam format ISO8601.
status	SelfHostedIntegrationRuntimeNodeStatus	Status simpul runtime integrasi.
version	string	Versi simpul runtime integrasi.
versionStatus	string	Status versi node runtime integrasi.

SelfHostedIntegrationRuntimeNodeStatus

Status simpul runtime integrasi.

Name	Type	Description
InitializeFailed	string
Initializing	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Upgrading	string

SelfHostedIntegrationRuntimeStatus

Status runtime integrasi yang dihost sendiri.

Name	Type	Description
dataFactoryName	string	Nama ruang kerja tempat runtime integrasi berada.
state	IntegrationRuntimeState	Status runtime integrasi.
type	string: SelfHosted	Jenis runtime integrasi.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Apakah pembaruan otomatis runtime integrasi yang dihost sendiri telah diaktifkan.
typeProperties.autoUpdateETA	string	Perkiraan waktu saat runtime integrasi yang dihost sendiri akan diperbarui.
typeProperties.capabilities	object	Objek dengan informasi tambahan tentang kemampuan runtime integrasi.
typeProperties.createTime	string	Waktu saat runtime integrasi dibuat, dalam format ISO8601.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	Ini digunakan untuk mengatur mode enkripsi untuk saluran komunikasi node-node (ketika ada lebih dari 2 simpul runtime integrasi yang dihost sendiri).
typeProperties.latestVersion	string	Versi terbaru pada pusat unduhan.
typeProperties.links	LinkedIntegrationRuntime[]	Daftar runtime integrasi tertaut yang dibuat untuk dibagikan dengan runtime integrasi ini.
typeProperties.localTimeZoneOffset	string	Offset zona waktu lokal dalam jam.
typeProperties.newerVersions	string[]	Versi yang lebih baru pada pusat unduhan.
typeProperties.nodeCommunicationChannelEncryptionMode	string	Mode enkripsi Saluran komunikasi simpul
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	Daftar simpul untuk runtime integrasi ini.
typeProperties.pushedVersion	string	Versi yang akan diperbarui oleh runtime integrasi.
typeProperties.scheduledUpdateDate	string	Tanggal di mana runtime integrasi akan dijadwalkan untuk diperbarui, dalam format ISO8601.
typeProperties.serviceRegion	string	Wilayah layanan runtime integrasi
typeProperties.serviceUrls	string[]	URL untuk layanan yang digunakan dalam layanan backend runtime integrasi.
typeProperties.taskQueueId	string	Id antrean tugas dari runtime integrasi.
typeProperties.updateDelayOffset	string	Waktu dalam tanggal yang dijadwalkan oleh layanan untuk memperbarui runtime integrasi, misalnya, PT03H adalah 3 jam
typeProperties.version	string	Versi runtime integrasi.
typeProperties.versionStatus	string	Status versi runtime integrasi.