[Synapse] Land the initial generated code #12713
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| ## Azure Synapse Access Control client library for JavaScript | ||
|
|
||
| This package contains an isomorphic SDK for SparkClient. | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Install the package | ||
|
|
||
| ```bash | ||
| npm install @azure/synapse-accesscontrol | ||
| ``` | ||
|
|
||
| ### Currently supported environments | ||
|
|
||
| - Node.js version 8.x.x or higher | ||
| - Browser JavaScript | ||
|
|
||
sophiajt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Key concepts | ||
|
|
||
| ## Examples | ||
|
|
||
| In the future, we will share samples here. | ||
|
|
||
| ## Related projects | ||
|
|
||
| - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) | ||
|
|
||
|  | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`: | ||
|
|
||
| ```javascript | ||
| import { setLogLevel } from "@azure/logger"; | ||
|
|
||
| setLogLevel("info"); | ||
| ``` | ||
|
|
||
| ## Next steps | ||
|
|
||
| In the future, you'll find additional code samples here. | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code. | ||
|
|
||
|  | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
| "mainEntryPointFilePath": "./esm/index.d.ts", | ||
| "docModel": { "enabled": true }, | ||
| "apiReport": { "enabled": true, "reportFolder": "./review" }, | ||
| "dtsRollup": { | ||
| "enabled": true, | ||
| "untrimmedFilePath": "", | ||
| "publicTrimmedFilePath": "./esm/index.d.ts" | ||
sophiajt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| "messages": { | ||
| "tsdocMessageReporting": { "default": { "logLevel": "none" } }, | ||
| "extractorMessageReporting": { | ||
| "ae-missing-release-tag": { "logLevel": "none" }, | ||
| "ae-unresolved-link": { "logLevel": "none" } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| { | ||
| "name": "@azure/synapse-accesscontrol", | ||
| "author": "Microsoft Corporation", | ||
| "description": "A generated SDK for AccessControlClient.", | ||
|
There was a problem hiding this comment. is it worth putting better description text here? |
||
| "version": "1.0.0-beta.1", | ||
| "dependencies": { | ||
| "@azure/core-paging": "^1.1.1", | ||
| "@azure/core-http": "^1.2.0", | ||
| "tslib": "^2.0.0" | ||
| }, | ||
| "keywords": [ | ||
| "node", | ||
| "azure", | ||
| "typescript", | ||
| "browser", | ||
| "isomorphic" | ||
| ], | ||
| "license": "MIT", | ||
| "main": "./dist/synapse-accesscontrol.js", | ||
| "module": "./esm/index.js", | ||
| "types": "./esm/index.d.ts", | ||
| "devDependencies": { | ||
| "typescript": "~3.9.3", | ||
| "rollup": "^1.16.3", | ||
| "rollup-plugin-node-resolve": "^3.4.0", | ||
| "rollup-plugin-sourcemaps": "^0.4.2", | ||
| "uglify-js": "^3.4.9", | ||
| "@microsoft/api-extractor": "7.7.11" | ||
| }, | ||
| "homepage": "https://github.com/Azure/azure-sdk-for-js", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/Azure/azure-sdk-for-js.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/Azure/azure-sdk-for-js/issues" | ||
| }, | ||
| "files": [ | ||
| "dist/**/*.js", | ||
| "dist/**/*.js.map", | ||
| "dist/**/*.d.ts", | ||
| "dist/**/*.d.ts.map", | ||
| "esm/**/*.js", | ||
| "esm/**/*.js.map", | ||
| "esm/**/*.d.ts", | ||
| "esm/**/*.d.ts.map", | ||
| "src/**/*.ts", | ||
| "README.md", | ||
| "rollup.config.js", | ||
| "tsconfig.json" | ||
| ], | ||
| "scripts": { | ||
| "build": "tsc && rollup -c rollup.config.js && npm run minify && npm run extract-api", | ||
| "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/synapse-accesscontrol.js.map'\" -o ./dist/synapse-accesscontrol.min.js ./dist/synapse-accesscontrol.js", | ||
| "prepack": "npm install && npm run build", | ||
| "build:test": "echo skip", | ||
| "unit-test:browser": "echo skipped", | ||
| "unit-test:node": "echo skipped", | ||
| "unit-test": "npm run unit-test:node && npm run unit-test:browser", | ||
| "extract-api": "api-extractor run --local" | ||
| }, | ||
| "sideEffects": false, | ||
| "autoPublish": true | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| ## API Report File for "@azure/synapse-accesscontrol" | ||
|
|
||
| > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). | ||
|
|
||
| ```ts | ||
|
|
||
| import * as coreHttp from '@azure/core-http'; | ||
| import { PagedAsyncIterableIterator } from '@azure/core-paging'; | ||
|
|
||
| // @public (undocumented) | ||
| export class AccessControlClient extends AccessControlClientContext { | ||
| constructor(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, endpoint: string, options?: AccessControlClientOptionalParams); | ||
| createRoleAssignment(createRoleAssignmentOptions: RoleAssignmentOptions, options?: coreHttp.OperationOptions): Promise<AccessControlClientCreateRoleAssignmentResponse>; | ||
| deleteRoleAssignmentById(roleAssignmentId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
| getCallerRoleAssignments(options?: coreHttp.OperationOptions): Promise<AccessControlClientGetCallerRoleAssignmentsResponse>; | ||
| getRoleAssignmentById(roleAssignmentId: string, options?: coreHttp.OperationOptions): Promise<AccessControlClientGetRoleAssignmentByIdResponse>; | ||
| getRoleAssignments(options?: AccessControlClientGetRoleAssignmentsOptionalParams): Promise<AccessControlClientGetRoleAssignmentsResponse>; | ||
| getRoleDefinitionById(roleId: string, options?: coreHttp.OperationOptions): Promise<AccessControlClientGetRoleDefinitionByIdResponse>; | ||
| listRoleDefinitions(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<SynapseRole>; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export class AccessControlClientContext extends coreHttp.ServiceClient { | ||
| constructor(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, endpoint: string, options?: AccessControlClientOptionalParams); | ||
| // (undocumented) | ||
| apiVersion: string; | ||
| // (undocumented) | ||
| endpoint: string; | ||
| } | ||
|
|
||
| // @public | ||
| export type AccessControlClientCreateRoleAssignmentResponse = RoleAssignmentDetails & { | ||
| _response: coreHttp.HttpResponse & { | ||
| bodyAsText: string; | ||
| parsedBody: RoleAssignmentDetails; | ||
| }; | ||
| }; | ||
|
|
||
| // @public | ||
| export type AccessControlClientGetCallerRoleAssignmentsResponse = { | ||
| body: string[]; | ||
| _response: coreHttp.HttpResponse & { | ||
| bodyAsText: string; | ||
| parsedBody: string[]; | ||
| }; | ||
| }; | ||
|
|
||
| // @public | ||
| export type AccessControlClientGetRoleAssignmentByIdResponse = RoleAssignmentDetails & { | ||
| _response: coreHttp.HttpResponse & { | ||
| bodyAsText: string; | ||
| parsedBody: RoleAssignmentDetails; | ||
| }; | ||
| }; | ||
|
|
||
| // @public | ||
| export interface AccessControlClientGetRoleAssignmentsHeaders { | ||
| xMsContinuation?: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface AccessControlClientGetRoleAssignmentsOptionalParams extends coreHttp.OperationOptions { | ||
| continuationToken?: string; | ||
| principalId?: string; | ||
| roleId?: string; | ||
| } | ||
|
|
||
| // @public | ||
| export type AccessControlClientGetRoleAssignmentsResponse = AccessControlClientGetRoleAssignmentsHeaders & RoleAssignmentDetails[] & { | ||
| _response: coreHttp.HttpResponse & { | ||
| bodyAsText: string; | ||
| parsedBody: RoleAssignmentDetails[]; | ||
| parsedHeaders: AccessControlClientGetRoleAssignmentsHeaders; | ||
| }; | ||
| }; | ||
|
|
||
| // @public | ||
| export type AccessControlClientGetRoleDefinitionByIdResponse = SynapseRole & { | ||
| _response: coreHttp.HttpResponse & { | ||
| bodyAsText: string; | ||
| parsedBody: SynapseRole; | ||
| }; | ||
| }; | ||
|
|
||
| // @public | ||
| export type AccessControlClientGetRoleDefinitionsNextResponse = RolesListResponse & { | ||
| _response: coreHttp.HttpResponse & { | ||
| bodyAsText: string; | ||
| parsedBody: RolesListResponse; | ||
| }; | ||
| }; | ||
|
|
||
| // @public | ||
| export type AccessControlClientGetRoleDefinitionsResponse = RolesListResponse & { | ||
| _response: coreHttp.HttpResponse & { | ||
| bodyAsText: string; | ||
| parsedBody: RolesListResponse; | ||
| }; | ||
| }; | ||
|
|
||
| // @public | ||
| export interface AccessControlClientOptionalParams extends coreHttp.ServiceClientOptions { | ||
| apiVersion?: string; | ||
| endpoint?: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface ErrorContract { | ||
| error?: ErrorResponse; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export interface ErrorDetail { | ||
| // (undocumented) | ||
| code: string; | ||
| // (undocumented) | ||
| message: string; | ||
| // (undocumented) | ||
| target?: string; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export interface ErrorResponse { | ||
| // (undocumented) | ||
| code: string; | ||
| // (undocumented) | ||
| details?: ErrorDetail[]; | ||
| // (undocumented) | ||
| message: string; | ||
| // (undocumented) | ||
| target?: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface RoleAssignmentDetails { | ||
| id?: string; | ||
| principalId?: string; | ||
| roleId?: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface RoleAssignmentOptions { | ||
| principalId: string; | ||
| roleId: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface RolesListResponse { | ||
| nextLink?: string; | ||
| value: SynapseRole[]; | ||
| } | ||
|
|
||
| // @public | ||
| export interface SynapseRole { | ||
| id?: string; | ||
| isBuiltIn: boolean; | ||
| name?: string; | ||
| } | ||
|
|
||
|
|
||
| // (No @packageDocumentation comment for this package) | ||
|
|
||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is required for synapse?