@azure/synapse-access-control 1.0.0-beta.3 → 1.0.0-beta.5

package/types/synapse-access-control.d.ts

@@ -1,329 +0,0 @@
-import * as coreAuth from '@azure/core-auth';
-import * as coreClient from '@azure/core-client';
-
-export declare class AccessControlClient extends AccessControlClientContext {
-    /**
-     * Initializes a new instance of the AccessControlClient class.
-     * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param endpoint The workspace development endpoint, for example
-     *                 https://myworkspace.dev.azuresynapse.net.
-     * @param options The parameter options
-     */
-    constructor(credentials: coreAuth.TokenCredential, endpoint: string, options?: AccessControlClientOptionalParams);
-    roleAssignments: RoleAssignments;
-    roleDefinitions: RoleDefinitions;
-}
-
-export declare class AccessControlClientContext extends coreClient.ServiceClient {
-    endpoint: string;
-    apiVersion: string;
-    /**
-     * Initializes a new instance of the AccessControlClientContext class.
-     * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param endpoint The workspace development endpoint, for example
-     *                 https://myworkspace.dev.azuresynapse.net.
-     * @param options The parameter options
-     */
-    constructor(credentials: coreAuth.TokenCredential, endpoint: string, options?: AccessControlClientOptionalParams);
-}
-
-/** Optional parameters. */
-export declare interface AccessControlClientOptionalParams extends coreClient.ServiceClientOptions {
-    /** Api Version */
-    apiVersion?: string;
-    /** Overrides client endpoint. */
-    endpoint?: string;
-}
-
-/** Check access response details */
-export declare interface CheckAccessDecision {
-    /** Access Decision. */
-    accessDecision?: string;
-    /** Action Id. */
-    actionId?: string;
-    /** Role Assignment response details */
-    roleAssignment?: RoleAssignmentDetails;
-}
-
-/** Check access request details */
-export declare interface CheckPrincipalAccessRequest {
-    /** Subject details */
-    subject: SubjectInfo;
-    /** List of actions. */
-    actions: RequiredAction[];
-    /** Scope at which the check access is done. */
-    scope: string;
-}
-
-/** Check access response details */
-export declare interface CheckPrincipalAccessResponse {
-    /** To check if the current user, group, or service principal has permission to read artifacts in the specified workspace. */
-    accessDecisions?: CheckAccessDecision[];
-}
-
-/** The resource management error additional info. */
-export declare interface ErrorAdditionalInfo {
-    /**
-     * The additional info type.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly type?: string;
-    /**
-     * The additional info.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly info?: Record<string, unknown>;
-}
-
-/** Contains details when the response code indicates an error. */
-export declare interface ErrorContract {
-    /** The error details. */
-    error?: ErrorResponse;
-}
-
-/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) */
-export declare interface ErrorResponse {
-    /**
-     * The error code.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly code?: string;
-    /**
-     * The error message.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly message?: string;
-    /**
-     * The error target.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly target?: string;
-    /**
-     * The error details.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly details?: ErrorResponse[];
-    /**
-     * The error additional info.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly additionalInfo?: ErrorAdditionalInfo[];
-}
-
-/** Action Info */
-export declare interface RequiredAction {
-    /** Action Id. */
-    id: string;
-    /** Is a data action or not. */
-    isDataAction: boolean;
-}
-
-/** Role Assignment response details */
-export declare interface RoleAssignmentDetails {
-    /** Role Assignment ID */
-    id?: string;
-    /** Role ID of the Synapse Built-In Role */
-    roleDefinitionId?: string;
-    /** Object ID of the AAD principal or security-group */
-    principalId?: string;
-    /** Scope at the role assignment is created */
-    scope?: string;
-    /** Type of the principal Id: User, Group or ServicePrincipal */
-    principalType?: string;
-}
-
-/** Role Assignment response details */
-export declare interface RoleAssignmentDetailsList {
-    /** Number of role assignments */
-    count?: number;
-    /** A list of role assignments */
-    value?: RoleAssignmentDetails[];
-}
-
-/** Role Assignment request details */
-export declare interface RoleAssignmentRequest {
-    /** Role ID of the Synapse Built-In Role */
-    roleId: string;
-    /** Object ID of the AAD principal or security-group */
-    principalId: string;
-    /** Scope at which the role assignment is created */
-    scope: string;
-    /** Type of the principal Id: User, Group or ServicePrincipal */
-    principalType?: string;
-}
-
-/** Interface representing a RoleAssignments. */
-export declare interface RoleAssignments {
-    /**
-     * Check if the given principalId has access to perform list of actions at a given scope.
-     * @param subject Subject details
-     * @param actions List of actions.
-     * @param scope Scope at which the check access is done.
-     * @param options The options parameters.
-     */
-    checkPrincipalAccess(subject: SubjectInfo, actions: RequiredAction[], scope: string, options?: RoleAssignmentsCheckPrincipalAccessOptionalParams): Promise<RoleAssignmentsCheckPrincipalAccessResponse>;
-    /**
-     * List role assignments.
-     * @param options The options parameters.
-     */
-    listRoleAssignments(options?: RoleAssignmentsListRoleAssignmentsOptionalParams): Promise<RoleAssignmentsListRoleAssignmentsResponse>;
-    /**
-     * Create role assignment.
-     * @param roleAssignmentId The ID of the role assignment.
-     * @param roleId Role ID of the Synapse Built-In Role
-     * @param principalId Object ID of the AAD principal or security-group
-     * @param scope Scope at which the role assignment is created
-     * @param options The options parameters.
-     */
-    createRoleAssignment(roleAssignmentId: string, roleId: string, principalId: string, scope: string, options?: RoleAssignmentsCreateRoleAssignmentOptionalParams): Promise<RoleAssignmentsCreateRoleAssignmentResponse>;
-    /**
-     * Get role assignment by role assignment Id.
-     * @param roleAssignmentId The ID of the role assignment.
-     * @param options The options parameters.
-     */
-    getRoleAssignmentById(roleAssignmentId: string, options?: RoleAssignmentsGetRoleAssignmentByIdOptionalParams): Promise<RoleAssignmentsGetRoleAssignmentByIdResponse>;
-    /**
-     * Delete role assignment by role assignment Id.
-     * @param roleAssignmentId The ID of the role assignment.
-     * @param options The options parameters.
-     */
-    deleteRoleAssignmentById(roleAssignmentId: string, options?: RoleAssignmentsDeleteRoleAssignmentByIdOptionalParams): Promise<void>;
-}
-
-/** Optional parameters. */
-export declare interface RoleAssignmentsCheckPrincipalAccessOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the checkPrincipalAccess operation. */
-export declare type RoleAssignmentsCheckPrincipalAccessResponse = CheckPrincipalAccessResponse;
-
-/** Optional parameters. */
-export declare interface RoleAssignmentsCreateRoleAssignmentOptionalParams extends coreClient.OperationOptions {
-    /** Type of the principal Id: User, Group or ServicePrincipal */
-    principalType?: string;
-}
-
-/** Contains response data for the createRoleAssignment operation. */
-export declare type RoleAssignmentsCreateRoleAssignmentResponse = RoleAssignmentDetails;
-
-/** Optional parameters. */
-export declare interface RoleAssignmentsDeleteRoleAssignmentByIdOptionalParams extends coreClient.OperationOptions {
-    /** Scope of the Synapse Built-in Role. */
-    scope?: string;
-}
-
-/** Optional parameters. */
-export declare interface RoleAssignmentsGetRoleAssignmentByIdOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the getRoleAssignmentById operation. */
-export declare type RoleAssignmentsGetRoleAssignmentByIdResponse = RoleAssignmentDetails;
-
-/** Defines headers for RoleAssignments_listRoleAssignments operation. */
-export declare interface RoleAssignmentsListRoleAssignmentsHeaders {
-    /** If the number of role assignments to be listed exceeds the maxResults limit, a continuation token is returned in this response header.  When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the role assignments. */
-    xMsContinuation?: string;
-}
-
-/** Optional parameters. */
-export declare interface RoleAssignmentsListRoleAssignmentsOptionalParams extends coreClient.OperationOptions {
-    /** Synapse Built-In Role Id. */
-    roleId?: string;
-    /** Object ID of the AAD principal or security-group. */
-    principalId?: string;
-    /** Scope of the Synapse Built-in Role. */
-    scope?: string;
-    /** Continuation token. */
-    continuationToken?: string;
-}
-
-/** Contains response data for the listRoleAssignments operation. */
-export declare type RoleAssignmentsListRoleAssignmentsResponse = RoleAssignmentsListRoleAssignmentsHeaders & RoleAssignmentDetailsList;
-
-/** Interface representing a RoleDefinitions. */
-export declare interface RoleDefinitions {
-    /**
-     * List role definitions.
-     * @param options The options parameters.
-     */
-    listRoleDefinitions(options?: RoleDefinitionsListRoleDefinitionsOptionalParams): Promise<RoleDefinitionsListRoleDefinitionsResponse>;
-    /**
-     * Get role definition by role definition Id.
-     * @param roleDefinitionId Synapse Built-In Role Definition Id.
-     * @param options The options parameters.
-     */
-    getRoleDefinitionById(roleDefinitionId: string, options?: RoleDefinitionsGetRoleDefinitionByIdOptionalParams): Promise<RoleDefinitionsGetRoleDefinitionByIdResponse>;
-    /**
-     * List rbac scopes.
-     * @param options The options parameters.
-     */
-    listScopes(options?: RoleDefinitionsListScopesOptionalParams): Promise<RoleDefinitionsListScopesResponse>;
-}
-
-/** Optional parameters. */
-export declare interface RoleDefinitionsGetRoleDefinitionByIdOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the getRoleDefinitionById operation. */
-export declare type RoleDefinitionsGetRoleDefinitionByIdResponse = SynapseRoleDefinition;
-
-/** Optional parameters. */
-export declare interface RoleDefinitionsListRoleDefinitionsOptionalParams extends coreClient.OperationOptions {
-    /** Scope of the Synapse Built-in Role. */
-    scope?: string;
-    /** Is a Synapse Built-In Role or not. */
-    isBuiltIn?: boolean;
-}
-
-/** Contains response data for the listRoleDefinitions operation. */
-export declare type RoleDefinitionsListRoleDefinitionsResponse = SynapseRoleDefinition[];
-
-/** Optional parameters. */
-export declare interface RoleDefinitionsListScopesOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the listScopes operation. */
-export declare type RoleDefinitionsListScopesResponse = {
-    /** The parsed response body. */
-    body: string[];
-};
-
-/** Subject details */
-export declare interface SubjectInfo {
-    /** Principal Id */
-    principalId: string;
-    /** List of group Ids that the principalId is part of. */
-    groupIds?: string[];
-}
-
-/** Synapse role definition details */
-export declare interface SynapseRbacPermission {
-    /** List of actions */
-    actions?: string[];
-    /** List of Not actions */
-    notActions?: string[];
-    /** List of data actions */
-    dataActions?: string[];
-    /** List of Not data actions */
-    notDataActions?: string[];
-}
-
-/** Synapse role definition details */
-export declare interface SynapseRoleDefinition {
-    /** Role Definition ID */
-    id?: string;
-    /** Name of the Synapse role */
-    name?: string;
-    /** Is a built-in role or not */
-    isBuiltIn?: boolean;
-    /** Description for the Synapse role */
-    description?: string;
-    /** Permissions for the Synapse role */
-    permissions?: SynapseRbacPermission[];
-    /** Allowed scopes for the Synapse role */
-    scopes?: string[];
-    /** Availability of the Synapse role */
-    availabilityStatus?: string;
-}
-
-export { }