Поделиться через


SynapseIntegrationRuntimeResource Class

Definition

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.ArmResource
type SynapseIntegrationRuntimeResource = class
    inherit ArmResource
    interface IJsonModel<SynapseIntegrationRuntimeData>
    interface IPersistableModel<SynapseIntegrationRuntimeData>
type SynapseIntegrationRuntimeResource = class
    inherit ArmResource
Public Class SynapseIntegrationRuntimeResource
Inherits ArmResource
Implements IJsonModel(Of SynapseIntegrationRuntimeData), IPersistableModel(Of SynapseIntegrationRuntimeData)
Public Class SynapseIntegrationRuntimeResource
Inherits ArmResource
Inheritance
SynapseIntegrationRuntimeResource
Implements

Constructors

SynapseIntegrationRuntimeResource()

Initializes a new instance of the SynapseIntegrationRuntimeResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

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

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Delete
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
DeleteAsync(WaitUntil, CancellationToken)

Delete an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Delete
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
DeleteIntegrationRuntimeNode(String, CancellationToken)

Delete an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
  • Operation Id: IntegrationRuntimeNodes_Delete
  • Default Api Version: 2021-06-01-preview
DeleteIntegrationRuntimeNodeAsync(String, CancellationToken)

Delete an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
  • Operation Id: IntegrationRuntimeNodes_Delete
  • Default Api Version: 2021-06-01-preview
DisableInteractiveQuery(WaitUntil, CancellationToken)

Disable interactive query in integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/disableInteractiveQuery
  • Operation Id: IntegrationRuntimes_DisableInteractiveQuery
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
DisableInteractiveQueryAsync(WaitUntil, CancellationToken)

Disable interactive query in integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/disableInteractiveQuery
  • Operation Id: IntegrationRuntimes_DisableInteractiveQuery
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
EnableInteractiveQuery(WaitUntil, CancellationToken)

Enable interactive query in integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/enableInteractiveQuery
  • Operation Id: IntegrationRuntimes_EnableInteractiveQuery
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
EnableInteractiveQueryAsync(WaitUntil, CancellationToken)

Enable interactive query in integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/enableInteractiveQuery
  • Operation Id: IntegrationRuntimes_EnableInteractiveQuery
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
Get(String, CancellationToken)

Get an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Get
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
GetAllIntegrationRuntimeObjectMetadata(SynapseGetSsisObjectMetadataContent, CancellationToken)

Get object metadata from an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata
  • Operation Id: IntegrationRuntimeObjectMetadata_List
  • Default Api Version: 2021-06-01-preview
GetAllIntegrationRuntimeObjectMetadataAsync(SynapseGetSsisObjectMetadataContent, CancellationToken)

Get object metadata from an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata
  • Operation Id: IntegrationRuntimeObjectMetadata_List
  • Default Api Version: 2021-06-01-preview
GetAsync(String, CancellationToken)

Get an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Get
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys
  • Operation Id: IntegrationRuntimeAuthKeys_List
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeAuthKeyAsync(CancellationToken)

List authentication keys in an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys
  • Operation Id: IntegrationRuntimeAuthKeys_List
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeConnectionInfo(CancellationToken)

Get connection info for an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo
  • Operation Id: IntegrationRuntimeConnectionInfos_Get
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeConnectionInfoAsync(CancellationToken)

Get connection info for an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo
  • Operation Id: IntegrationRuntimeConnectionInfos_Get
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeMonitoringData(CancellationToken)

Get monitoring data for an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/monitoringData
  • Operation Id: IntegrationRuntimeMonitoringData_List
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeMonitoringDataAsync(CancellationToken)

Get monitoring data for an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/monitoringData
  • Operation Id: IntegrationRuntimeMonitoringData_List
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeNode(String, CancellationToken)

Get an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
  • Operation Id: IntegrationRuntimeNodes_Get
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeNodeAsync(String, CancellationToken)

Get an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
  • Operation Id: IntegrationRuntimeNodes_Get
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeNodeIPAddress(String, CancellationToken)

Get the IP address of an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress
  • Operation Id: IntegrationRuntimeNodeIpAddress_Get
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeNodeIPAddressAsync(String, CancellationToken)

Get the IP address of an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress
  • Operation Id: IntegrationRuntimeNodeIpAddress_Get
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeStatus(CancellationToken)

Get the integration runtime status

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getStatus
  • Operation Id: IntegrationRuntimeStatus_Get
  • Default Api Version: 2021-06-01-preview
GetIntegrationRuntimeStatusAsync(CancellationToken)

Get the integration runtime status

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getStatus
  • Operation Id: IntegrationRuntimeStatus_Get
  • Default Api Version: 2021-06-01-preview
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints
  • Operation Id: IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken)

Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints
  • Operation Id: IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata
  • Operation Id: IntegrationRuntimeObjectMetadata_Refresh
  • Default Api Version: 2021-06-01-preview
RefreshIntegrationRuntimeObjectMetadataAsync(WaitUntil, CancellationToken)

Refresh the object metadata in an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata
  • Operation Id: IntegrationRuntimeObjectMetadata_Refresh
  • Default Api Version: 2021-06-01-preview
RegenerateIntegrationRuntimeAuthKey(IntegrationRuntimeRegenerateKeyContent, CancellationToken)

Regenerate the authentication key for an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey
  • Operation Id: IntegrationRuntimeAuthKeys_Regenerate
  • Default Api Version: 2021-06-01-preview
RegenerateIntegrationRuntimeAuthKeyAsync(IntegrationRuntimeRegenerateKeyContent, CancellationToken)

Regenerate the authentication key for an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey
  • Operation Id: IntegrationRuntimeAuthKeys_Regenerate
  • Default Api Version: 2021-06-01-preview
Start(WaitUntil, CancellationToken)

Start an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start
  • Operation Id: IntegrationRuntimes_Start
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
StartAsync(WaitUntil, CancellationToken)

Start an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start
  • Operation Id: IntegrationRuntimes_Start
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
Stop(WaitUntil, CancellationToken)

Stop an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/stop
  • Operation Id: IntegrationRuntimes_Stop
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
StopAsync(WaitUntil, CancellationToken)

Stop an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/stop
  • Operation Id: IntegrationRuntimes_Stop
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials
  • Operation Id: IntegrationRuntimeCredentials_Sync
  • Default Api Version: 2021-06-01-preview
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials
  • Operation Id: IntegrationRuntimeCredentials_Sync
  • Default Api Version: 2021-06-01-preview
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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Update
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
UpdateAsync(SynapseIntegrationRuntimePatch, CancellationToken)

Update an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Update
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
UpdateIntegrationRuntimeNode(String, UpdateIntegrationRuntimeNodeContent, CancellationToken)

Create an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
  • Operation Id: IntegrationRuntimeNodes_Update
  • Default Api Version: 2021-06-01-preview
UpdateIntegrationRuntimeNodeAsync(String, UpdateIntegrationRuntimeNodeContent, CancellationToken)

Create an integration runtime node

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
  • Operation Id: IntegrationRuntimeNodes_Update
  • Default Api Version: 2021-06-01-preview
Upgrade(CancellationToken)

Upgrade an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/upgrade
  • Operation Id: IntegrationRuntimes_Upgrade
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource
UpgradeAsync(CancellationToken)

Upgrade an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/upgrade
  • Operation Id: IntegrationRuntimes_Upgrade
  • Default Api Version: 2021-06-01-preview
  • Resource: SynapseIntegrationRuntimeResource

Explicit Interface Implementations

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.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to