Workspace Managed Identity Sql Control Settings - Create Or Update

Create or update Managed Identity Sql Control Settings

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/managedIdentitySqlControlSettings/default?api-version=2021-06-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

workspaceName
path True

string

The name of the workspace.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Type Description
properties.grantSqlControlToManagedIdentity

GrantSqlControlToManagedIdentity

Grant sql control to managed identity

Responses

Name Type Description
200 OK

ManagedIdentitySqlControlSettingsModel

OK

201 Created

ManagedIdentitySqlControlSettingsModel

Created

Other Status Codes

ErrorResponse

Error

Examples

Create or update managed identity sql control settings

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/managedIdentitySqlControlSettings/default?api-version=2021-06-01

{
  "properties": {
    "grantSqlControlToManagedIdentity": {
      "desiredState": "Enabled"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/managedIdentitySqlControlSettings/default",
  "name": "default",
  "properties": {
    "grantSqlControlToManagedIdentity": {
      "desiredState": "Enabled",
      "actualState": "Enabling"
    }
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/managedIdentitySqlControlSettings/default",
  "name": "default",
  "properties": {
    "grantSqlControlToManagedIdentity": {
      "desiredState": "Enabled",
      "actualState": "Enabling"
    }
  }
}

Definitions

Name Description
ActualState

Actual state

DesiredState

Desired state

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GrantSqlControlToManagedIdentity

Grant sql control to managed identity

ManagedIdentitySqlControlSettingsModel

Managed Identity Sql Control Settings

ActualState

Actual state

Name Type Description
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Unknown

string

DesiredState

Desired state

Name Type Description
Disabled

string

Enabled

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GrantSqlControlToManagedIdentity

Grant sql control to managed identity

Name Type Description
actualState

ActualState

Actual state

desiredState

DesiredState

Desired state

ManagedIdentitySqlControlSettingsModel

Managed Identity Sql Control Settings

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.grantSqlControlToManagedIdentity

GrantSqlControlToManagedIdentity

Grant sql control to managed identity

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"