Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/synapse-access-control

Package version

Index

Type aliases

AccessControlClientCreateRoleAssignmentResponse

AccessControlClientCreateRoleAssignmentResponse: RoleAssignmentDetails & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: RoleAssignmentDetails } }

Contains response data for the createRoleAssignment operation.

AccessControlClientGetCallerRoleAssignmentsResponse

AccessControlClientGetCallerRoleAssignmentsResponse: { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: string[] }; body: string[] }

Contains response data for the getCallerRoleAssignments operation.

Type declaration

  • _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: string[] }

    The underlying HTTP response.

  • body: string[]

    The parsed response body.

AccessControlClientGetRoleAssignmentByIdResponse

AccessControlClientGetRoleAssignmentByIdResponse: RoleAssignmentDetails & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: RoleAssignmentDetails } }

Contains response data for the getRoleAssignmentById operation.

AccessControlClientGetRoleAssignmentsResponse

AccessControlClientGetRoleAssignmentsResponse: AccessControlClientGetRoleAssignmentsHeaders & RoleAssignmentDetails[] & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: RoleAssignmentDetails[]; parsedHeaders: AccessControlClientGetRoleAssignmentsHeaders } }

Contains response data for the getRoleAssignments operation.

AccessControlClientGetRoleDefinitionByIdResponse

AccessControlClientGetRoleDefinitionByIdResponse: SynapseRole & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SynapseRole } }

Contains response data for the getRoleDefinitionById operation.

AccessControlClientGetRoleDefinitionsNextResponse

AccessControlClientGetRoleDefinitionsNextResponse: RolesListResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: RolesListResponse } }

Contains response data for the getRoleDefinitionsNext operation.

AccessControlClientGetRoleDefinitionsResponse

AccessControlClientGetRoleDefinitionsResponse: RolesListResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: RolesListResponse } }

Contains response data for the getRoleDefinitions operation.

Variables

Const createSpan

createSpan: any = createSpanFunction({namespace: "Azure.Synapse.AccessControl",packagePrefix: "Microsoft.Synapse"})

Const packageName

packageName: "@azure/synapse-access-control" = "@azure/synapse-access-control"

Const packageVersion

packageVersion: "1.0.0-beta.2" = "1.0.0-beta.2"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Object literals

Const AccessControlClientGetRoleAssignmentsHeaders

AccessControlClientGetRoleAssignmentsHeaders: object

type

type: object

className

className: string = "AccessControlClientGetRoleAssignmentsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsContinuation

xMsContinuation: object

serializedName

serializedName: string = "x-ms-continuation"

type

type: object

name

name: string = "String"

Const ErrorContract

ErrorContract: object

type

type: object

className

className: string = "ErrorContract"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

Const ErrorDetail

ErrorDetail: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const RoleAssignmentDetails

RoleAssignmentDetails: object

type

type: object

className

className: string = "RoleAssignmentDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

principalId

principalId: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: string = "String"

roleId

roleId: object

serializedName

serializedName: string = "roleId"

type

type: object

name

name: string = "String"

Const RoleAssignmentOptions

RoleAssignmentOptions: object

type

type: object

className

className: string = "RoleAssignmentOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

required

required: boolean = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: string = "String"

roleId

roleId: object

required

required: boolean = true

serializedName

serializedName: string = "roleId"

type

type: object

name

name: string = "String"

Const RolesListResponse

RolesListResponse: object

type

type: object

className

className: string = "RolesListResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SynapseRole"

name

name: string = "Composite"

Const SynapseRole

SynapseRole: object

type

type: object

className

className: string = "SynapseRole"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

isBuiltIn

isBuiltIn: object

required

required: boolean = true

serializedName

serializedName: string = "isBuiltIn"

type

type: object

name

name: string = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2020-02-01-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const continuationToken

continuationToken: object

parameterPath

parameterPath: string[] = ["options", "continuationToken"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-continuation"

type

type: object

name

name: string = "String"

Const createRoleAssignmentOperationSpec

createRoleAssignmentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/rbac/roleAssignments"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.createRoleAssignmentOptions

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RoleAssignmentDetails

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const createRoleAssignmentOptions

createRoleAssignmentOptions: object

mapper

mapper: any = RoleAssignmentOptionsMapper

parameterPath

parameterPath: string = "createRoleAssignmentOptions"

Const deleteRoleAssignmentByIdOperationSpec

deleteRoleAssignmentByIdOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/rbac/roleAssignments/{roleAssignmentId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.roleAssignmentId]

responses

responses: object

200

200: {}

Type declaration

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const getCallerRoleAssignmentsOperationSpec

getCallerRoleAssignmentsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/rbac/getMyAssignedRoles"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const getRoleAssignmentByIdOperationSpec

getRoleAssignmentByIdOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/rbac/roleAssignments/{roleAssignmentId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.roleAssignmentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RoleAssignmentDetails

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const getRoleAssignmentsOperationSpec

getRoleAssignmentsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.continuationToken]

httpMethod

httpMethod: string = "GET"

path

path: string = "/rbac/roleAssignments"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.roleId1, Parameters.principalId]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.AccessControlClientGetRoleAssignmentsHeaders

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoleAssignmentDetails"

name

name: string = "Composite"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const getRoleDefinitionByIdOperationSpec

getRoleDefinitionByIdOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/rbac/roles/{roleId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.roleId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SynapseRole

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const getRoleDefinitionsNextOperationSpec

getRoleDefinitionsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RolesListResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const getRoleDefinitionsOperationSpec

getRoleDefinitionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/rbac/roles"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RolesListResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorContract

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const principalId

principalId: object

parameterPath

parameterPath: string[] = ["options", "principalId"]

mapper

mapper: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: string = "String"

Const roleAssignmentId

roleAssignmentId: object

parameterPath

parameterPath: string = "roleAssignmentId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "roleAssignmentId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const roleId

roleId: object

parameterPath

parameterPath: string = "roleId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "roleId"

type

type: object

name

name: string = "String"

Const roleId1

roleId1: object

parameterPath

parameterPath: string[] = ["options", "roleId"]

mapper

mapper: object

serializedName

serializedName: string = "roleId"

type

type: object

name

name: string = "String"

Generated using TypeDoc