Skip to content

Commit 009caa0

Browse files
maorlegermaorleger
authored
[KeyVault] - Rename upsertRoleDefinition to setRoleDefinition (Azure#15524)
## What - Rename `accessControlClient.upsertRoleDefinition` to `accessControlClient.setRoleDefinition` ## Why Discussion in Azure#15182 prompted revisiting the name here. While either set or upsert are within our guidelines we liked `set` better and I believe it aligns well with some of the other languages. Resolves Azure#15182
1 parent 84e438d commit 009caa0

File tree

12 files changed

+42
-48
lines changed

12 files changed

+42
-48
lines changed

‎sdk/keyvault/keyvault-admin/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
"build": "tsc -p . && npm run build:nodebrowser && api-extractor run --local",
5555
"check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
5656
"clean": "rimraf dist dist-* types *.tgz *.log statistics.html coverage && rimraf src/**/*.js && rimraf test/**/*.js",
57-
"execute:samples": "dev-tools samples run samples-dev",
57+
"execute:samples": "dev-tool samples run samples-dev",
5858
"extract-api": "tsc -p . && api-extractor run --local",
5959
"format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
6060
"integration-test:browser": "echo skipped",

sdk/keyvault/keyvault-admin/recordings/node/keyvaultaccesscontrolclient_role_definitions_upsertroledefinition/recording_errors_when_name_is_not_a_valid_guid.js renamed to sdk/keyvault/keyvault-admin/recordings/node/keyvaultaccesscontrolclient_role_definitions_setroledefinition/recording_errors_when_name_is_not_a_valid_guid.js

File renamed without changes.

sdk/keyvault/keyvault-admin/recordings/node/keyvaultaccesscontrolclient_role_definitions_upsertroledefinition/recording_errors_when_updating_a_builtin_role_definition.js renamed to sdk/keyvault/keyvault-admin/recordings/node/keyvaultaccesscontrolclient_role_definitions_setroledefinition/recording_errors_when_updating_a_builtin_role_definition.js

File renamed without changes.

‎sdk/keyvault/keyvault-admin/review/keyvault-admin.api.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export class KeyVaultAccessControlClient {
4545
getRoleDefinition(roleScope: KeyVaultRoleScope, name: string, options?: GetRoleDefinitionOptions): Promise<KeyVaultRoleDefinition>;
4646
listRoleAssignments(roleScope: KeyVaultRoleScope, options?: ListRoleAssignmentsOptions): PagedAsyncIterableIterator<KeyVaultRoleAssignment>;
4747
listRoleDefinitions(roleScope: KeyVaultRoleScope, options?: ListRoleDefinitionsOptions): PagedAsyncIterableIterator<KeyVaultRoleDefinition>;
48-
upsertRoleDefinition(roleScope: KeyVaultRoleScope, options?: UpsertRoleDefinitionOptions): Promise<KeyVaultRoleDefinition>;
48+
setRoleDefinition(roleScope: KeyVaultRoleScope, options?: SetRoleDefinitionOptions): Promise<KeyVaultRoleDefinition>;
4949
readonly vaultUrl: string;
5050
}
5151

@@ -186,17 +186,17 @@ export interface ListRoleDefinitionsPageSettings {
186186
export const SDK_VERSION: string;
187187

188188
// @public
189-
export type SUPPORTED_API_VERSIONS = "7.2";
190-
191-
// @public
192-
export interface UpsertRoleDefinitionOptions extends coreHttp.OperationOptions {
189+
export interface SetRoleDefinitionOptions extends coreHttp.OperationOptions {
193190
assignableScopes?: KeyVaultRoleScope[];
194191
description?: string;
195192
permissions?: KeyVaultPermission[];
196193
roleDefinitionName?: string;
197194
roleName?: string;
198195
}
199196

197+
// @public
198+
export type SUPPORTED_API_VERSIONS = "7.2";
199+
200200

201201
// (No @packageDocumentation comment for this package)
202202

‎sdk/keyvault/keyvault-admin/samples-dev/accessControlHelloWorld.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export async function main(): Promise<void> {
4040
]
4141
}
4242
];
43-
let roleDefinition = await client.upsertRoleDefinition(globalScope, {
43+
let roleDefinition = await client.setRoleDefinition(globalScope, {
4444
roleDefinitionName,
4545
roleName: "Backup Manager",
4646
permissions,

‎sdk/keyvault/keyvault-admin/samples/v4/javascript/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ urlFragment: keyvault-admin-javascript
1212

1313
These sample programs show how to use the JavaScript client libraries for Azure Key Vault Administration in some common scenarios.
1414

15-
| **File Name** | **Description** |
16-
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
17-
| [accessControlHelloWorld.js][accesscontrolhelloworld] | Uses an KeyVaultAccessControlClient to list, create, and assign roles to users. |
18-
| [backupRestoreHelloWorld.js][backuprestorehelloworld] | Uses a KeyVaultBackupClient to backup and fully restore an Azure Key Vault using Azure Storage Blob. |
19-
| [backupSelectiveKeyRestore.js][backupselectiveKeyrestore] | Uses a KeyVaultBackupClient to backup and restore a specific key in Azure Key Vault using Azure Storage Blob. |
15+
| **File Name** | **Description** |
16+
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
17+
| [accessControlHelloWorld.js][accesscontrolhelloworld] | Uses an AccessControlClient to list, create, and assign roles to users. |
18+
| [backupRestoreHelloWorld.js][backuprestorehelloworld] | Uses a BackupClient to backup and fully restore an Azure Key Vault using Azure Storage Blob. |
19+
| [backupSelectiveKeyRestore.js][backupselectivekeyrestore] | Uses a BackupClient to backup and restore a specific key in Azure Key Vault using Azure Storage Blob. |
2020

2121
## Prerequisites
2222

@@ -66,7 +66,7 @@ Take a look at our [API Documentation][apiref] for more information about the AP
6666

6767
[accesscontrolhelloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/javascript/accessControlHelloWorld.js
6868
[backuprestorehelloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/javascript/backupRestoreHelloWorld.js
69-
[backupselectiveKeyrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/javascript/backupSelectiveKeyRestore.js
69+
[backupselectivekeyrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/javascript/backupSelectiveKeyRestore.js
7070
[apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-admin
7171
[freesub]: https://azure.microsoft.com/free/
7272
[createinstance_azurekeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal

‎sdk/keyvault/keyvault-admin/samples/v4/javascript/accessControlHelloWorld.js‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,12 @@ async function main() {
4040
]
4141
}
4242
];
43-
let roleDefinition = await client.upsertRoleDefinition(
44-
globalScope,
45-
{
46-
roleDefinitionName,
47-
roleName: "Backup Manager",
48-
permissions,
49-
description: "Allow backup actions"
50-
}
51-
);
43+
let roleDefinition = await client.setRoleDefinition(globalScope, {
44+
roleDefinitionName,
45+
roleName: "Backup Manager",
46+
permissions,
47+
description: "Allow backup actions"
48+
});
5249
console.log(roleDefinition);
5350

5451
// This sample uses a custom role but you may assign one of the many built-in roles.

‎sdk/keyvault/keyvault-admin/samples/v4/typescript/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ urlFragment: keyvault-admin-typescript
1212

1313
These sample programs show how to use the TypeScript client libraries for Azure Key Vault Administration in some common scenarios.
1414

15-
| **File Name** | **Description** |
16-
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
17-
| [accessControlHelloWorld.ts][accesscontrolhelloworld] | Uses an KeyVaultAccessControlClient to list, create, and assign roles to users. |
18-
| [backupRestoreHelloWorld.ts][backuprestorehelloworld] | Uses a KeyVaultBackupClient to backup and fully restore an Azure Key Vault using Azure Storage Blob. |
19-
| [backupSelectiveKeyRestore.ts][backupselectiveKeyrestore] | Uses a KeyVaultBackupClient to backup and restore a specific key in Azure Key Vault using Azure Storage Blob. |
15+
| **File Name** | **Description** |
16+
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
17+
| [accessControlHelloWorld.ts][accesscontrolhelloworld] | Uses an AccessControlClient to list, create, and assign roles to users. |
18+
| [backupRestoreHelloWorld.ts][backuprestorehelloworld] | Uses a BackupClient to backup and fully restore an Azure Key Vault using Azure Storage Blob. |
19+
| [backupSelectiveKeyRestore.ts][backupselectivekeyrestore] | Uses a BackupClient to backup and restore a specific key in Azure Key Vault using Azure Storage Blob. |
2020

2121
## Prerequisites
2222

@@ -78,7 +78,7 @@ Take a look at our [API Documentation][apiref] for more information about the AP
7878

7979
[accesscontrolhelloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/typescript/src/accessControlHelloWorld.ts
8080
[backuprestorehelloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/typescript/src/backupRestoreHelloWorld.ts
81-
[backupselectiveKeyrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/typescript/src/backupSelectiveKeyRestore.ts
81+
[backupselectivekeyrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/v4/typescript/src/backupSelectiveKeyRestore.ts
8282
[apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-admin
8383
[freesub]: https://azure.microsoft.com/free/
8484
[createinstance_azurekeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal

‎sdk/keyvault/keyvault-admin/samples/v4/typescript/src/accessControlHelloWorld.ts‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,12 @@ export async function main(): Promise<void> {
4040
]
4141
}
4242
];
43-
let roleDefinition = await client.upsertRoleDefinition(
44-
globalScope,
45-
{
46-
roleDefinitionName,
47-
roleName: "Backup Manager",
48-
permissions,
49-
description: "Allow backup actions"
50-
}
51-
);
43+
let roleDefinition = await client.setRoleDefinition(globalScope, {
44+
roleDefinitionName,
45+
roleName: "Backup Manager",
46+
permissions,
47+
description: "Allow backup actions"
48+
});
5249
console.log(roleDefinition);
5350

5451
// This sample uses a custom role but you may assign one of the many built-in roles.

‎sdk/keyvault/keyvault-admin/src/accessControlClient.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import {
3131
ListRoleDefinitionsPageSettings,
3232
ListRoleAssignmentsPageSettings,
3333
GetRoleDefinitionOptions,
34-
UpsertRoleDefinitionOptions,
34+
SetRoleDefinitionOptions,
3535
DeleteRoleDefinitionOptions
3636
} from "./accessControlModels";
3737

@@ -451,11 +451,11 @@ export class KeyVaultAccessControlClient {
451451
* @param description - The role definition description.
452452
* @param options - The optional parameters.
453453
*/
454-
public upsertRoleDefinition(
454+
public setRoleDefinition(
455455
roleScope: KeyVaultRoleScope,
456-
options: UpsertRoleDefinitionOptions = {}
456+
options: SetRoleDefinitionOptions = {}
457457
): Promise<KeyVaultRoleDefinition> {
458-
return withTrace("upsertRoleDefinition", options, async (updatedOptions) => {
458+
return withTrace("setRoleDefinition", options, async (updatedOptions) => {
459459
const response = await this.client.roleDefinitions.createOrUpdate(
460460
this.vaultUrl,
461461
roleScope,

0 commit comments

Comments
 (0)