@azure-rest/synapse-access-control 1.0.0-alpha.20241126.1 → 1.0.0-alpha.20241128.1

package/package.json

@@ -5,7 +5,7 @@
   "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/synapse/synapse-access-control/README.md",
   "repository": "github:Azure/azure-sdk-for-js",
   "sdk-type": "client",
-  "version": "1.0.0-alpha.20241126.1",
+  "version": "1.0.0-alpha.20241128.1",
   "dependencies": {
     "@azure-rest/core-client": "^2.3.1",
     "@azure/core-auth": "^1.9.0",

package/dist/synapse-access-control-rest.d.ts

@@ -1,460 +0,0 @@
-import type { Client } from '@azure-rest/core-client';
-import type { ClientOptions } from '@azure-rest/core-client';
-import type { HttpResponse } from '@azure-rest/core-client';
-import type { PagedAsyncIterableIterator } from '@azure/core-paging';
-import type { PathUncheckedResponse } from '@azure-rest/core-client';
-import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
-import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
-import type { RequestParameters } from '@azure-rest/core-client';
-import type { StreamableMethod } from '@azure-rest/core-client';
-import type { TokenCredential } from '@azure/core-auth';
-
-export declare type AccessControlRestClient = Client & {
-    path: Routes;
-};
-
-export declare interface CheckAccessDecisionOutput {
-    /** Access Decision. */
-    accessDecision?: string;
-    /** Action Id. */
-    actionId?: string;
-    /** Role Assignment response details */
-    roleAssignment?: RoleAssignmentDetailsOutput;
-}
-
-export declare interface CheckPrincipalAccessRequest {
-    /** Subject details */
-    subject: SubjectInfo;
-    /** List of actions. */
-    actions: Array<RequiredAction>;
-    /** Scope at which the check access is done. */
-    scope: string;
-}
-
-export declare interface CheckPrincipalAccessResponseOutput {
-    /** To check if the current user, group, or service principal has permission to read artifacts in the specified workspace. */
-    AccessDecisions?: Array<CheckAccessDecisionOutput>;
-}
-
-declare function createClient(endpoint: string, credentials: TokenCredential, options?: ClientOptions): AccessControlRestClient;
-export default createClient;
-
-export declare interface ErrorAdditionalInfoOutput {
-    /** The additional info type. */
-    type?: string;
-    /** The additional info. */
-    info?: Record<string, unknown>;
-}
-
-export declare interface ErrorContractOutput {
-    /** The error details. */
-    error?: ErrorResponseOutput;
-}
-
-export declare interface ErrorResponseOutput {
-    /** The error code. */
-    code?: string;
-    /** The error message. */
-    message?: string;
-    /** The error target. */
-    target?: string;
-    /** The error details. */
-    details?: Array<ErrorResponseOutput>;
-    /** The error additional info. */
-    additionalInfo?: Array<ErrorAdditionalInfoOutput>;
-}
-
-/**
- * Helper type to extract the type of an array
- */
-export declare type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
-
-/**
- * The type of a custom function that defines how to get a page and a link to the next one if any.
- */
-export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
-    page: TPage;
-    nextPageLink?: string;
-}>;
-
-export declare function isUnexpected(response: RoleAssignmentsCheckPrincipalAccess200Response | RoleAssignmentsCheckPrincipalAccessdefaultResponse): response is RoleAssignmentsCheckPrincipalAccessdefaultResponse;
-
-export declare function isUnexpected(response: RoleAssignmentsListRoleAssignments200Response | RoleAssignmentsListRoleAssignmentsdefaultResponse): response is RoleAssignmentsListRoleAssignmentsdefaultResponse;
-
-export declare function isUnexpected(response: RoleAssignmentsCreateRoleAssignment200Response | RoleAssignmentsCreateRoleAssignmentdefaultResponse): response is RoleAssignmentsCreateRoleAssignmentdefaultResponse;
-
-export declare function isUnexpected(response: RoleAssignmentsGetRoleAssignmentById200Response | RoleAssignmentsGetRoleAssignmentByIddefaultResponse): response is RoleAssignmentsGetRoleAssignmentByIddefaultResponse;
-
-export declare function isUnexpected(response: RoleAssignmentsDeleteRoleAssignmentById200Response | RoleAssignmentsDeleteRoleAssignmentById204Response | RoleAssignmentsDeleteRoleAssignmentByIddefaultResponse): response is RoleAssignmentsDeleteRoleAssignmentByIddefaultResponse;
-
-export declare function isUnexpected(response: RoleDefinitionsListRoleDefinitions200Response | RoleDefinitionsListRoleDefinitionsdefaultResponse): response is RoleDefinitionsListRoleDefinitionsdefaultResponse;
-
-export declare function isUnexpected(response: RoleDefinitionsGetRoleDefinitionById200Response | RoleDefinitionsGetRoleDefinitionByIddefaultResponse): response is RoleDefinitionsGetRoleDefinitionByIddefaultResponse;
-
-export declare function isUnexpected(response: RoleDefinitionsListScopes200Response | RoleDefinitionsListScopesdefaultResponse): response is RoleDefinitionsListScopesdefaultResponse;
-
-/**
- * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
- * @param client - Client to use for sending the next page requests
- * @param initialResponse - Initial response containing the nextLink and current page of elements
- * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
- * @returns - PagedAsyncIterableIterator to iterate the elements
- */
-export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
-
-/**
- * Helper type to infer the Type of the paged elements from the response type
- * This type is generated based on the swagger information for x-ms-pageable
- * specifically on the itemName property which indicates the property of the response
- * where the page items are found. The default value is `value`.
- * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
- */
-export declare type PaginateReturn<TResult> = TResult extends {
-    body: {
-        value?: infer TPage;
-    };
-} ? GetArrayType<TPage> : Array<unknown>;
-
-/**
- * Options for the paging helper
- */
-export declare interface PagingOptions<TResponse> {
-    /**
-     * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
-     */
-    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
-}
-
-export declare interface RequiredAction {
-    /** Action Id. */
-    id: string;
-    /** Is a data action or not. */
-    isDataAction: boolean;
-}
-
-export declare interface RoleAssignmentDetailsListOutput {
-    /** Number of role assignments */
-    count?: number;
-    /** A list of role assignments */
-    value?: Array<RoleAssignmentDetailsOutput>;
-}
-
-export declare interface RoleAssignmentDetailsOutput {
-    /** Role Assignment ID */
-    id?: string;
-    /**
-     * Role ID of the Synapse Built-In Role
-     *
-     * Value may contain a UUID
-     */
-    roleDefinitionId?: string;
-    /**
-     * Object ID of the AAD principal or security-group
-     *
-     * Value may contain a UUID
-     */
-    principalId?: string;
-    /** Scope at the role assignment is created */
-    scope?: string;
-    /** Type of the principal Id: User, Group or ServicePrincipal */
-    principalType?: string;
-}
-
-export declare interface RoleAssignmentRequest {
-    /**
-     * Role ID of the Synapse Built-In Role
-     *
-     * Value may contain a UUID
-     */
-    roleId: string;
-    /**
-     * Object ID of the AAD principal or security-group
-     *
-     * Value may contain a UUID
-     */
-    principalId: string;
-    /** Scope at which the role assignment is created */
-    scope: string;
-    /** Type of the principal Id: User, Group or ServicePrincipal */
-    principalType?: string;
-}
-
-export declare interface RoleAssignmentsCheckPrincipalAccess {
-    /** Check if the given principalId has access to perform list of actions at a given scope. */
-    post(options: RoleAssignmentsCheckPrincipalAccessParameters): StreamableMethod<RoleAssignmentsCheckPrincipalAccess200Response | RoleAssignmentsCheckPrincipalAccessdefaultResponse>;
-}
-
-/** Check if the given principalId has access to perform list of actions at a given scope. */
-export declare interface RoleAssignmentsCheckPrincipalAccess200Response extends HttpResponse {
-    status: "200";
-    body: CheckPrincipalAccessResponseOutput;
-}
-
-export declare interface RoleAssignmentsCheckPrincipalAccessBodyParam {
-    /** Details of scope, list of actions and principal. */
-    body: CheckPrincipalAccessRequest;
-}
-
-/** Check if the given principalId has access to perform list of actions at a given scope. */
-export declare interface RoleAssignmentsCheckPrincipalAccessdefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare interface RoleAssignmentsCheckPrincipalAccessMediaTypesParam {
-    /** Request content type */
-    contentType?: "application/json" | "text/json";
-}
-
-export declare type RoleAssignmentsCheckPrincipalAccessParameters = RoleAssignmentsCheckPrincipalAccessMediaTypesParam & RoleAssignmentsCheckPrincipalAccessBodyParam & RequestParameters;
-
-export declare interface RoleAssignmentsCreateRoleAssignment {
-    /** Create role assignment. */
-    put(options: RoleAssignmentsCreateRoleAssignmentParameters): StreamableMethod<RoleAssignmentsCreateRoleAssignment200Response | RoleAssignmentsCreateRoleAssignmentdefaultResponse>;
-    /** Get role assignment by role assignment Id. */
-    get(options?: RoleAssignmentsGetRoleAssignmentByIdParameters): StreamableMethod<RoleAssignmentsGetRoleAssignmentById200Response | RoleAssignmentsGetRoleAssignmentByIddefaultResponse>;
-    /** Delete role assignment by role assignment Id. */
-    delete(options?: RoleAssignmentsDeleteRoleAssignmentByIdParameters): StreamableMethod<RoleAssignmentsDeleteRoleAssignmentById200Response | RoleAssignmentsDeleteRoleAssignmentById204Response | RoleAssignmentsDeleteRoleAssignmentByIddefaultResponse>;
-}
-
-/** Create role assignment. */
-export declare interface RoleAssignmentsCreateRoleAssignment200Response extends HttpResponse {
-    status: "200";
-    body: RoleAssignmentDetailsOutput;
-}
-
-export declare interface RoleAssignmentsCreateRoleAssignmentBodyParam {
-    /** Details of role id, scope and object id. */
-    body: RoleAssignmentRequest;
-}
-
-/** Create role assignment. */
-export declare interface RoleAssignmentsCreateRoleAssignmentdefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare interface RoleAssignmentsCreateRoleAssignmentMediaTypesParam {
-    /** Request content type */
-    contentType?: "application/json" | "text/json";
-}
-
-export declare type RoleAssignmentsCreateRoleAssignmentParameters = RoleAssignmentsCreateRoleAssignmentMediaTypesParam & RoleAssignmentsCreateRoleAssignmentBodyParam & RequestParameters;
-
-/** Delete role assignment by role assignment Id. */
-export declare interface RoleAssignmentsDeleteRoleAssignmentById200Response extends HttpResponse {
-    status: "200";
-    body: Record<string, unknown>;
-}
-
-/** Delete role assignment by role assignment Id. */
-export declare interface RoleAssignmentsDeleteRoleAssignmentById204Response extends HttpResponse {
-    status: "204";
-    body: Record<string, unknown>;
-}
-
-/** Delete role assignment by role assignment Id. */
-export declare interface RoleAssignmentsDeleteRoleAssignmentByIddefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare type RoleAssignmentsDeleteRoleAssignmentByIdParameters = RoleAssignmentsDeleteRoleAssignmentByIdQueryParam & RequestParameters;
-
-export declare interface RoleAssignmentsDeleteRoleAssignmentByIdQueryParam {
-    queryParameters?: RoleAssignmentsDeleteRoleAssignmentByIdQueryParamProperties;
-}
-
-export declare interface RoleAssignmentsDeleteRoleAssignmentByIdQueryParamProperties {
-    /** Scope of the Synapse Built-in Role. */
-    scope?: string;
-}
-
-/** Get role assignment by role assignment Id. */
-export declare interface RoleAssignmentsGetRoleAssignmentById200Response extends HttpResponse {
-    status: "200";
-    body: RoleAssignmentDetailsOutput;
-}
-
-/** Get role assignment by role assignment Id. */
-export declare interface RoleAssignmentsGetRoleAssignmentByIddefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare type RoleAssignmentsGetRoleAssignmentByIdParameters = RequestParameters;
-
-export declare interface RoleAssignmentsListRoleAssignments {
-    /** List role assignments. */
-    get(options?: RoleAssignmentsListRoleAssignmentsParameters): StreamableMethod<RoleAssignmentsListRoleAssignments200Response | RoleAssignmentsListRoleAssignmentsdefaultResponse>;
-}
-
-export declare interface RoleAssignmentsListRoleAssignments200Headers {
-    /** 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. */
-    "x-ms-continuation"?: string;
-}
-
-/** List role assignments. */
-export declare interface RoleAssignmentsListRoleAssignments200Response extends HttpResponse {
-    status: "200";
-    body: RoleAssignmentDetailsListOutput;
-    headers: RawHttpHeaders & RoleAssignmentsListRoleAssignments200Headers;
-}
-
-/** List role assignments. */
-export declare interface RoleAssignmentsListRoleAssignmentsdefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare interface RoleAssignmentsListRoleAssignmentsHeaderParam {
-    headers: RawHttpHeadersInput & RoleAssignmentsListRoleAssignmentsHeaders;
-}
-
-export declare interface RoleAssignmentsListRoleAssignmentsHeaders {
-    /** Continuation token. */
-    "x-ms-continuation"?: string;
-}
-
-export declare type RoleAssignmentsListRoleAssignmentsParameters = RoleAssignmentsListRoleAssignmentsQueryParam & RoleAssignmentsListRoleAssignmentsHeaderParam & RequestParameters;
-
-export declare interface RoleAssignmentsListRoleAssignmentsQueryParam {
-    queryParameters?: RoleAssignmentsListRoleAssignmentsQueryParamProperties;
-}
-
-export declare interface RoleAssignmentsListRoleAssignmentsQueryParamProperties {
-    /** 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;
-}
-
-export declare interface RoleDefinitionsGetRoleDefinitionById {
-    /** Get role definition by role definition Id. */
-    get(options?: RoleDefinitionsGetRoleDefinitionByIdParameters): StreamableMethod<RoleDefinitionsGetRoleDefinitionById200Response | RoleDefinitionsGetRoleDefinitionByIddefaultResponse>;
-}
-
-/** Get role definition by role definition Id. */
-export declare interface RoleDefinitionsGetRoleDefinitionById200Response extends HttpResponse {
-    status: "200";
-    body: SynapseRoleDefinitionOutput;
-}
-
-/** Get role definition by role definition Id. */
-export declare interface RoleDefinitionsGetRoleDefinitionByIddefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare type RoleDefinitionsGetRoleDefinitionByIdParameters = RequestParameters;
-
-export declare interface RoleDefinitionsListRoleDefinitions {
-    /** List role definitions. */
-    get(options?: RoleDefinitionsListRoleDefinitionsParameters): StreamableMethod<RoleDefinitionsListRoleDefinitions200Response | RoleDefinitionsListRoleDefinitionsdefaultResponse>;
-}
-
-/** List role definitions. */
-export declare interface RoleDefinitionsListRoleDefinitions200Response extends HttpResponse {
-    status: "200";
-    body: Array<SynapseRoleDefinitionOutput>;
-}
-
-/** List role definitions. */
-export declare interface RoleDefinitionsListRoleDefinitionsdefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare type RoleDefinitionsListRoleDefinitionsParameters = RoleDefinitionsListRoleDefinitionsQueryParam & RequestParameters;
-
-export declare interface RoleDefinitionsListRoleDefinitionsQueryParam {
-    queryParameters?: RoleDefinitionsListRoleDefinitionsQueryParamProperties;
-}
-
-export declare interface RoleDefinitionsListRoleDefinitionsQueryParamProperties {
-    /** Is a Synapse Built-In Role or not. */
-    isBuiltIn?: boolean;
-    /** Scope of the Synapse Built-in Role. */
-    scope?: string;
-}
-
-export declare interface RoleDefinitionsListScopes {
-    /** List rbac scopes. */
-    get(options?: RoleDefinitionsListScopesParameters): StreamableMethod<RoleDefinitionsListScopes200Response | RoleDefinitionsListScopesdefaultResponse>;
-}
-
-/** List rbac scopes. */
-export declare interface RoleDefinitionsListScopes200Response extends HttpResponse {
-    status: "200";
-    body: Array<string>;
-}
-
-/** List rbac scopes. */
-export declare interface RoleDefinitionsListScopesdefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorContractOutput;
-}
-
-export declare type RoleDefinitionsListScopesParameters = RequestParameters;
-
-export declare interface Routes {
-    /** Resource for '/checkAccessSynapseRbac' has methods for the following verbs: post */
-    (path: "/checkAccessSynapseRbac"): RoleAssignmentsCheckPrincipalAccess;
-    /** Resource for '/roleAssignments' has methods for the following verbs: get */
-    (path: "/roleAssignments"): RoleAssignmentsListRoleAssignments;
-    /** Resource for '/roleAssignments/\{roleAssignmentId\}' has methods for the following verbs: put, get, delete */
-    (path: "/roleAssignments/{roleAssignmentId}", roleAssignmentId: string): RoleAssignmentsCreateRoleAssignment;
-    /** Resource for '/roleDefinitions' has methods for the following verbs: get */
-    (path: "/roleDefinitions"): RoleDefinitionsListRoleDefinitions;
-    /** Resource for '/roleDefinitions/\{roleDefinitionId\}' has methods for the following verbs: get */
-    (path: "/roleDefinitions/{roleDefinitionId}", roleDefinitionId: string): RoleDefinitionsGetRoleDefinitionById;
-    /** Resource for '/rbacScopes' has methods for the following verbs: get */
-    (path: "/rbacScopes"): RoleDefinitionsListScopes;
-}
-
-export declare interface SubjectInfo {
-    /**
-     * Principal Id
-     *
-     * Value may contain a UUID
-     */
-    principalId: string;
-    /** List of group Ids that the principalId is part of. */
-    groupIds?: Array<string>;
-}
-
-export declare interface SynapseRbacPermissionOutput {
-    /** List of actions */
-    actions?: Array<string>;
-    /** List of Not actions */
-    notActions?: Array<string>;
-    /** List of data actions */
-    dataActions?: Array<string>;
-    /** List of Not data actions */
-    notDataActions?: Array<string>;
-}
-
-export declare interface SynapseRoleDefinitionOutput {
-    /**
-     * Role Definition ID
-     *
-     * Value may contain a UUID
-     */
-    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?: Array<SynapseRbacPermissionOutput>;
-    /** Allowed scopes for the Synapse role */
-    scopes?: Array<string>;
-    /** Availability of the Synapse role */
-    availabilityStatus?: string;
-}
-
-export { }