Skip to content

Commit

Permalink
[KeyVault] Add support for service version 7.6-preview.1 (Azure#43811)
Browse files Browse the repository at this point in the history
* wip

* wip

* Update Azure.Security.KeyVault.Secrets.netstandard2.0.cs

* update generation

* Update Azure.Security.KeyVault.Administration.netstandard2.0.cs

* Update CONTRIBUTING.md

* Add new version in ClientOptions and tests for Administration

* Export API

* Remove server-side fix from changelog

* Update sdk/keyvault/Azure.Security.KeyVault.Certificates/CHANGELOG.md

* Add new endpoints definitions to readme

* Add new Pre-backup methods

* Documentation for PreBackup methods

* Update method names in KeyVaultBackupClient for clarity

* Add pre-restore methods

* Export API

* Use a flag to handle different headers in RestoreOperation

* Update Administration Changelog

* Add tests for Administration

* Update preBackup and preRestore tests

* Missing new version in CertificatesClientOptions

* Re-record CertificateClientLiveTests

* Remove unninteded line in Keys Changelog

* Improve admin changelod message and clean samples in readme

* nit changes

* Format Changelog md files

* Add null argument checks in KeyVaultBackupClient methods and document exceptions

* Introducing the KeyVaultPreBackupOperation and KeyVaultPreRestoreOperation classes.

* Ignore tests for preview version

* Revert changes in KeyVaultRestoreOperation

* Include possible exceptions to pre-operation classes

* Record Secrets

* Record Keys tests

* Record admin

* Re-record failing tests for Secrets

* Update test-resources json to output the Tenant ID too

* Export API and remove unused snippets

---------

Co-authored-by: Jonathan Cardenas <JonathanCrd@users.noreply.github.com>
  • Loading branch information
nisha-bhatia and JonathanCrd authored Aug 26, 2024
1 parent bbed3b4 commit 699c7de
Show file tree
Hide file tree
Showing 43 changed files with 1,079 additions and 72 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,17 @@

### Features Added

- Added support for service API version `7.6-preview.1`.
- Added new methods `StartPreRestoreAsync`, `StartPreRestore`, `StartPreBackupAsync`, and `StartPreBackupAsync` to the `KeyVaultBackupClient`.

### Breaking Changes

### Bugs Fixed

### Other Changes

- The default service version is now "V7_6_Preview_1".

## 4.4.0 (2024-02-14)

Changes from both the last release and the last beta include:
Expand Down Expand Up @@ -83,8 +88,8 @@ The following changes are only breaking from the previous beta. They are not bre
### Breaking Changes

- Verify the challenge resource matches the vault domain.
This should affect few customers who can set `KeyVaultAdministrationClientOptions.DisableChallengeResourceVerification` to `true` to disable.
See https://aka.ms/azsdk/blog/vault-uri for more information.
This should affect few customers who can set `KeyVaultAdministrationClientOptions.DisableChallengeResourceVerification` to `true` to disable.
See <https://aka.ms/azsdk/blog/vault-uri> for more information.

## 4.1.0 (2022-03-24)

Expand Down
6 changes: 6 additions & 0 deletions sdk/keyvault/Azure.Security.KeyVault.Administration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,16 @@ A `KeyVaultAccessControlClient` provides both synchronous and asynchronous opera

A `KeyVaultBackupClient` provides both synchronous and asynchronous operations for performing full key backups, full key restores, and selective key restores.

### PreBackupOperation
A `PreBackupOperation` represents a long-running operation that checks if it is possible to perform a full key backup.

### BackupOperation

A `BackupOperation` represents a long running operation for a full key backup.

### PreRestoreOperation
A `PreRestoreOperation` represents a long-running operation that checks if it is possible to perform a full key restore from a backup.

### RestoreOperation

A `RestoreOperation` represents a long running operation for both a full key and selective key restore.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public KeyVaultAccessControlClient(System.Uri vaultUri, Azure.Core.TokenCredenti
}
public partial class KeyVaultAdministrationClientOptions : Azure.Core.ClientOptions
{
public KeyVaultAdministrationClientOptions(Azure.Security.KeyVault.Administration.KeyVaultAdministrationClientOptions.ServiceVersion version = Azure.Security.KeyVault.Administration.KeyVaultAdministrationClientOptions.ServiceVersion.V7_5) { }
public KeyVaultAdministrationClientOptions(Azure.Security.KeyVault.Administration.KeyVaultAdministrationClientOptions.ServiceVersion version = Azure.Security.KeyVault.Administration.KeyVaultAdministrationClientOptions.ServiceVersion.V7_6_Preview_1) { }
public bool DisableChallengeResourceVerification { get { throw null; } set { } }
public Azure.Security.KeyVault.Administration.KeyVaultAdministrationClientOptions.ServiceVersion Version { get { throw null; } }
public enum ServiceVersion
Expand All @@ -52,6 +52,7 @@ public enum ServiceVersion
V7_3 = 2,
V7_4 = 3,
V7_5 = 4,
V7_6_Preview_1 = 5,
}
}
public static partial class KeyVaultAdministrationModelFactory
Expand Down Expand Up @@ -79,6 +80,10 @@ public KeyVaultBackupClient(System.Uri vaultUri, Azure.Core.TokenCredential cred
public virtual System.Uri VaultUri { get { throw null; } }
public virtual Azure.Security.KeyVault.Administration.KeyVaultBackupOperation StartBackup(System.Uri blobStorageUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Administration.KeyVaultBackupOperation> StartBackupAsync(System.Uri blobStorageUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Security.KeyVault.Administration.KeyVaultPreBackupOperation StartPreBackup(System.Uri blobStorageUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Administration.KeyVaultPreBackupOperation> StartPreBackupAsync(System.Uri blobStorageUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Security.KeyVault.Administration.KeyVaultPreRestoreOperation StartPreRestore(System.Uri folderUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Administration.KeyVaultPreRestoreOperation> StartPreRestoreAsync(System.Uri folderUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Security.KeyVault.Administration.KeyVaultRestoreOperation StartRestore(System.Uri folderUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Administration.KeyVaultRestoreOperation> StartRestoreAsync(System.Uri folderUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Security.KeyVault.Administration.KeyVaultSelectiveKeyRestoreOperation StartSelectiveKeyRestore(string keyName, System.Uri folderUri, string sasToken = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
Expand Down Expand Up @@ -165,6 +170,38 @@ public KeyVaultPermission() { }
public System.Collections.Generic.IList<string> NotActions { get { throw null; } }
public System.Collections.Generic.IList<Azure.Security.KeyVault.Administration.KeyVaultDataAction> NotDataActions { get { throw null; } }
}
public partial class KeyVaultPreBackupOperation : Azure.Operation<Azure.Security.KeyVault.Administration.KeyVaultBackupResult>
{
protected KeyVaultPreBackupOperation() { }
public KeyVaultPreBackupOperation(Azure.Security.KeyVault.Administration.KeyVaultBackupClient client, string id) { }
public System.DateTimeOffset? EndTime { get { throw null; } }
public override bool HasCompleted { get { throw null; } }
public override bool HasValue { get { throw null; } }
public override string Id { get { throw null; } }
public System.DateTimeOffset? StartTime { get { throw null; } }
public override Azure.Security.KeyVault.Administration.KeyVaultBackupResult Value { get { throw null; } }
public override Azure.Response GetRawResponse() { throw null; }
public override Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public override System.Threading.Tasks.ValueTask<Azure.Response> UpdateStatusAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultBackupResult>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultBackupResult>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken) { throw null; }
}
public partial class KeyVaultPreRestoreOperation : Azure.Operation<Azure.Security.KeyVault.Administration.KeyVaultRestoreResult>
{
protected KeyVaultPreRestoreOperation() { }
public KeyVaultPreRestoreOperation(Azure.Security.KeyVault.Administration.KeyVaultBackupClient client, string id) { }
public System.DateTimeOffset? EndTime { get { throw null; } }
public override bool HasCompleted { get { throw null; } }
public override bool HasValue { get { throw null; } }
public override string Id { get { throw null; } }
public System.DateTimeOffset? StartTime { get { throw null; } }
public override Azure.Security.KeyVault.Administration.KeyVaultRestoreResult Value { get { throw null; } }
public override Azure.Response GetRawResponse() { throw null; }
public override Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public override System.Threading.Tasks.ValueTask<Azure.Response> UpdateStatusAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultRestoreResult>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultRestoreResult>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken) { throw null; }
}
public partial class KeyVaultRestoreOperation : Azure.Operation<Azure.Security.KeyVault.Administration.KeyVaultRestoreResult>
{
protected KeyVaultRestoreOperation() { }
Expand Down Expand Up @@ -337,3 +374,13 @@ public readonly partial struct KeyVaultSettingValue
public override string ToString() { throw null; }
}
}
namespace Azure.Security.KeyVault.Administration.Models
{
public partial class PreBackupOperationParameters
{
public PreBackupOperationParameters() { }
public string StorageResourceUri { get { throw null; } set { } }
public string Token { get { throw null; } set { } }
public bool? UseManagedIdentity { get { throw null; } set { } }
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "net",
"TagPrefix": "net/keyvault/Azure.Security.KeyVault.Administration",
"Tag": "net/keyvault/Azure.Security.KeyVault.Administration_4951f6b8e1"
"Tag": "net/keyvault/Azure.Security.KeyVault.Administration_2b51d5440c"
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 699c7de

Please sign in to comment.