[Key Vault Admin] Convenience layer - KeyVaultAccessControlClient #10815
There are no files selected for viewing
This file contains hidden or 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,31 @@ | ||
| { | ||
| "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
| "mainEntryPointFilePath": "types/keyvault-admin/src/index.d.ts", | ||
| "docModel": { | ||
| "enabled": true | ||
| }, | ||
| "apiReport": { | ||
| "enabled": true, | ||
| "reportFolder": "./review" | ||
| }, | ||
| "dtsRollup": { | ||
| "enabled": true, | ||
| "untrimmedFilePath": "", | ||
| "publicTrimmedFilePath": "./types/keyvault-admin.d.ts" | ||
| }, | ||
| "messages": { | ||
| "tsdocMessageReporting": { | ||
| "default": { | ||
| "logLevel": "none" | ||
| } | ||
| }, | ||
| "extractorMessageReporting": { | ||
| "ae-missing-release-tag": { | ||
| "logLevel": "none" | ||
| }, | ||
| "ae-unresolved-link": { | ||
| "logLevel": "none" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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,113 @@ | ||
| ## API Report File for "@azure/keyvault-admin" | ||
|
|
||
| > 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'; | ||
| import { TokenCredential } from '@azure/core-http'; | ||
|
|
||
| // @public | ||
| export interface AccessControlClientOptions extends coreHttp.PipelineOptions { | ||
| serviceVersion?: SUPPORTED_API_VERSIONS; | ||
| } | ||
|
|
||
| // @public | ||
| export interface CreateRoleAssignmentOptions extends coreHttp.OperationOptions { | ||
| } | ||
|
|
||
| // @public | ||
| export interface DeleteRoleAssignmentOptions extends coreHttp.OperationOptions { | ||
| } | ||
|
|
||
| // @public | ||
| export interface GetRoleAssignmentOptions extends coreHttp.OperationOptions { | ||
| } | ||
|
|
||
| // @public | ||
| export class KeyVaultAccessControlClient { | ||
| constructor(vaultUrl: string, credential: TokenCredential, pipelineOptions?: AccessControlClientOptions); | ||
| createRoleAssignment(roleScope: RoleAssignmentScope, name: string, roleDefinitionId: string, principalId: string, options?: CreateRoleAssignmentOptions): Promise<KeyVaultRoleAssignment>; | ||
| deleteRoleAssignment(roleScope: RoleAssignmentScope, name: string, options?: DeleteRoleAssignmentOptions): Promise<KeyVaultRoleAssignment>; | ||
sadasant marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| getRoleAssignment(roleScope: RoleAssignmentScope, name: string, options?: GetRoleAssignmentOptions): Promise<KeyVaultRoleAssignment>; | ||
| listRoleAssignments(roleScope: RoleAssignmentScope, options?: ListRoleAssignmentsOptions): PagedAsyncIterableIterator<KeyVaultRoleAssignment>; | ||
| listRoleDefinitions(roleScope: RoleAssignmentScope, options?: ListRoleDefinitionsOptions): PagedAsyncIterableIterator<KeyVaultRoleDefinition>; | ||
| readonly vaultUrl: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface KeyVaultPermission { | ||
sadasant marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| actions?: string[]; | ||
| dataActions?: string[]; | ||
| notActions?: string[]; | ||
| notDataActions?: string[]; | ||
| } | ||
|
|
||
| // @public | ||
| export interface KeyVaultRoleAssignment { | ||
|
Contributor
Author
There was a problem hiding this comment. Before I do this change, let's argue about prefixes here: #10815 (comment)
Contributor
Author
There was a problem hiding this comment. @heaths I'm assuming KeyVaultRoleAssignment is favored after that conversation I mentioned ^ |
||
| readonly id: string; | ||
|
Contributor
Author
There was a problem hiding this comment. .Net has Id: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Administration/api/Azure.Security.KeyVault.Administration.netstandard2.0.cs#L121 cc: @christothes what should we use? who should we ask?
Member
There was a problem hiding this comment. IMO - |
||
| readonly name: string; | ||
| properties: KeyVaultRoleAssignmentPropertiesWithScope; | ||
| readonly type: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface KeyVaultRoleAssignmentProperties { | ||
| principalId: string; | ||
| roleDefinitionId: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface KeyVaultRoleAssignmentPropertiesWithScope { | ||
| principalId: string; | ||
| roleDefinitionId: string; | ||
| scope?: RoleAssignmentScope; | ||
| } | ||
|
|
||
| // @public | ||
| export interface KeyVaultRoleDefinition { | ||
|
Contributor
Author
There was a problem hiding this comment. Before I do this change, let's argue about prefixes here: #10815 (comment)
Contributor
Author
There was a problem hiding this comment. @heaths I'm assuming KeyVaultRoleDefinition is favored after that conversation I mentioned ^ |
||
| assignableScopes: string[]; | ||
| description: string; | ||
| readonly id: string; | ||
| readonly name: string; | ||
| permissions: KeyVaultPermission[]; | ||
| roleName: string; | ||
| roleType: string; | ||
| readonly type: string; | ||
| } | ||
|
|
||
| // @public | ||
| export const LATEST_API_VERSION = "7.2-preview"; | ||
|
|
||
| // @public | ||
| export interface ListRoleAssignmentsOptions extends coreHttp.OperationOptions { | ||
| } | ||
|
|
||
| // @public | ||
| export interface ListRoleAssignmentsPageSettings { | ||
| continuationToken?: string; | ||
| } | ||
|
|
||
| // @public | ||
| export interface ListRoleDefinitionsOptions extends coreHttp.OperationOptions { | ||
| } | ||
|
|
||
| // @public | ||
| export interface ListRoleDefinitionsPageSettings { | ||
| continuationToken?: string; | ||
| } | ||
|
|
||
| // @public | ||
| export type RoleAssignmentScope = "/" | "/keys" | string; | ||
|
Member
There was a problem hiding this comment. this feels like a weird type, though I'm not sure what would be better
Contributor
Author
There was a problem hiding this comment. The string part is because it accepts UUIDs. I wonder if we could have some UUID validator as a type? That would be generally helpful in our clients. |
||
|
|
||
| // @public | ||
| export const SDK_VERSION: string; | ||
|
|
||
| // @public | ||
| export type SUPPORTED_API_VERSIONS = "7.2-preview"; | ||
|
|
||
|
|
||
| // (No @packageDocumentation comment for this package) | ||
|
|
||
| ``` | ||
This file contains hidden or 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
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.
in python we have it as
role_assignment_nameThere 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.
same for every name parameter for role assignments
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.
.Net is using
name. I don't mind, but I'd rather reach to an agreement with @heaths , @christothes