Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
225 changes: 61 additions & 164 deletions sdk/keyvault/azure-security-keyvault-administration/README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultAccessControlAsyncClient.instantiation -->
* <pre>
* KeyVaultAccessControlAsyncClient keyVaultAccessControlAsyncClient = new KeyVaultAccessControlClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildAsyncClient&#40;&#41;;
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultAccessControlClient.instantiation -->
* <pre>
* KeyVaultAccessControlClient keyVaultAccessControlClient = new KeyVaultAccessControlClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildClient&#40;&#41;;
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultAccessControlClient.instantiation -->
* <pre>
* KeyVaultAccessControlClient keyVaultAccessControlClient = new KeyVaultAccessControlClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildClient&#40;&#41;;
* </pre>
Expand All @@ -61,7 +61,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultAccessControlAsyncClient.instantiation -->
* <pre>
* KeyVaultAccessControlAsyncClient keyVaultAccessControlAsyncClient = new KeyVaultAccessControlClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildAsyncClient&#40;&#41;;
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultBackupAsyncClient.instantiation -->
* <pre>
* KeyVaultBackupAsyncClient keyVaultBackupAsyncClient = new KeyVaultBackupClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildAsyncClient&#40;&#41;;
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultBackupClient.instantiation -->
* <pre>
* KeyVaultBackupClient keyVaultBackupClient = new KeyVaultBackupClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildClient&#40;&#41;;
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultBackupClient.instantiation -->
* <pre>
* KeyVaultBackupClient keyVaultBackupClient = new KeyVaultBackupClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildClient&#40;&#41;;
* </pre>
Expand All @@ -60,7 +60,7 @@
* <!-- src_embed com.azure.security.keyvault.administration.keyVaultBackupAsyncClient.instantiation -->
* <pre>
* KeyVaultBackupAsyncClient keyVaultBackupAsyncClient = new KeyVaultBackupClientBuilder&#40;&#41;
* .vaultUrl&#40;&quot;https:&#47;&#47;myaccount.managedhsm.azure.net&#47;&quot;&#41;
* .vaultUrl&#40;&quot;&lt;your-managed-hsm-url&gt;&quot;&#41;
* .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
* .buildAsyncClient&#40;&#41;;
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ public class AccessControlHelloWorld {
*/
public static void main(String[] args) {
/* Instantiate a KeyVaultAccessControlClient that will be used to call the service. Notice that the client is
using default Azure credentials. To make default credentials work, ensure that environment variables
'AZURE_CLIENT_ID', 'AZURE_CLIENT_KEY' and 'AZURE_TENANT_ID' are set with the service principal credentials.
using default Azure credentials. For more information on this and other types of credentials, see this document:
https://docs.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable.

To get started, you'll need a URI to an Azure Key Vault. See the README (https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
To get started, you'll need a URL to an Azure Key Vault Managed HSM. See the README
(https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
for links and instructions. */
KeyVaultAccessControlClient accessControlClient = new KeyVaultAccessControlClientBuilder()
.vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ public class AccessControlHelloWorldAsync {
*/
public static void main(String[] args) throws InterruptedException {
/* Instantiate a KeyVaultAccessControlAsyncClient that will be used to call the service. Notice that the client
is using default Azure credentials. To make default credentials work, ensure that environment variables
'AZURE_CLIENT_ID', 'AZURE_CLIENT_KEY' and 'AZURE_TENANT_ID' are set with the service principal credentials.
is using default Azure credentials. For more information on this and other types of credentials, see this
document: https://docs.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable.

To get started, you'll need a URI to an Azure Key Vault. See the README (https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
To get started, you'll need a URL to an Azure Key Vault Managed HSM. See the README
(https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
for links and instructions. */
KeyVaultAccessControlAsyncClient accessControlAsyncClient = new KeyVaultAccessControlClientBuilder()
.vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,17 @@ public class BackupAndRestoreHelloWorld {
* @throws IllegalArgumentException when an invalid key vault URL is passed.
*/
public static void main(String[] args) {
/* Instantiate a KeyVaultBackupClient that will be used to call the service. Notice that the client is using
default Azure credentials. To make default credentials work, ensure that environment variables
'AZURE_CLIENT_ID', 'AZURE_CLIENT_KEY' and 'AZURE_TENANT_ID' are set with the service principal credentials.

To get started, you'll need a URI to an Azure Key Vault. See the README (https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
for links and instructions. */
KeyVaultBackupClient backupClient = new KeyVaultBackupClientBuilder()
.vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
/* Instantiate a KeyVaultBackupClient that will be used to call the service. Notice that the client is using
default Azure credentials. For more information on this and other types of credentials, see this document:
https://docs.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable.

To get started, you'll need a URL to an Azure Key Vault Managed HSM. See the README
(https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
for links and instructions. */

/* Using the KeyVaultBackupClient, you can back up your entire collection of keys. The backing store for full
key backups is a blob storage container using Shared Access Signature authentication. For more details on
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@ public class BackupAndRestoreHelloWorldAsync {
* @throws IllegalArgumentException when an invalid key vault URL is passed.
*/
public static void main(String[] args) {
/* Instantiate a KeyVaultAccessControlClient that will be used to call the service. Notice that the client is
using default Azure credentials. To make default credentials work, ensure that environment variables
'AZURE_CLIENT_ID', 'AZURE_CLIENT_KEY' and 'AZURE_TENANT_ID' are set with the service principal credentials.
/* Instantiate a KeyVaultBackupAsyncClient that will be used to call the service. Notice that the client is
using default Azure credentials. For more information on this and other types of credentials, see this document:
https://docs.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable.

To get started, you'll need a URI to an Azure Key Vault. See the README (https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
To get started, you'll need a URL to an Azure Key Vault Managed HSM. See the README
(https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
for links and instructions. */
KeyVaultBackupAsyncClient backupAsyncClient = new KeyVaultBackupClientBuilder()
.vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,15 @@ public class CreateRoleAssignmentsForDifferentScopes {
* @throws IllegalArgumentException when an invalid key vault URL is passed.
*/
public static void main(String[] args) {
/* Instantiate a KeyVaultBackupAsyncClient that will be used to call the service. Notice that the client is
using default Azure credentials. To make default credentials work, ensure that environment variables
'AZURE_CLIENT_ID', 'AZURE_CLIENT_KEY' and 'AZURE_TENANT_ID' are set with the service principal credentials.
/* Instantiate a KeyVaultAccessControlClient that will be used to call the service. Notice that the client is
using default Azure credentials. For more information on this and other types of credentials, see this document:
https://docs.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable.

To get started, you'll need a URI to an 1Azure Key Vault. See the README (https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
To get started, you'll need a URL to an Azure Key Vault Managed HSM. See the README
(https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
for links and instructions. */
KeyVaultAccessControlClient accessControlClient = new KeyVaultAccessControlClientBuilder()
.vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@
public class ReadmeSamples {
private final KeyVaultAccessControlClient keyVaultAccessControlClient =
new KeyVaultAccessControlClientBuilder()
.vaultUrl("<your-access-control-key-vault-url>")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
private final KeyVaultAccessControlAsyncClient keyVaultAccessControlAsyncClient =
new KeyVaultAccessControlClientBuilder()
.vaultUrl("<your-access-control-key-vault-url>")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();
private final KeyVaultBackupClient keyVaultBackupClient =
new KeyVaultBackupClientBuilder()
.vaultUrl("<your-backup-key-vault-url>")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
private final KeyVaultBackupAsyncClient keyVaultBackupAsyncClient =
new KeyVaultBackupClientBuilder()
.vaultUrl("<your-backup-key-vault-url>")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();

Expand All @@ -53,7 +53,7 @@ public class ReadmeSamples {
public void createAccessControlClient() {
// BEGIN: readme-sample-createAccessControlClient
KeyVaultAccessControlClient keyVaultAccessControlClient = new KeyVaultAccessControlClientBuilder()
.vaultUrl("<your-key-vault-url>")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
// END: readme-sample-createAccessControlClient
Expand Down Expand Up @@ -273,7 +273,7 @@ public void deleteRoleAssignmentAsync() {
public void createBackupClient() {
// BEGIN: readme-sample-createBackupClient
KeyVaultBackupClient keyVaultBackupClient = new KeyVaultBackupClientBuilder()
.vaultUrl("<your-key-vault-url>")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
// END: readme-sample-createBackupClient
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ public class SelectiveKeyRestore {
* @throws IllegalArgumentException when an invalid key vault URL is passed.
*/
public static void main(String[] args) {
/* Instantiate an KeyVaultAccessControlClient that will be used to call the service. Notice that the client is
using default Azure credentials. To make default credentials work, ensure that environment variables
'AZURE_CLIENT_ID', 'AZURE_CLIENT_KEY' and 'AZURE_TENANT_ID' are set with the service principal credentials.
/* Instantiate a KeyVaultBackupClient that will be used to call the service. Notice that the client is using
default Azure credentials. For more information on this and other types of credentials, see this document:
https://docs.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable.

To get started, you'll need a URI to an Azure Key Vault. See the README (https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
To get started, you'll need a URL to an Azure Key Vault Managed HSM. See the README
(https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/keyvault/azure-security-keyvault-administration/README.md)
for links and instructions. */
KeyVaultBackupClient backupClient = new KeyVaultBackupClientBuilder()
.vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class KeyVaultAccessControlAsyncClientJavaDocCodeSnippets {
public KeyVaultAccessControlAsyncClient createAsyncClient() {
// BEGIN: com.azure.security.keyvault.administration.keyVaultAccessControlAsyncClient.instantiation
KeyVaultAccessControlAsyncClient keyVaultAccessControlAsyncClient = new KeyVaultAccessControlClientBuilder()
.vaultUrl("https://myaccount.managedhsm.azure.net/")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();
// END: com.azure.security.keyvault.administration.keyVaultAccessControlAsyncClient.instantiation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public class KeyVaultAccessControlClientJavaDocCodeSnippets {
public KeyVaultAccessControlClient createClient() {
// BEGIN: com.azure.security.keyvault.administration.keyVaultAccessControlClient.instantiation
KeyVaultAccessControlClient keyVaultAccessControlClient = new KeyVaultAccessControlClientBuilder()
.vaultUrl("https://myaccount.managedhsm.azure.net/")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
// END: com.azure.security.keyvault.administration.keyVaultAccessControlClient.instantiation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class KeyVaultBackupAsyncClientJavaDocCodeSnippets {
public KeyVaultBackupAsyncClient createAsyncClient() {
// BEGIN: com.azure.security.keyvault.administration.keyVaultBackupAsyncClient.instantiation
KeyVaultBackupAsyncClient keyVaultBackupAsyncClient = new KeyVaultBackupClientBuilder()
.vaultUrl("https://myaccount.managedhsm.azure.net/")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();
// END: com.azure.security.keyvault.administration.keyVaultBackupAsyncClient.instantiation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public class KeyVaultBackupClientJavaDocCodeSnippets {
public KeyVaultBackupClient createClient() {
// BEGIN: com.azure.security.keyvault.administration.keyVaultBackupClient.instantiation
KeyVaultBackupClient keyVaultBackupClient = new KeyVaultBackupClientBuilder()
.vaultUrl("https://myaccount.managedhsm.azure.net/")
.vaultUrl("<your-managed-hsm-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
// END: com.azure.security.keyvault.administration.keyVaultBackupClient.instantiation
Expand Down
Loading