Share via

SynapseWorkspaceResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Synapse
Assembly:
Azure.ResourceManager.Synapse.dll
Package:
Azure.ResourceManager.Synapse v1.2.0
Package:
Azure.ResourceManager.Synapse v1.2.0-beta.1
Source:
SynapseWorkspaceResource.cs
Source:
SynapseWorkspaceResource.cs

A Class representing a SynapseWorkspace along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SynapseWorkspaceResource from an instance of ArmClient using the GetSynapseWorkspaceResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetSynapseWorkspace method.

public class SynapseWorkspaceResource : Azure.ResourceManager.ArmResource
type SynapseWorkspaceResource = class
    inherit ArmResource
Public Class SynapseWorkspaceResource
Inherits ArmResource
Inheritance
Object
ArmResource
SynapseWorkspaceResource

Constructors

SynapseWorkspaceResource()

Initializes a new instance of the SynapseWorkspaceResource 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

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
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)

Generate the resource identifier of a SynapseWorkspaceResource instance.
Delete(WaitUntil, CancellationToken)

Deletes a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Delete
DeleteAsync(WaitUntil, CancellationToken)

Deletes a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Delete
Get(CancellationToken)

Gets a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
GetAsync(CancellationToken)

Gets a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
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)
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)
GetSynapseAadOnlyAuthentication(SynapseAadOnlyAuthenticationName, CancellationToken)

Gets a Azure Active Directory only authentication property

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/azureADOnlyAuthentications/{azureADOnlyAuthenticationName}
  • Operation Id: AzureADOnlyAuthentications_Get
GetSynapseAadOnlyAuthenticationAsync(SynapseAadOnlyAuthenticationName, CancellationToken)

Gets a Azure Active Directory only authentication property

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/azureADOnlyAuthentications/{azureADOnlyAuthenticationName}
  • Operation Id: AzureADOnlyAuthentications_Get
GetSynapseAadOnlyAuthentications()

Gets a collection of SynapseAadOnlyAuthenticationResources in the SynapseWorkspace.
GetSynapseBigDataPoolInfo(String, CancellationToken)

Get a Big Data pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}
  • Operation Id: BigDataPools_Get
GetSynapseBigDataPoolInfoAsync(String, CancellationToken)

Get a Big Data pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}
  • Operation Id: BigDataPools_Get
GetSynapseBigDataPoolInfos()

Gets a collection of SynapseBigDataPoolInfoResources in the SynapseWorkspace.
GetSynapseDedicatedSqlMinimalTlsSetting(String, CancellationToken)

Get workspace managed sql server's minimal tls settings.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/dedicatedSQLminimalTlsSettings/{dedicatedSQLminimalTlsSettingsName}
  • Operation Id: WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettings_Get
GetSynapseDedicatedSqlMinimalTlsSettingAsync(String, CancellationToken)

Get workspace managed sql server's minimal tls settings.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/dedicatedSQLminimalTlsSettings/{dedicatedSQLminimalTlsSettingsName}
  • Operation Id: WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettings_Get
GetSynapseDedicatedSqlMinimalTlsSettings()

Gets a collection of SynapseDedicatedSqlMinimalTlsSettingResources in the SynapseWorkspace.
GetSynapseEncryptionProtector(SynapseEncryptionProtectorName, CancellationToken)

Get workspace managed sql server's encryption protector.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector/{encryptionProtectorName}
  • Operation Id: WorkspaceManagedSqlServerEncryptionProtector_Get
GetSynapseEncryptionProtectorAsync(SynapseEncryptionProtectorName, CancellationToken)

Get workspace managed sql server's encryption protector.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector/{encryptionProtectorName}
  • Operation Id: WorkspaceManagedSqlServerEncryptionProtector_Get
GetSynapseEncryptionProtectors()

Gets a collection of SynapseEncryptionProtectorResources in the SynapseWorkspace.
GetSynapseExtendedServerBlobAuditingPolicies()

Gets a collection of SynapseExtendedServerBlobAuditingPolicyResources in the SynapseWorkspace.
GetSynapseExtendedServerBlobAuditingPolicy(SynapseBlobAuditingPolicyName, CancellationToken)

Get a workspace SQL server's extended blob auditing policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/extendedAuditingSettings/{blobAuditingPolicyName}
  • Operation Id: WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_Get
GetSynapseExtendedServerBlobAuditingPolicyAsync(SynapseBlobAuditingPolicyName, CancellationToken)

Get a workspace SQL server's extended blob auditing policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/extendedAuditingSettings/{blobAuditingPolicyName}
  • Operation Id: WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_Get
GetSynapseIntegrationRuntime(String, String, CancellationToken)

Get an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Get
GetSynapseIntegrationRuntimeAsync(String, String, CancellationToken)

Get an integration runtime

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}
  • Operation Id: IntegrationRuntimes_Get
GetSynapseIntegrationRuntimes()

Gets a collection of SynapseIntegrationRuntimeResources in the SynapseWorkspace.
GetSynapseIPFirewallRuleInfo(String, CancellationToken)

Get a firewall rule

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/firewallRules/{ruleName}
  • Operation Id: IpFirewallRules_Get
GetSynapseIPFirewallRuleInfoAsync(String, CancellationToken)

Get a firewall rule

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/firewallRules/{ruleName}
  • Operation Id: IpFirewallRules_Get
GetSynapseIPFirewallRuleInfos()

Gets a collection of SynapseIPFirewallRuleInfoResources in the SynapseWorkspace.
GetSynapseKey(String, CancellationToken)

Gets a workspace key

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}
  • Operation Id: Keys_Get
GetSynapseKeyAsync(String, CancellationToken)

Gets a workspace key

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}
  • Operation Id: Keys_Get
GetSynapseKeys()

Gets a collection of SynapseKeyResources in the SynapseWorkspace.
GetSynapseKustoPool(String, CancellationToken)

Gets a Kusto pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}
  • Operation Id: KustoPools_Get
GetSynapseKustoPoolAsync(String, CancellationToken)

Gets a Kusto pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}
  • Operation Id: KustoPools_Get
GetSynapseKustoPools()

Gets a collection of SynapseKustoPoolResources in the SynapseWorkspace.
GetSynapseLibraries()

Gets a collection of SynapseLibraryResources in the SynapseWorkspace.
GetSynapseLibrary(String, CancellationToken)

Get library by name in a workspace.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries/{libraryName}
  • Operation Id: Library_Get
GetSynapseLibraryAsync(String, CancellationToken)

Get library by name in a workspace.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries/{libraryName}
  • Operation Id: Library_Get
GetSynapseManagedIdentitySqlControlSetting()

Gets an object representing a SynapseManagedIdentitySqlControlSettingResource along with the instance operations that can be performed on it in the SynapseWorkspace.
GetSynapsePrivateEndpointConnection(String, CancellationToken)

Gets a private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
GetSynapsePrivateEndpointConnectionAsync(String, CancellationToken)

Gets a private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
GetSynapsePrivateEndpointConnections()

Gets a collection of SynapsePrivateEndpointConnectionResources in the SynapseWorkspace.
GetSynapseRecoverableSqlPool(String, CancellationToken)

Get recoverable sql pools for workspace managed sql server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlPools/{sqlPoolName}
  • Operation Id: WorkspaceManagedSqlServerRecoverableSqlPools_Get
GetSynapseRecoverableSqlPoolAsync(String, CancellationToken)

Get recoverable sql pools for workspace managed sql server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlPools/{sqlPoolName}
  • Operation Id: WorkspaceManagedSqlServerRecoverableSqlPools_Get
GetSynapseRecoverableSqlPools()

Gets a collection of SynapseRecoverableSqlPoolResources in the SynapseWorkspace.
GetSynapseRestorableDroppedSqlPool(String, CancellationToken)

Gets a deleted sql pool that can be restored

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/restorableDroppedSqlPools/{restorableDroppedSqlPoolId}
  • Operation Id: RestorableDroppedSqlPools_Get
GetSynapseRestorableDroppedSqlPoolAsync(String, CancellationToken)

Gets a deleted sql pool that can be restored

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/restorableDroppedSqlPools/{restorableDroppedSqlPoolId}
  • Operation Id: RestorableDroppedSqlPools_Get
GetSynapseRestorableDroppedSqlPools()

Gets a collection of SynapseRestorableDroppedSqlPoolResources in the SynapseWorkspace.
GetSynapseServerBlobAuditingPolicies()

Gets a collection of SynapseServerBlobAuditingPolicyResources in the SynapseWorkspace.
GetSynapseServerBlobAuditingPolicy(SynapseBlobAuditingPolicyName, CancellationToken)

Get a workspace managed sql server's blob auditing policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/auditingSettings/{blobAuditingPolicyName}
  • Operation Id: WorkspaceManagedSqlServerBlobAuditingPolicies_Get
GetSynapseServerBlobAuditingPolicyAsync(SynapseBlobAuditingPolicyName, CancellationToken)

Get a workspace managed sql server's blob auditing policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/auditingSettings/{blobAuditingPolicyName}
  • Operation Id: WorkspaceManagedSqlServerBlobAuditingPolicies_Get
GetSynapseServerSecurityAlertPolicies()

Gets a collection of SynapseServerSecurityAlertPolicyResources in the SynapseWorkspace.
GetSynapseServerSecurityAlertPolicy(SqlServerSecurityAlertPolicyName, CancellationToken)

Get a workspace managed sql server's security alert policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/securityAlertPolicies/{securityAlertPolicyName}
  • Operation Id: WorkspaceManagedSqlServerSecurityAlertPolicy_Get
GetSynapseServerSecurityAlertPolicyAsync(SqlServerSecurityAlertPolicyName, CancellationToken)

Get a workspace managed sql server's security alert policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/securityAlertPolicies/{securityAlertPolicyName}
  • Operation Id: WorkspaceManagedSqlServerSecurityAlertPolicy_Get
GetSynapseServerVulnerabilityAssessment(SynapseVulnerabilityAssessmentName, CancellationToken)

Get workspace managed sql server's vulnerability assessment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
  • Operation Id: WorkspaceManagedSqlServerVulnerabilityAssessments_Get
GetSynapseServerVulnerabilityAssessmentAsync(SynapseVulnerabilityAssessmentName, CancellationToken)

Get workspace managed sql server's vulnerability assessment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
  • Operation Id: WorkspaceManagedSqlServerVulnerabilityAssessments_Get
GetSynapseServerVulnerabilityAssessments()

Gets a collection of SynapseServerVulnerabilityAssessmentResources in the SynapseWorkspace.
GetSynapseSparkConfiguration(String, CancellationToken)

Get SparkConfiguration by name in a workspace.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sparkconfigurations/{sparkConfigurationName}
  • Operation Id: SparkConfiguration_Get
GetSynapseSparkConfigurationAsync(String, CancellationToken)

Get SparkConfiguration by name in a workspace.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sparkconfigurations/{sparkConfigurationName}
  • Operation Id: SparkConfiguration_Get
GetSynapseSparkConfigurations()

Gets a collection of SynapseSparkConfigurationResources in the SynapseWorkspace.
GetSynapseSqlPool(String, CancellationToken)

Get SQL pool properties

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}
  • Operation Id: SqlPools_Get
GetSynapseSqlPoolAsync(String, CancellationToken)

Get SQL pool properties

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}
  • Operation Id: SqlPools_Get
GetSynapseSqlPools()

Gets a collection of SynapseSqlPoolResources in the SynapseWorkspace.
GetSynapseWorkspaceAdministratorResource()

Gets an object representing a SynapseWorkspaceAdministratorResource along with the instance operations that can be performed on it in the SynapseWorkspace.
GetSynapseWorkspacePrivateLinkResource(String, CancellationToken)

Get private link resource in workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateLinkResources/{privateLinkResourceName}
  • Operation Id: PrivateLinkResources_Get
GetSynapseWorkspacePrivateLinkResourceAsync(String, CancellationToken)

Get private link resource in workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateLinkResources/{privateLinkResourceName}
  • Operation Id: PrivateLinkResources_Get
GetSynapseWorkspacePrivateLinkResources()

Gets a collection of SynapseWorkspacePrivateLinkResources in the SynapseWorkspace.
GetSynapseWorkspaceSqlAdministratorResource()

Gets an object representing a SynapseWorkspaceSqlAdministratorResource along with the instance operations that can be performed on it in the SynapseWorkspace.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetWorkspaceManagedSqlServerUsages(CancellationToken)

Get list of server usages metric for workspace managed sql server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlUsages
  • Operation Id: WorkspaceManagedSqlServerUsages_List
GetWorkspaceManagedSqlServerUsagesAsync(CancellationToken)

Get list of server usages metric for workspace managed sql server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlUsages
  • Operation Id: WorkspaceManagedSqlServerUsages_List
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
ReplaceAllIpFirewallRule(WaitUntil, ReplaceAllIPFirewallRulesContent, CancellationToken)

Replaces firewall rules

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/replaceAllIpFirewallRules
  • Operation Id: IpFirewallRules_ReplaceAll
ReplaceAllIpFirewallRuleAsync(WaitUntil, ReplaceAllIPFirewallRulesContent, CancellationToken)

Replaces firewall rules

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/replaceAllIpFirewallRules
  • Operation Id: IpFirewallRules_ReplaceAll
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, SynapseWorkspacePatch, CancellationToken)

Updates a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Update
UpdateAsync(WaitUntil, SynapseWorkspacePatch, CancellationToken)

Updates a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Update

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
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

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

Applies to