SynapseDatabaseResource Class

Definition

Namespace:: Azure.ResourceManager.Synapse

Assembly:: Azure.ResourceManager.Synapse.dll

Package:: Azure.ResourceManager.Synapse v1.2.2

Package:: Azure.ResourceManager.Synapse v1.2.0-beta.1

Source:: SynapseDatabaseResource.cs

Source:: SynapseDatabaseResource.cs

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 SynapseDatabase along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SynapseDatabaseResource from an instance of ArmClient using the GetSynapseDatabaseResource method. Otherwise you can get one from its parent resource SynapseKustoPoolResource using the GetSynapseDatabase method.

public class SynapseDatabaseResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Synapse.SynapseDatabaseData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Synapse.SynapseDatabaseData>

public class SynapseDatabaseResource : Azure.ResourceManager.ArmResource

type SynapseDatabaseResource = class
    inherit ArmResource
    interface IJsonModel<SynapseDatabaseData>
    interface IPersistableModel<SynapseDatabaseData>

type SynapseDatabaseResource = class
    inherit ArmResource

Public Class SynapseDatabaseResource
Inherits ArmResource
Implements IJsonModel(Of SynapseDatabaseData), IPersistableModel(Of SynapseDatabaseData)

Public Class SynapseDatabaseResource
Inherits ArmResource

Inheritance: Object

ArmResource
SynapseDatabaseResource

Implements: IJsonModel<SynapseDatabaseData> IPersistableModel<SynapseDatabaseData> IPersistableModel<T>

Constructors

Name	Description
SynapseDatabaseResource()	Initializes a new instance of the SynapseDatabaseResource 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)
CheckKustoPoolDatabasePrincipalAssignmentNameAvailability(KustoPoolDatabasePrincipalAssignmentNameAvailabilityContent, CancellationToken)	Checks that the database principal assignment is valid and is not already in use. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/checkPrincipalAssignmentNameAvailability Operation Id: KustoPoolDatabasePrincipalAssignments_CheckNameAvailability Default Api Version: 2021-06-01-preview Resource: SynapseDatabasePrincipalAssignmentResource
CheckKustoPoolDatabasePrincipalAssignmentNameAvailabilityAsync(KustoPoolDatabasePrincipalAssignmentNameAvailabilityContent, CancellationToken)	Checks that the database principal assignment is valid and is not already in use. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/checkPrincipalAssignmentNameAvailability Operation Id: KustoPoolDatabasePrincipalAssignments_CheckNameAvailability Default Api Version: 2021-06-01-preview Resource: SynapseDatabasePrincipalAssignmentResource
CheckKustoPoolDataConnectionNameAvailability(KustoPoolDataConnectionNameAvailabilityContent, CancellationToken)	Checks that the data connection name is valid and is not already in use. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/checkNameAvailability Operation Id: KustoPoolDataConnections_CheckNameAvailability Default Api Version: 2021-06-01-preview Resource: SynapseDataConnectionResource
CheckKustoPoolDataConnectionNameAvailabilityAsync(KustoPoolDataConnectionNameAvailabilityContent, CancellationToken)	Checks that the data connection name is valid and is not already in use. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/checkNameAvailability Operation Id: KustoPoolDataConnections_CheckNameAvailability Default Api Version: 2021-06-01-preview Resource: SynapseDataConnectionResource
CreateResourceIdentifier(String, String, String, String, String)	Generate the resource identifier of a SynapseDatabaseResource instance.
Delete(WaitUntil, CancellationToken)	Deletes the database with the given name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName} Operation Id: KustoPoolDatabases_Delete Default Api Version: 2021-06-01-preview Resource: SynapseDatabaseResource
DeleteAsync(WaitUntil, CancellationToken)	Deletes the database with the given name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName} Operation Id: KustoPoolDatabases_Delete Default Api Version: 2021-06-01-preview Resource: SynapseDatabaseResource
Get(CancellationToken)	Returns a database. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName} Operation Id: KustoPoolDatabases_Get Default Api Version: 2021-06-01-preview Resource: SynapseDatabaseResource
GetAsync(CancellationToken)	Returns a database. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName} Operation Id: KustoPoolDatabases_Get Default Api Version: 2021-06-01-preview Resource: SynapseDatabaseResource
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)
GetSynapseDatabasePrincipalAssignment(String, CancellationToken)	Gets a Kusto pool database principalAssignment. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/principalAssignments/{principalAssignmentName} Operation Id: KustoPoolDatabasePrincipalAssignments_Get Default Api Version: 2021-06-01-preview Resource: SynapseDatabasePrincipalAssignmentResource
GetSynapseDatabasePrincipalAssignmentAsync(String, CancellationToken)	Gets a Kusto pool database principalAssignment. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/principalAssignments/{principalAssignmentName} Operation Id: KustoPoolDatabasePrincipalAssignments_Get Default Api Version: 2021-06-01-preview Resource: SynapseDatabasePrincipalAssignmentResource
GetSynapseDatabasePrincipalAssignments()	Gets a collection of SynapseDatabasePrincipalAssignmentResources in the SynapseDatabase.
GetSynapseDataConnection(String, CancellationToken)	Returns a data connection. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/dataConnections/{dataConnectionName} Operation Id: KustoPoolDataConnections_Get Default Api Version: 2021-06-01-preview Resource: SynapseDataConnectionResource
GetSynapseDataConnectionAsync(String, CancellationToken)	Returns a data connection. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/dataConnections/{dataConnectionName} Operation Id: KustoPoolDataConnections_Get Default Api Version: 2021-06-01-preview Resource: SynapseDataConnectionResource
GetSynapseDataConnections()	Gets a collection of SynapseDataConnectionResources in the SynapseDatabase.
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, SynapseDatabaseData, CancellationToken)	Updates a database. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName} Operation Id: KustoPoolDatabases_Update Default Api Version: 2021-06-01-preview Resource: SynapseDatabaseResource
UpdateAsync(WaitUntil, SynapseDatabaseData, CancellationToken)	Updates a database. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName} Operation Id: KustoPoolDatabases_Update Default Api Version: 2021-06-01-preview Resource: SynapseDatabaseResource
ValidateDataConnection(WaitUntil, SynapseDataConnectionValidation, CancellationToken)	Checks that the data connection parameters are valid. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/dataConnectionValidation Operation Id: KustoPoolDataConnections_DataConnectionValidation Default Api Version: 2021-06-01-preview Resource: SynapseDataConnectionResource
ValidateDataConnectionAsync(WaitUntil, SynapseDataConnectionValidation, CancellationToken)	Checks that the data connection parameters are valid. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/dataConnectionValidation Operation Id: KustoPoolDataConnections_DataConnectionValidation Default Api Version: 2021-06-01-preview Resource: SynapseDataConnectionResource

Explicit Interface Implementations

Name	Description
IJsonModel<SynapseDatabaseData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<SynapseDatabaseData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<SynapseDatabaseData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<SynapseDatabaseData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<SynapseDatabaseData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
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 <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
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 <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Feedback

Was this page helpful?