@azure-rest/synapse-access-control 1.0.0-alpha.20250331.1 → 1.0.0-alpha.20250402.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Release History
+
+## 1.0.0-beta.1 (UNRELEASED)
+
+- Initial release

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.20250331.1",
+  "version": "1.0.0-alpha.20250402.1",
   "dependencies": {
     "@azure-rest/core-client": "^2.3.1",
     "@azure/core-auth": "^1.9.0",
@@ -60,7 +60,9 @@
   "files": [
     "dist/",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "review/",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",

package/review/synapse-access-control.api.md

@@ -0,0 +1,458 @@
+## API Report File for "@azure-rest/synapse-access-control"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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 { 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';
+
+// @public (undocumented)
+export type AccessControlRestClient = Client & {
+    path: Routes;
+};
+
+// @public
+export interface AccessControlRestClientOptions extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface CheckAccessDecisionOutput {
+    accessDecision?: string;
+    actionId?: string;
+    roleAssignment?: RoleAssignmentDetailsOutput;
+}
+
+// @public
+export interface CheckPrincipalAccessRequest {
+    actions: Array<RequiredAction>;
+    scope: string;
+    subject: SubjectInfo;
+}
+
+// @public
+export interface CheckPrincipalAccessResponseOutput {
+    AccessDecisions?: Array<CheckAccessDecisionOutput>;
+}
+
+// @public
+function createClient(endpoint: string, credentials: TokenCredential, { apiVersion, ...options }?: AccessControlRestClientOptions): AccessControlRestClient;
+export default createClient;
+
+// @public
+export interface ErrorAdditionalInfoOutput {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorContractOutput {
+    error?: ErrorResponseOutput;
+}
+
+// @public
+export interface ErrorResponseOutput {
+    readonly additionalInfo?: Array<ErrorAdditionalInfoOutput>;
+    readonly code?: string;
+    readonly details?: Array<ErrorResponseOutput>;
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+
+// @public
+export type GetPage<TPage> = (pageLink: string) => Promise<{
+    page: TPage;
+    nextPageLink?: string;
+}>;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleAssignmentsCheckPrincipalAccess200Response | RoleAssignmentsCheckPrincipalAccessDefaultResponse): response is RoleAssignmentsCheckPrincipalAccessDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleAssignmentsListRoleAssignments200Response | RoleAssignmentsListRoleAssignmentsDefaultResponse): response is RoleAssignmentsListRoleAssignmentsDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleAssignmentsCreateRoleAssignment200Response | RoleAssignmentsCreateRoleAssignmentDefaultResponse): response is RoleAssignmentsCreateRoleAssignmentDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleAssignmentsGetRoleAssignmentById200Response | RoleAssignmentsGetRoleAssignmentByIdDefaultResponse): response is RoleAssignmentsGetRoleAssignmentByIdDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleAssignmentsDeleteRoleAssignmentById200Response | RoleAssignmentsDeleteRoleAssignmentById204Response | RoleAssignmentsDeleteRoleAssignmentByIdDefaultResponse): response is RoleAssignmentsDeleteRoleAssignmentByIdDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleDefinitionsListRoleDefinitions200Response | RoleDefinitionsListRoleDefinitionsDefaultResponse): response is RoleDefinitionsListRoleDefinitionsDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleDefinitionsGetRoleDefinitionById200Response | RoleDefinitionsGetRoleDefinitionByIdDefaultResponse): response is RoleDefinitionsGetRoleDefinitionByIdDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RoleDefinitionsListScopes200Response | RoleDefinitionsListScopesDefaultResponse): response is RoleDefinitionsListScopesDefaultResponse;
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+export function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
+
+// @public
+export type PaginateReturn<TResult> = TResult extends {
+    body: {
+        value?: infer TPage;
+    };
+} ? GetArrayType<TPage> : Array<unknown>;
+
+// @public
+export interface PagingOptions<TResponse> {
+    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+
+// @public
+export interface RequiredAction {
+    id: string;
+    isDataAction: boolean;
+}
+
+// @public
+export interface RoleAssignmentDetailsListOutput {
+    count?: number;
+    value?: Array<RoleAssignmentDetailsOutput>;
+}
+
+// @public
+export interface RoleAssignmentDetailsOutput {
+    id?: string;
+    principalId?: string;
+    principalType?: string;
+    roleDefinitionId?: string;
+    scope?: string;
+}
+
+// @public
+export interface RoleAssignmentRequest {
+    principalId: string;
+    principalType?: string;
+    roleId: string;
+    scope: string;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsCheckPrincipalAccess {
+    post(options: RoleAssignmentsCheckPrincipalAccessParameters): StreamableMethod<RoleAssignmentsCheckPrincipalAccess200Response | RoleAssignmentsCheckPrincipalAccessDefaultResponse>;
+}
+
+// @public
+export interface RoleAssignmentsCheckPrincipalAccess200Response extends HttpResponse {
+    // (undocumented)
+    body: CheckPrincipalAccessResponseOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsCheckPrincipalAccessBodyParam {
+    body: CheckPrincipalAccessRequest;
+}
+
+// @public
+export interface RoleAssignmentsCheckPrincipalAccessDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsCheckPrincipalAccessMediaTypesParam {
+    contentType?: "application/json" | "text/json";
+}
+
+// @public (undocumented)
+export type RoleAssignmentsCheckPrincipalAccessParameters = RoleAssignmentsCheckPrincipalAccessMediaTypesParam & RoleAssignmentsCheckPrincipalAccessBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface RoleAssignmentsCreateRoleAssignment {
+    delete(options?: RoleAssignmentsDeleteRoleAssignmentByIdParameters): StreamableMethod<RoleAssignmentsDeleteRoleAssignmentById200Response | RoleAssignmentsDeleteRoleAssignmentById204Response | RoleAssignmentsDeleteRoleAssignmentByIdDefaultResponse>;
+    get(options?: RoleAssignmentsGetRoleAssignmentByIdParameters): StreamableMethod<RoleAssignmentsGetRoleAssignmentById200Response | RoleAssignmentsGetRoleAssignmentByIdDefaultResponse>;
+    put(options: RoleAssignmentsCreateRoleAssignmentParameters): StreamableMethod<RoleAssignmentsCreateRoleAssignment200Response | RoleAssignmentsCreateRoleAssignmentDefaultResponse>;
+}
+
+// @public
+export interface RoleAssignmentsCreateRoleAssignment200Response extends HttpResponse {
+    // (undocumented)
+    body: RoleAssignmentDetailsOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsCreateRoleAssignmentBodyParam {
+    body: RoleAssignmentRequest;
+}
+
+// @public
+export interface RoleAssignmentsCreateRoleAssignmentDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsCreateRoleAssignmentMediaTypesParam {
+    contentType?: "application/json" | "text/json";
+}
+
+// @public (undocumented)
+export type RoleAssignmentsCreateRoleAssignmentParameters = RoleAssignmentsCreateRoleAssignmentMediaTypesParam & RoleAssignmentsCreateRoleAssignmentBodyParam & RequestParameters;
+
+// @public
+export interface RoleAssignmentsDeleteRoleAssignmentById200Response extends HttpResponse {
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RoleAssignmentsDeleteRoleAssignmentById204Response extends HttpResponse {
+    // (undocumented)
+    status: "204";
+}
+
+// @public
+export interface RoleAssignmentsDeleteRoleAssignmentByIdDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type RoleAssignmentsDeleteRoleAssignmentByIdParameters = RoleAssignmentsDeleteRoleAssignmentByIdQueryParam & RequestParameters;
+
+// @public (undocumented)
+export interface RoleAssignmentsDeleteRoleAssignmentByIdQueryParam {
+    // (undocumented)
+    queryParameters?: RoleAssignmentsDeleteRoleAssignmentByIdQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsDeleteRoleAssignmentByIdQueryParamProperties {
+    scope?: string;
+}
+
+// @public
+export interface RoleAssignmentsGetRoleAssignmentById200Response extends HttpResponse {
+    // (undocumented)
+    body: RoleAssignmentDetailsOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RoleAssignmentsGetRoleAssignmentByIdDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type RoleAssignmentsGetRoleAssignmentByIdParameters = RequestParameters;
+
+// @public (undocumented)
+export interface RoleAssignmentsListRoleAssignments {
+    get(options?: RoleAssignmentsListRoleAssignmentsParameters): StreamableMethod<RoleAssignmentsListRoleAssignments200Response | RoleAssignmentsListRoleAssignmentsDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsListRoleAssignments200Headers {
+    "x-ms-continuation"?: string;
+}
+
+// @public
+export interface RoleAssignmentsListRoleAssignments200Response extends HttpResponse {
+    // (undocumented)
+    body: RoleAssignmentDetailsListOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & RoleAssignmentsListRoleAssignments200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RoleAssignmentsListRoleAssignmentsDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsListRoleAssignmentsHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & RoleAssignmentsListRoleAssignmentsHeaders;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsListRoleAssignmentsHeaders {
+    "x-ms-continuation"?: string;
+}
+
+// @public (undocumented)
+export type RoleAssignmentsListRoleAssignmentsParameters = RoleAssignmentsListRoleAssignmentsQueryParam & RoleAssignmentsListRoleAssignmentsHeaderParam & RequestParameters;
+
+// @public (undocumented)
+export interface RoleAssignmentsListRoleAssignmentsQueryParam {
+    // (undocumented)
+    queryParameters?: RoleAssignmentsListRoleAssignmentsQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RoleAssignmentsListRoleAssignmentsQueryParamProperties {
+    principalId?: string;
+    roleId?: string;
+    scope?: string;
+}
+
+// @public (undocumented)
+export interface RoleDefinitionsGetRoleDefinitionById {
+    get(options?: RoleDefinitionsGetRoleDefinitionByIdParameters): StreamableMethod<RoleDefinitionsGetRoleDefinitionById200Response | RoleDefinitionsGetRoleDefinitionByIdDefaultResponse>;
+}
+
+// @public
+export interface RoleDefinitionsGetRoleDefinitionById200Response extends HttpResponse {
+    // (undocumented)
+    body: SynapseRoleDefinitionOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RoleDefinitionsGetRoleDefinitionByIdDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type RoleDefinitionsGetRoleDefinitionByIdParameters = RequestParameters;
+
+// @public (undocumented)
+export interface RoleDefinitionsListRoleDefinitions {
+    get(options?: RoleDefinitionsListRoleDefinitionsParameters): StreamableMethod<RoleDefinitionsListRoleDefinitions200Response | RoleDefinitionsListRoleDefinitionsDefaultResponse>;
+}
+
+// @public
+export interface RoleDefinitionsListRoleDefinitions200Response extends HttpResponse {
+    // (undocumented)
+    body: Array<SynapseRoleDefinitionOutput>;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RoleDefinitionsListRoleDefinitionsDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type RoleDefinitionsListRoleDefinitionsParameters = RoleDefinitionsListRoleDefinitionsQueryParam & RequestParameters;
+
+// @public (undocumented)
+export interface RoleDefinitionsListRoleDefinitionsQueryParam {
+    // (undocumented)
+    queryParameters?: RoleDefinitionsListRoleDefinitionsQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RoleDefinitionsListRoleDefinitionsQueryParamProperties {
+    isBuiltIn?: boolean;
+    scope?: string;
+}
+
+// @public (undocumented)
+export interface RoleDefinitionsListScopes {
+    get(options?: RoleDefinitionsListScopesParameters): StreamableMethod<RoleDefinitionsListScopes200Response | RoleDefinitionsListScopesDefaultResponse>;
+}
+
+// @public
+export interface RoleDefinitionsListScopes200Response extends HttpResponse {
+    // (undocumented)
+    body: Array<string>;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RoleDefinitionsListScopesDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorContractOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type RoleDefinitionsListScopesParameters = RequestParameters;
+
+// @public (undocumented)
+export interface Routes {
+    (path: "/checkAccessSynapseRbac"): RoleAssignmentsCheckPrincipalAccess;
+    (path: "/roleAssignments"): RoleAssignmentsListRoleAssignments;
+    (path: "/roleAssignments/{roleAssignmentId}", roleAssignmentId: string): RoleAssignmentsCreateRoleAssignment;
+    (path: "/roleDefinitions"): RoleDefinitionsListRoleDefinitions;
+    (path: "/roleDefinitions/{roleDefinitionId}", roleDefinitionId: string): RoleDefinitionsGetRoleDefinitionById;
+    (path: "/rbacScopes"): RoleDefinitionsListScopes;
+}
+
+// @public
+export interface SubjectInfo {
+    groupIds?: Array<string>;
+    principalId: string;
+}
+
+// @public
+export interface SynapseRbacPermissionOutput {
+    actions?: Array<string>;
+    dataActions?: Array<string>;
+    notActions?: Array<string>;
+    notDataActions?: Array<string>;
+}
+
+// @public
+export interface SynapseRoleDefinitionOutput {
+    availabilityStatus?: string;
+    description?: string;
+    id?: string;
+    isBuiltIn?: boolean;
+    name?: string;
+    permissions?: Array<SynapseRbacPermissionOutput>;
+    scopes?: Array<string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```