Merge pull request #488 from Saglodha/master

Addition of schema to schema groups in event hub - PS/ Bash sample

Author: serkantkaraca

samples/Management/CLI/AddschematoSchemaGroups/AD.sh

@@ -0,0 +1,9 @@
+#Step 1- first step is to get the bearer token using client credential flow. We should set the resource to be URL encoded string for eventhubs.azure.net
+response=$(curl -X POST -d  'grant_type=client_credentials&client_id=<Application_ID>&client_secret=<Application_Secret>&resource=https%3A%2F%2Feventhubs.azure.net' https://login.microsoftonline.com/<Tenant_Id>/oauth2/token)
+
+#formatting token to drop "" quotes and suffixing bearer for final use
+token="Bearer `echo $response | jq ."access_token" | tr -d '"'`"
+
+#Step 2-Making a REST call to dataplane endpoint to add schema to schema groups
+curl -X PUT -d '{"namespace": "com.azure.schemaregistry.samples","type": "record","name": "Order","fields": [{"name": "id","type": "string"},{"name": "amount","type": "double"}]}'  -H "Content-Type:application/json" -H "Authorization:$token" -H "Serialization-Type:Avro" \
+'https://<Namespace_Name>.servicebus.windows.net/$schemagroups/<SchemaGroup_Name>/schemas/<Schema_Name>?api-version=2020-09-01-preview'

samples/Management/CLI/AddschematoSchemaGroups/ReadMe.md

@@ -0,0 +1,43 @@
+# Addition of Schema under Schema groups 
+
+With release of [Schema registry](https://docs.microsoft.com/en-us/azure/event-hubs/schema-registry-overview#what-is-azure-schema-registry) feature in Event Hubs, it becomes easier to store different kinds of schemas under schema groups and have seamless interaction between producer and consumer application. Since addition of schema under schema groups is a data plane operation ( not intended to hit management endpoint) hence, there is no publicly available PS Cmdlet to abstract this functionality. 
+
+This sample is meant to serve as reference code for adding schemas under schema groups using Bash. 
+
+# Prerequisites
+
+Please ensure that following steps are followed before following the sample code:
+
+1. Local machine with linux/mac OS or you could use Azure CloudShell via https://shell.azure.com    
+
+2. Create AD application for authentication,here are additional details: https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal 
+3. Please keep a note of Application ID, secret that you had created in last step ( you would be using this in PS sample)
+4. Assign the service principal Schema registry contributor role (To know more about how to assign a role: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current ), so that it could make changes to schema groups. Here is quick read about Schema registry contributor role and permissions it posseses : https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#schema-registry-contributor-preview 
+5. Finally, update the following placeholders in sample code with information associated to your environment:
+- Application_ID: Application ID of AD Application
+- Application_Secret: Secret value associated to Application
+- Tenant_Id: Tenant ID of Associated AD tenant
+- Namespace_Name: Name of Event Hubs namespace
+- SchemaGroup_Name: Name of schema groups under event hub namespace
+- Schema_Name: Name of schema to be added under Schema group
+
+# Script Overview
+
+This PS sample can be spliced into two REST calls that are being made. 
+
+1. Once we have the AD application details as talked above, we would make first API call to fetch the authorization token needed to successfully make schema addition call.
+2. After fetching and formatting the bearer token, we trigger another API call to add schema under schema groups. Once this code runs successfully, you should be able to find the newly added schema under schema groups on Azure Portal. 
+
+# Additional Reference:
+
+Here are some additional reference links that could be helpful: 
+
+- Schema Registry in Event Hubs - https://docs.microsoft.com/en-us/azure/event-hubs/schema-registry-overview 
+- Event hubs Overview- https://docs.microsoft.com/en-us/azure/event-hubs/ 
+
+# Conclusion
+
+We would love to hear about your feedback about this sample. We would be happy to see any pull requests if in case you are interested to contribute to our community.
+
+Stay tuned for future updates from Azure Messaging team. Happy scripting! 
+

samples/Management/PowerShell/AddingSchematoSchemagroups/Addingschematoschemagroup.ps1

@@ -0,0 +1,52 @@
+
+#Step 1 - Pass in AD Application details below to be able to fetch authorization token against legitimate Service Principal. 
+$Fields = @{
+    grant_type    = "client_credentials"
+    client_id     = "<Application_ID>"
+    resource      = "https://eventhubs.azure.net"
+    client_secret = "<Application_Secret>"
+  };
+
+  #update tenant ID to the correct tenant where you would like to get authorization token from
+  $response = Invoke-RestMethod –Uri "https://login.microsoftonline.com/<Tenant_ID>/oauth2/token" –ContentType "application/x-www-form-urlencoded" –Method POST –Body $Fields
+   
+  #response would have bearer token in the properties that we would use to trigger next call.
+  $token = $response.access_token
+ 
+  #Step 2- You can declare schema JSON associated to schema in $Body variable below
+  $Body = @"
+  {
+    "namespace": "com.azure.schemaregistry.samples",
+    "type": "record",
+    "name": "Order",
+    "fields": [
+        {
+            "name": "id",
+            "type": "string"
+        },
+        {
+            "name": "amount",
+            "type": "double"
+        }
+    ]
+}
+"@ 
+
+#Step 3- This Uri needs to have details added- namespace name, schema group name and schema name respectively.
+
+$NamespaceName      = '<namespacename>'
+$SchemaGroupName    = '<schemagroupname>'
+$SchemaName         = '<SchemaName>'
+
+
+$uri = "https://$NamespaceName.servicebus.windows.net/$schemagroups/$SchemaGroupName/schemas/$SchemaName`?api-version=2020-09-01-preview"
+
+#Step 4- These headers would be sent along with the API Call
+$headers = @{
+    "Content-Type" = "application/atom+xml;type=entry;charset=utf-8"
+    "Serialization-Type" = "Avro"
+    "Authorization" = "Bearer " + $token
+}
+
+#Step 5- This step shows the final call that we make to add schema under the schema groups, 
+Invoke-RestMethod -Method "PUT" -Uri $uri -Headers $headers -Body $Body  -ContentType "application/json"

samples/Management/PowerShell/AddingSchematoSchemagroups/ReadMe.md

@@ -0,0 +1,44 @@
+# Addition of Schema under Schema groups 
+
+With release of [Schema registry](https://docs.microsoft.com/en-us/azure/event-hubs/schema-registry-overview#what-is-azure-schema-registry) feature in Event Hubs, it becomes easier to store different kinds of schemas under schema groups and have seamless interaction between producer and consumer application. Since addition of schema under schema groups is a data plane operation ( not intended to hit management endpoint) hence, there is no publicly available PS Cmdlet to abstract this functionality. 
+
+This sample is meant to serve as reference code for adding schemas under schema groups using PowerShell. 
+
+# Prerequisites
+
+Please ensure that following steps are followed before following the sample code:
+
+1. Updated PS module in Windows machine or you could use Azure CloudShell via https://shell.azure.com    
+
+2. Create AD application for authentication,here are additional details: https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal 
+3. Please keep a note of Application ID, secret that you had created in last step ( you would be using this in PS sample)
+4. Assign the service principal Schema registry contributor role (To know more about how to assign a role: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current ), so that it could make changes to schema groups. Here is quick read about Schema registry contributor role and permissions it posseses : https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#schema-registry-contributor-preview 
+5. Finally, update the following placeholders in sample code with information associated to your environment:
+- Application_ID: Application ID of AD Application
+- Application_Secret: Secret value associated to Application
+- resource: needs to be set as "https://eventhubs.azure.net", since we are authenticating against data endpoint
+- Tenant_Id: Tenant ID of Associated AD tenant
+- Namespace_Name: Name of Event Hubs namespace
+- SchemaGroup_Name: Name of schema groups under event hub namespace
+- Schema_Name: Name of schema to be added under Schema group
+
+# Script Overview
+
+This PS sample can be spliced into two REST calls that are being made. 
+
+1. Once we have the AD application details as talked above, we would make first API call to fetch the authorization token needed to successfully make schema addition call.
+2. After fetching and formatting the bearer token, we trigger another API call to add schema under schema groups. Once this code runs successfully, you should be able to find the newly added schema under schema groups on Azure Portal. 
+
+# Additional Reference:
+
+Here are some additional reference links that could be helpful: 
+
+- Schema Registry in Event Hubs - https://docs.microsoft.com/en-us/azure/event-hubs/schema-registry-overview 
+- Event hubs Overview- https://docs.microsoft.com/en-us/azure/event-hubs/ 
+
+# Conclusion
+
+We would love to hear about your feedback about this sample. We would be happy to see any pull requests if in case you are interested to contribute to our community.
+
+Stay tuned for future updates from Azure Messaging team. Happy scripting! 
+