Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial AccessControlClient for Azure.Security.KeyVault.Administration #12480

Merged
merged 21 commits into from
Jun 11, 2020
Merged

Initial AccessControlClient for Azure.Security.KeyVault.Administration #12480

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
69d36df
poc of generated client
christothes Jun 3, 2020
5126cff
cleanup
christothes Jun 3, 2020
9ba2844
implement the rest
christothes Jun 3, 2020
6cac612
export api
christothes Jun 3, 2020
1bc5150
tests
christothes Jun 8, 2020
fe08263
recorded tests
christothes Jun 8, 2020
e64d134
Merge remote-tracking branch 'upstream/master' into users/chriss/rbac
christothes Jun 8, 2020
d4c10d1
regen client
christothes Jun 8, 2020
dcab74f
fix version
christothes Jun 8, 2020
80ef6a6
xml comments
christothes Jun 8, 2020
28554ed
pr comments
christothes Jun 8, 2020
6a47d73
pr comments
christothes Jun 8, 2020
4a29e4a
diagnostic scopes
christothes Jun 8, 2020
e94d7d2
model factory
christothes Jun 8, 2020
6e728fa
adjust diagnostic scopes
christothes Jun 9, 2020
1afc104
change assignment name to Guid
christothes Jun 10, 2020
f228550
make RoleAssignmentListResult internal
christothes Jun 10, 2020
036c3c6
rename file
christothes Jun 10, 2020
31c4551
pr comments
christothes Jun 10, 2020
01ae609
remove commented shared import
christothes Jun 11, 2020
914473e
add xml docs for ArgumentNullExceptions
christothes Jun 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions ...rity.KeyVault.Administration/api/Azure.Security.KeyVault.Administration.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ public KeyVaultAccessControlClient(System.Uri vaultUri, Azure.Core.TokenCredenti
public KeyVaultAccessControlClient(System.Uri vaultUri, Azure.Core.TokenCredential credential, Azure.Security.KeyVault.Administration.KeyVaultAccessControlClientOptions options) { }
public virtual System.Uri VaultUri { get { throw null; } }
public virtual Azure.Response<Azure.Security.KeyVault.Administration.Models.RoleAssignment> CreateRoleAssignment(Azure.Security.KeyVault.Administration.RoleAssignmentScope roleScope, Azure.Security.KeyVault.Administration.Models.RoleAssignmentProperties properties, System.Guid name = default(System.Guid), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
christothes marked this conversation as resolved.
Show resolved Hide resolved
public virtual Azure.Response<Azure.Security.KeyVault.Administration.Models.RoleAssignment> CreateRoleAssignment(Azure.Security.KeyVault.Administration.RoleAssignmentScope roleScope, Azure.Security.KeyVault.Administration.Models.RoleAssignmentProperties properties, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.Models.RoleAssignment>> CreateRoleAssignmentAsync(Azure.Security.KeyVault.Administration.RoleAssignmentScope roleScope, Azure.Security.KeyVault.Administration.Models.RoleAssignmentProperties properties, System.Guid name = default(System.Guid), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<Azure.Security.KeyVault.Administration.Models.RoleAssignment> DeleteRoleAssignment(Azure.Security.KeyVault.Administration.RoleAssignmentScope roleScope, string roleAssignmentName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
christothes marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also put the id first, which is more common.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.Models.RoleAssignment>> DeleteRoleAssignmentAsync(Azure.Security.KeyVault.Administration.RoleAssignmentScope roleScope, string roleAssignmentName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
Expand All @@ -34,8 +33,8 @@ public enum ServiceVersion
private readonly int _dummyPrimitive;
public RoleAssignmentScope(string value) { throw null; }
public RoleAssignmentScope(System.Uri ResourceId) { throw null; }
public static Azure.Security.KeyVault.Administration.RoleAssignmentScope Global { get { throw null; } }
public static Azure.Security.KeyVault.Administration.RoleAssignmentScope Keys { get { throw null; } }
public static Azure.Security.KeyVault.Administration.RoleAssignmentScope Root { get { throw null; } }
public bool Equals(Azure.Security.KeyVault.Administration.RoleAssignmentScope other) { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override bool Equals(object obj) { throw null; }
Expand Down
12 changes: 11 additions & 1 deletion .../Azure.Security.KeyVault.Administration/src/Azure.Security.KeyVault.Administration.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,24 @@
<NoWarn>$(NoWarn);3021;CA1812</NoWarn>
</PropertyGroup>

<Import Project="..\..\Azure.Security.KeyVault.Shared\src\Azure.Security.KeyVault.Shared.projitems" Label="Shared" />
<!-- <Import Project="..\..\Azure.Security.KeyVault.Shared\src\Azure.Security.KeyVault.Shared.projitems" Label="Shared" /> -->
christothes marked this conversation as resolved.
Show resolved Hide resolved

<ItemGroup>
<PackageReference Include="System.Text.Json" />
</ItemGroup>

<ItemGroup>
<!-- Include just the few items we need from Azure.Security.KeyVault.Shared -->
<Compile Include="$(MSBuildThisFileDirectory)\..\..\Azure.Security.KeyVault.Shared\src\ChallengeBasedAuthenticationPolicy.cs" />
<Compile Include="$(MSBuildThisFileDirectory)\..\..\Azure.Security.KeyVault.Shared\src\ClientOptionsExtensions.cs" />
<Compile Include="$(MSBuildThisFileDirectory)\..\..\Azure.Security.KeyVault.Shared\src\IJsonSerializable.cs" />
</ItemGroup>

<ItemGroup>
<Compile Include="$(AzureCoreSharedSources)NoBodyResponse{T}.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)ForwardsClientCallsAttribute.cs" Link="Shared\%(RecursiveDir)\%(Filename)%(Extension)" />
</ItemGroup>

<ItemGroup>
<Compile Include="$(AzureCoreSharedSources)Argument.cs" Link="Shared\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)ArrayBufferWriter.cs" Link="Shared\%(RecursiveDir)\%(Filename)%(Extension)" />
Expand All @@ -28,6 +37,7 @@
<Compile Include="$(AzureCoreSharedSources)ContentTypeUtilities.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)DiagnosticScope.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)DiagnosticScopeFactory.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)HashCodeBuilder.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)HttpMessageSanitizer.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)OperationHelpers.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
<Compile Include="$(AzureCoreSharedSources)TaskExtensions.cs" Link="Shared\Core\%(RecursiveDir)\%(Filename)%(Extension)" />
Expand Down
41 changes: 15 additions & 26 deletions sdk/keyvault/Azure.Security.KeyVault.Administration/src/KeyVaultAccessControlClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ public KeyVaultAccessControlClient(Uri vaultUri, TokenCredential credential, Key
Argument.AssertNotNull(credential, nameof(credential));

VaultUri = vaultUri;
Argument.AssertNotNull(vaultUri, nameof(vaultUri));
Argument.AssertNotNull(credential, nameof(credential));

options ??= new KeyVaultAccessControlClientOptions();
string apiVersion = options.GetVersionString();
Expand All @@ -77,6 +75,7 @@ public KeyVaultAccessControlClient(Uri vaultUri, TokenCredential credential, Key
/// </summary>
/// <param name="roleScope"> The scope of the role assignments. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
christothes marked this conversation as resolved.
Show resolved Hide resolved
public virtual Pageable<RoleDefinition> GetRoleDefinitions(RoleAssignmentScope roleScope, CancellationToken cancellationToken = default)
{
return PageableHelpers.CreateEnumerable(_ =>
Expand Down Expand Up @@ -115,6 +114,7 @@ public virtual Pageable<RoleDefinition> GetRoleDefinitions(RoleAssignmentScope r
/// </summary>
/// <param name="roleScope"> The scope of the role definition. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual AsyncPageable<RoleDefinition> GetRoleDefinitionsAsync(RoleAssignmentScope roleScope, CancellationToken cancellationToken = default)
{
return PageableHelpers.CreateAsyncEnumerable(async _ =>
Expand Down Expand Up @@ -151,10 +151,11 @@ public virtual AsyncPageable<RoleDefinition> GetRoleDefinitionsAsync(RoleAssignm
}

/// <summary>
///
/// Gets the <see cref="RoleAssignment"/>s for a scope.
/// </summary>
/// <param name="roleScope"> The scope of the role assignments. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual Pageable<RoleAssignment> GetRoleAssignments(RoleAssignmentScope roleScope, CancellationToken cancellationToken = default)
{
return PageableHelpers.CreateEnumerable(_ =>
Expand Down Expand Up @@ -193,6 +194,7 @@ public virtual Pageable<RoleAssignment> GetRoleAssignments(RoleAssignmentScope r
/// </summary>
/// <param name="roleScope"> The scope of the role assignments. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual AsyncPageable<RoleAssignment> GetRoleAssignmentsAsync(RoleAssignmentScope roleScope, CancellationToken cancellationToken = default)
{
return PageableHelpers.CreateAsyncEnumerable(async _ =>
Expand Down Expand Up @@ -228,41 +230,22 @@ public virtual AsyncPageable<RoleAssignment> GetRoleAssignmentsAsync(RoleAssignm
});
}

/// <summary>
/// Creates a <see cref="RoleAssignment"/>.
/// </summary>
/// <param name="roleScope"> The scope of the role assignment to create. </param>
/// <param name="properties"> Properties for the role assignment. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public virtual Response<RoleAssignment> CreateRoleAssignment(RoleAssignmentScope roleScope, RoleAssignmentProperties properties, CancellationToken cancellationToken = default)
{
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(KeyVaultAccessControlClient)}.{nameof(CreateRoleAssignment)}");
scope.Start();
try
{
return _assignmentsRestClient.Create(VaultUri.AbsoluteUri, roleScope.ToString(), Guid.NewGuid().ToString(), properties, cancellationToken);
}
catch (Exception ex)
{
scope.Failed(ex);
throw;
}
}

/// <summary>
/// Creates a <see cref="RoleAssignment"/>.
/// </summary>
/// <param name="roleScope"> The scope of the role assignment to create. </param>
/// <param name="properties"> Properties for the role assignment. </param>
/// <param name="name">The Name used to create the role assignment.</param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual Response<RoleAssignment> CreateRoleAssignment(RoleAssignmentScope roleScope, RoleAssignmentProperties properties, Guid name = default, CancellationToken cancellationToken = default)
heaths marked this conversation as resolved.
Show resolved Hide resolved
{
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(KeyVaultAccessControlClient)}.{nameof(CreateRoleAssignment)}");
scope.Start();
try
{
return _assignmentsRestClient.Create(VaultUri.AbsoluteUri, roleScope.ToString(), name == default ? Guid.NewGuid().ToString() : name.ToString(), properties, cancellationToken);
var _name = name == default ? Guid.NewGuid().ToString() : name.ToString();
return _assignmentsRestClient.Create(VaultUri.AbsoluteUri, roleScope.ToString(), _name, properties, cancellationToken);
}
catch (Exception ex)
{
Expand All @@ -278,13 +261,15 @@ public virtual Response<RoleAssignment> CreateRoleAssignment(RoleAssignmentScope
/// <param name="properties"> Properties for the role assignment. </param>
/// <param name="name">The name used to create the role assignment.</param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual async Task<Response<RoleAssignment>> CreateRoleAssignmentAsync(RoleAssignmentScope roleScope, RoleAssignmentProperties properties, Guid name = default, CancellationToken cancellationToken = default)
christothes marked this conversation as resolved.
Show resolved Hide resolved
{
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(KeyVaultAccessControlClient)}.{nameof(CreateRoleAssignment)}");
scope.Start();
try
{
return await _assignmentsRestClient.CreateAsync(VaultUri.AbsoluteUri, roleScope.ToString(), name == default ? Guid.NewGuid().ToString() : name.ToString(), properties, cancellationToken)
var _name = name == default ? Guid.NewGuid().ToString() : name.ToString();
return await _assignmentsRestClient.CreateAsync(VaultUri.AbsoluteUri, roleScope.ToString(), _name, properties, cancellationToken)
.ConfigureAwait(false);
}
catch (Exception ex)
Expand All @@ -300,6 +285,7 @@ public virtual async Task<Response<RoleAssignment>> CreateRoleAssignmentAsync(Ro
/// <param name="roleScope"> The scope of the role assignment. </param>
/// <param name="roleAssignmentName"> The name of the role assignment to get. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual Response<RoleAssignment> GetRoleAssignment(RoleAssignmentScope roleScope, string roleAssignmentName, CancellationToken cancellationToken = default)
{
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(KeyVaultAccessControlClient)}.{nameof(GetRoleAssignment)}");
Expand All @@ -321,6 +307,7 @@ public virtual Response<RoleAssignment> GetRoleAssignment(RoleAssignmentScope ro
/// <param name="roleScope"> The scope of the role assignment. </param>
/// <param name="roleAssignmentName"> The name of the role assignment to get. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual async Task<Response<RoleAssignment>> GetRoleAssignmentAsync(RoleAssignmentScope roleScope, string roleAssignmentName, CancellationToken cancellationToken = default)
{
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(KeyVaultAccessControlClient)}.{nameof(GetRoleAssignment)}");
Expand All @@ -343,6 +330,7 @@ public virtual async Task<Response<RoleAssignment>> GetRoleAssignmentAsync(RoleA
/// <param name="roleScope"> The scope of the role assignment. </param>
/// <param name="roleAssignmentName"> The name of the role assignment to get. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual Response<RoleAssignment> DeleteRoleAssignment(RoleAssignmentScope roleScope, string roleAssignmentName, CancellationToken cancellationToken = default)
{
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(KeyVaultAccessControlClient)}.{nameof(DeleteRoleAssignment)}");
Expand All @@ -364,6 +352,7 @@ public virtual Response<RoleAssignment> DeleteRoleAssignment(RoleAssignmentScope
/// <param name="roleScope"> The scope of the role assignment. </param>
/// <param name="roleAssignmentName"> The name of the role assignment to get. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual async Task<Response<RoleAssignment>> DeleteRoleAssignmentAsync(RoleAssignmentScope roleScope, string roleAssignmentName, CancellationToken cancellationToken = default)
{
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(KeyVaultAccessControlClient)}.{nameof(DeleteRoleAssignment)}");
Expand Down
2 changes: 1 addition & 1 deletion ...keyvault/Azure.Security.KeyVault.Administration/src/KeyVaultAccessControlClientOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
namespace Azure.Security.KeyVault.Administration
{
/// <summary>
/// Options that allow you to configure the requests sent to Key Vault.
/// Options to configure the requests sent to Key Vault.
/// </summary>
public class KeyVaultAccessControlClientOptions : ClientOptions
{
Expand Down
8 changes: 4 additions & 4 deletions sdk/keyvault/Azure.Security.KeyVault.Administration/src/RoleAssignmentScope.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Azure.Security.KeyVault.Administration
/// </summary>
public readonly struct RoleAssignmentScope : IEquatable<RoleAssignmentScope>
{
internal const string RootValue = "/";
internal const string GlobalValue = "/";
internal const string KeysValue = "/keys";

private readonly string _value;
Expand All @@ -35,12 +35,12 @@ public RoleAssignmentScope(Uri ResourceId)
}

/// <summary>
/// Root.
/// Role assignments apply to everything on the resource.
/// </summary>
public static RoleAssignmentScope Root { get; } = new RoleAssignmentScope(RootValue);
public static RoleAssignmentScope Global { get; } = new RoleAssignmentScope(GlobalValue);

/// <summary>
/// Keys.
/// Role assignments apply to all Keys.
/// </summary>
public static RoleAssignmentScope Keys { get; } = new RoleAssignmentScope(KeysValue);

Expand Down
Loading