SynapseIntegrationRuntimeResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Class representing a SynapseIntegrationRuntime along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SynapseIntegrationRuntimeResource from an instance of ArmClient using the GetSynapseIntegrationRuntimeResource method. Otherwise you can get one from its parent resource SynapseWorkspaceResource using the GetSynapseIntegrationRuntime method.
public class SynapseIntegrationRuntimeResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Synapse.SynapseIntegrationRuntimeData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Synapse.SynapseIntegrationRuntimeData>public class SynapseIntegrationRuntimeResource : Azure.ResourceManager.ArmResourcetype SynapseIntegrationRuntimeResource = class
inherit ArmResource
interface IJsonModel<SynapseIntegrationRuntimeData>
interface IPersistableModel<SynapseIntegrationRuntimeData>type SynapseIntegrationRuntimeResource = class
inherit ArmResourcePublic Class SynapseIntegrationRuntimeResource
Inherits ArmResource
Implements IJsonModel(Of SynapseIntegrationRuntimeData), IPersistableModel(Of SynapseIntegrationRuntimeData)Public Class SynapseIntegrationRuntimeResource
Inherits ArmResource- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| SynapseIntegrationRuntimeResource() |
Initializes a new instance of the SynapseIntegrationRuntimeResource class for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String, String) |
Generate the resource identifier of a SynapseIntegrationRuntimeResource instance. |
| Delete(WaitUntil, CancellationToken) |
Delete an integration runtime
|
| DeleteAsync(WaitUntil, CancellationToken) |
Delete an integration runtime
|
| DeleteIntegrationRuntimeNode(String, CancellationToken) |
Delete an integration runtime node
|
| DeleteIntegrationRuntimeNodeAsync(String, CancellationToken) |
Delete an integration runtime node
|
| DisableInteractiveQuery(WaitUntil, CancellationToken) |
Disable interactive query in integration runtime
|
| DisableInteractiveQueryAsync(WaitUntil, CancellationToken) |
Disable interactive query in integration runtime
|
| EnableInteractiveQuery(WaitUntil, CancellationToken) |
Enable interactive query in integration runtime
|
| EnableInteractiveQueryAsync(WaitUntil, CancellationToken) |
Enable interactive query in integration runtime
|
| Get(String, CancellationToken) |
Get an integration runtime
|
| GetAllIntegrationRuntimeObjectMetadata(SynapseGetSsisObjectMetadataContent, CancellationToken) |
Get object metadata from an integration runtime
|
| GetAllIntegrationRuntimeObjectMetadataAsync(SynapseGetSsisObjectMetadataContent, CancellationToken) |
Get object metadata from an integration runtime
|
| GetAsync(String, CancellationToken) |
Get an integration runtime
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetIntegrationRuntimeAuthKey(CancellationToken) |
List authentication keys in an integration runtime
|
| GetIntegrationRuntimeAuthKeyAsync(CancellationToken) |
List authentication keys in an integration runtime
|
| GetIntegrationRuntimeConnectionInfo(CancellationToken) |
Get connection info for an integration runtime
|
| GetIntegrationRuntimeConnectionInfoAsync(CancellationToken) |
Get connection info for an integration runtime
|
| GetIntegrationRuntimeMonitoringData(CancellationToken) |
Get monitoring data for an integration runtime
|
| GetIntegrationRuntimeMonitoringDataAsync(CancellationToken) |
Get monitoring data for an integration runtime
|
| GetIntegrationRuntimeNode(String, CancellationToken) |
Get an integration runtime node
|
| GetIntegrationRuntimeNodeAsync(String, CancellationToken) |
Get an integration runtime node
|
| GetIntegrationRuntimeNodeIPAddress(String, CancellationToken) |
Get the IP address of an integration runtime node
|
| GetIntegrationRuntimeNodeIPAddressAsync(String, CancellationToken) |
Get the IP address of an integration runtime node
|
| GetIntegrationRuntimeStatus(CancellationToken) |
Get the integration runtime status
|
| GetIntegrationRuntimeStatusAsync(CancellationToken) |
Get the integration runtime status
|
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetOutboundNetworkDependenciesEndpoints(CancellationToken) |
Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
|
| GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken) |
Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
|
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| RefreshIntegrationRuntimeObjectMetadata(WaitUntil, CancellationToken) |
Refresh the object metadata in an integration runtime
|
| RefreshIntegrationRuntimeObjectMetadataAsync(WaitUntil, CancellationToken) |
Refresh the object metadata in an integration runtime
|
| RegenerateIntegrationRuntimeAuthKey(IntegrationRuntimeRegenerateKeyContent, CancellationToken) |
Regenerate the authentication key for an integration runtime
|
| RegenerateIntegrationRuntimeAuthKeyAsync(IntegrationRuntimeRegenerateKeyContent, CancellationToken) |
Regenerate the authentication key for an integration runtime
|
| Start(WaitUntil, CancellationToken) |
Start an integration runtime
|
| StartAsync(WaitUntil, CancellationToken) |
Start an integration runtime
|
| Stop(WaitUntil, CancellationToken) |
Stop an integration runtime
|
| StopAsync(WaitUntil, CancellationToken) |
Stop an integration runtime
|
| SyncIntegrationRuntimeCredential(CancellationToken) |
Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.
|
| SyncIntegrationRuntimeCredentialAsync(CancellationToken) |
Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(SynapseIntegrationRuntimePatch, CancellationToken) |
Update an integration runtime
|
| UpdateAsync(SynapseIntegrationRuntimePatch, CancellationToken) |
Update an integration runtime
|
| UpdateIntegrationRuntimeNode(String, UpdateIntegrationRuntimeNodeContent, CancellationToken) |
Create an integration runtime node
|
| UpdateIntegrationRuntimeNodeAsync(String, UpdateIntegrationRuntimeNodeContent, CancellationToken) |
Create an integration runtime node
|
| Upgrade(CancellationToken) |
Upgrade an integration runtime
|
| UpgradeAsync(CancellationToken) |
Upgrade an integration runtime
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SynapseIntegrationRuntimeData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SynapseIntegrationRuntimeData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SynapseIntegrationRuntimeData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SynapseIntegrationRuntimeData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SynapseIntegrationRuntimeData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
