Added sync and async quickstart guides for key rotation. (Azure#24836)

* Added sync nd async quickstart guides for key rotation.

* Applied PR comments.

Author: vcolin7

sdk/core/azure-core-serializer-avro-apache/src/test/java/com/azure/core/serializer/avro/apache/generatedtestsources/HandOfCards.java

@@ -71,7 +71,7 @@ public static HandOfCards fromByteBuffer(
     return DECODER.decode(b);
   }
 
-  @Deprecated public java.util.List<com.azure.core.serializer.avro.apache.generatedtestsources.PlayingCard> cards;
+   private java.util.List<com.azure.core.serializer.avro.apache.generatedtestsources.PlayingCard> cards;
 
   /**
    * Default constructor.  Note that this does not initialize fields
@@ -94,7 +94,7 @@ public HandOfCards(java.util.List<com.azure.core.serializer.avro.apache.generate
   public java.lang.Object get(int field$) {
     switch (field$) {
     case 0: return cards;
-    default: throw new org.apache.avro.AvroRuntimeException("Bad index");
+    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
     }
   }
 
@@ -103,7 +103,7 @@ public java.lang.Object get(int field$) {
   public void put(int field$, java.lang.Object value$) {
     switch (field$) {
     case 0: cards = (java.util.List<com.azure.core.serializer.avro.apache.generatedtestsources.PlayingCard>)value$; break;
-    default: throw new org.apache.avro.AvroRuntimeException("Bad index");
+    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
     }
   }
 

sdk/core/azure-core-serializer-avro-apache/src/test/java/com/azure/core/serializer/avro/apache/generatedtestsources/LongLinkedList.java

@@ -71,8 +71,8 @@ public static LongLinkedList fromByteBuffer(
     return DECODER.decode(b);
   }
 
-  @Deprecated public long value;
-  @Deprecated public com.azure.core.serializer.avro.apache.generatedtestsources.LongLinkedList next;
+   private long value;
+   private com.azure.core.serializer.avro.apache.generatedtestsources.LongLinkedList next;
 
   /**
    * Default constructor.  Note that this does not initialize fields
@@ -98,7 +98,7 @@ public java.lang.Object get(int field$) {
     switch (field$) {
     case 0: return value;
     case 1: return next;
-    default: throw new org.apache.avro.AvroRuntimeException("Bad index");
+    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
     }
   }
 
@@ -108,7 +108,7 @@ public void put(int field$, java.lang.Object value$) {
     switch (field$) {
     case 0: value = (java.lang.Long)value$; break;
     case 1: next = (com.azure.core.serializer.avro.apache.generatedtestsources.LongLinkedList)value$; break;
-    default: throw new org.apache.avro.AvroRuntimeException("Bad index");
+    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
     }
   }
 
@@ -321,6 +321,7 @@ public com.azure.core.serializer.avro.apache.generatedtestsources.LongLinkedList
      * @param value The builder instance that must be set.
      * @return This builder.
      */
+
     public com.azure.core.serializer.avro.apache.generatedtestsources.LongLinkedList.Builder setNextBuilder(com.azure.core.serializer.avro.apache.generatedtestsources.LongLinkedList.Builder value) {
       clearNext();
       nextBuilder = value;

sdk/core/azure-core-serializer-avro-apache/src/test/java/com/azure/core/serializer/avro/apache/generatedtestsources/PlayingCard.java

@@ -71,9 +71,9 @@ public static PlayingCard fromByteBuffer(
     return DECODER.decode(b);
   }
 
-  @Deprecated public boolean isFaceCard;
-  @Deprecated public int cardValue;
-  @Deprecated public com.azure.core.serializer.avro.apache.generatedtestsources.PlayingCardSuit playingCardSuit;
+   private boolean isFaceCard;
+   private int cardValue;
+   private com.azure.core.serializer.avro.apache.generatedtestsources.PlayingCardSuit playingCardSuit;
 
   /**
    * Default constructor.  Note that this does not initialize fields
@@ -102,7 +102,7 @@ public java.lang.Object get(int field$) {
     case 0: return isFaceCard;
     case 1: return cardValue;
     case 2: return playingCardSuit;
-    default: throw new org.apache.avro.AvroRuntimeException("Bad index");
+    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
     }
   }
 
@@ -113,7 +113,7 @@ public void put(int field$, java.lang.Object value$) {
     case 0: isFaceCard = (java.lang.Boolean)value$; break;
     case 1: cardValue = (java.lang.Integer)value$; break;
     case 2: playingCardSuit = (com.azure.core.serializer.avro.apache.generatedtestsources.PlayingCardSuit)value$; break;
-    default: throw new org.apache.avro.AvroRuntimeException("Bad index");
+    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
     }
   }
 

sdk/keyvault/azure-security-keyvault-keys/src/samples/java/com/azure/security/keyvault/keys/KeyRotation.java

@@ -0,0 +1,66 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.security.keyvault.keys;
+
+import com.azure.identity.DefaultAzureCredentialBuilder;
+import com.azure.security.keyvault.keys.models.CreateRsaKeyOptions;
+import com.azure.security.keyvault.keys.models.KeyRotationLifetimeAction;
+import com.azure.security.keyvault.keys.models.KeyRotationPolicy;
+import com.azure.security.keyvault.keys.models.KeyRotationPolicyAction;
+import com.azure.security.keyvault.keys.models.KeyRotationPolicyProperties;
+import com.azure.security.keyvault.keys.models.KeyVaultKey;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/*
+ * This sample demonstrates how to set key rotation policies and manually rotate keys in Key Vault to create a new key
+ * version.
+ */
+public class KeyRotation {
+    /**
+     * Authenticates with the key vault and shows set key rotation policies and manually rotate keys in Key Vault to
+     * create a new key version.
+     *
+     * @param args Unused. Arguments to the program.
+     * @throws IllegalArgumentException when an invalid key vault endpoint is passed.
+     */
+    public static void main(String[] args) {
+        // Instantiate a KeyClient that will be used to call the service. Notice that the KeyClient 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.
+        KeyClient keyClient = new KeyClientBuilder()
+            .vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
+            .credential(new DefaultAzureCredentialBuilder().build())
+            .buildClient();
+
+        // Let's create an RSA key.
+        String keyName = "MyKey";
+        KeyVaultKey originalKey = keyClient.createRsaKey(new CreateRsaKeyOptions(keyName).setKeySize(2048));
+
+        System.out.printf("Key created with name %s and type %s%n", originalKey.getName(), originalKey.getKeyType());
+
+        // You can configure its key rotation policy to allow Azure Key Vault to do it automatically under certain
+        // conditions.
+        List<KeyRotationLifetimeAction> keyRotationLifetimeActionList = new ArrayList<>();
+        KeyRotationLifetimeAction rotateLifetimeAction = new KeyRotationLifetimeAction(KeyRotationPolicyAction.ROTATE)
+            .setTimeAfterCreate("P90D"); // Rotate the key after 90 days of its creation.
+        keyRotationLifetimeActionList.add(rotateLifetimeAction);
+        KeyRotationPolicyProperties keyRotationPolicyProperties = new KeyRotationPolicyProperties()
+            .setLifetimeActions(keyRotationLifetimeActionList)
+            .setExpiryTime("P6M"); // Make any new versions of the key expire 6 months after creation.
+
+        // An object containing the details of the recently updated key rotation policy will be returned by the update
+        // method.
+        KeyRotationPolicy keyRotationPolicy =
+            keyClient.updateKeyRotationPolicy(keyName, keyRotationPolicyProperties);
+
+        System.out.printf("Updated key rotation policy with id: %s%n", keyRotationPolicy.getId());
+
+        // You can also manually rotate a key by calling the following method.
+        KeyVaultKey manuallyRotatedKey = keyClient.rotateKey(keyName);
+
+        System.out.printf("Rotated key with name %s%n", manuallyRotatedKey.getName());
+    }
+}

sdk/keyvault/azure-security-keyvault-keys/src/samples/java/com/azure/security/keyvault/keys/KeyRotationAsync.java

@@ -0,0 +1,64 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.security.keyvault.keys;
+
+import com.azure.identity.DefaultAzureCredentialBuilder;
+import com.azure.security.keyvault.keys.models.CreateRsaKeyOptions;
+import com.azure.security.keyvault.keys.models.KeyRotationLifetimeAction;
+import com.azure.security.keyvault.keys.models.KeyRotationPolicyAction;
+import com.azure.security.keyvault.keys.models.KeyRotationPolicyProperties;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/*
+ * This sample demonstrates how to set key rotation policies and manually rotate keys in Key Vault to create a new key
+ * version.
+ */
+public class KeyRotationAsync {
+    /**
+     * Authenticates with the key vault and shows set key rotation policies and manually rotate keys in Key Vault to
+     * create a new key version.
+     *
+     * @param args Unused. Arguments to the program.
+     * @throws IllegalArgumentException when an invalid key vault endpoint is passed.
+     */
+    public static void main(String[] args) {
+        // Instantiate a KeyAsyncClient that will be used to call the service. Notice that the KeyAsyncClient 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.
+        KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
+            .vaultUrl("https://{YOUR_VAULT_NAME}.vault.azure.net")
+            .credential(new DefaultAzureCredentialBuilder().build())
+            .buildAsyncClient();
+
+        // Let's create an RSA key.
+        String keyName = "MyKey";
+        keyAsyncClient.createRsaKey(new CreateRsaKeyOptions(keyName).setKeySize(2048))
+            .subscribe(originalKey ->
+                System.out.printf("Key created with name: %s, and type: %s%n", originalKey.getName(),
+                    originalKey.getKeyType()));
+
+        // You can configure its key rotation policy to allow Azure Key Vault to do it automatically under certain
+        // conditions.
+        List<KeyRotationLifetimeAction> keyRotationLifetimeActionList = new ArrayList<>();
+        KeyRotationLifetimeAction rotateLifetimeAction = new KeyRotationLifetimeAction(KeyRotationPolicyAction.ROTATE)
+            .setTimeAfterCreate("P90D"); // Rotate the key after 90 days of its creation.
+        keyRotationLifetimeActionList.add(rotateLifetimeAction);
+        KeyRotationPolicyProperties keyRotationPolicyProperties = new KeyRotationPolicyProperties()
+            .setLifetimeActions(keyRotationLifetimeActionList)
+            .setExpiryTime("P6M"); // Make any new versions of the key expire 6 months after creation.
+
+        // An object containing the details of the recently updated key rotation policy will be returned by the update
+        // method.
+        keyAsyncClient.updateKeyRotationPolicy(keyName, keyRotationPolicyProperties)
+            .subscribe(keyRotationPolicy ->
+                System.out.printf("Updated key rotation policy with id: %s%n", keyRotationPolicy.getId()));
+
+        // You can also manually rotate a key by calling the following method.
+        keyAsyncClient.rotateKey(keyName)
+            .subscribe(manuallyRotatedKey ->
+                System.out.printf("Rotated key with name: %s%n", manuallyRotatedKey.getName()));
+    }
+}