Schema Registry - Get

Servicio:

Event Hubs

Versión de la API:

2024-01-01

Obtiene los detalles de un grupo de esquemas de EventHub.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}?api-version=2024-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	Nombre del espacio de nombres
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos dentro de la suscripción de Azure.
schemaGroupName	path	True	string minLength: 1 maxLength: 256	Nombre del grupo de esquemas
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	SchemaGroup	Se recuperó correctamente la descripción del grupo de esquemas.
Other Status Codes	ErrorResponse	Respuesta de error del centro de eventos que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SchemaRegistryGet

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/e8baea74-64ce-459b-bee3-5aa4c47b3ae3/resourceGroups/alitest/providers/Microsoft.EventHub/namespaces/ali-ua-test-eh-system-1/schemagroups/testSchemaGroup1?api-version=2024-01-01

Java

/**
 * Samples for SchemaRegistry Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/SchemaRegistry/
     * SchemaRegistryGet.json
     */
    /**
     * Sample code: SchemaRegistryGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void schemaRegistryGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.eventHubs().manager().serviceClient().getSchemaRegistries().getWithResponse("alitest",
            "ali-ua-test-eh-system-1", "testSchemaGroup1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventhub import EventHubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventhub
# USAGE
    python schema_registry_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventHubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e8baea74-64ce-459b-bee3-5aa4c47b3ae3",
    )

    response = client.schema_registry.get(
        resource_group_name="alitest",
        namespace_name="ali-ua-test-eh-system-1",
        schema_group_name="testSchemaGroup1",
    )
    print(response)


# x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/SchemaRegistry/SchemaRegistryGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeventhub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b574e2a41acda14a90ef237006e8bbdda2b63c63/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/SchemaRegistry/SchemaRegistryGet.json
func ExampleSchemaRegistryClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSchemaRegistryClient().Get(ctx, "alitest", "ali-ua-test-eh-system-1", "testSchemaGroup1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SchemaGroup = armeventhub.SchemaGroup{
	// 	Name: to.Ptr("testSchemaGroup1"),
	// 	Type: to.Ptr("Microsoft.EventHub/Namespaces/SchemaGroups"),
	// 	ID: to.Ptr("/subscriptions/e8baea74-64ce-459b-bee3-5aa4c47b3ae3/resourceGroups/alitest/providers/Microsoft.EventHub/namespaces/ali-ua-test-eh-system-1/schemagroups/testSchemaGroup1"),
	// 	Location: to.Ptr("EAST US 2 EUAP"),
	// 	Properties: &armeventhub.SchemaGroupProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-13T03:08:11.167Z"); return t}()),
	// 		ETag: to.Ptr("51ddcff4-a287-423c-b194-7a8ebbfd8366"),
	// 		GroupProperties: map[string]*string{
	// 		},
	// 		SchemaCompatibility: to.Ptr(armeventhub.SchemaCompatibilityForward),
	// 		SchemaType: to.Ptr(armeventhub.SchemaTypeAvro),
	// 		UpdatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-13T03:08:11.167Z"); return t}()),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EventHubManagementClient } = require("@azure/arm-eventhub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the details of an EventHub schema group.
 *
 * @summary Gets the details of an EventHub schema group.
 * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/SchemaRegistry/SchemaRegistryGet.json
 */
async function schemaRegistryGet() {
  const subscriptionId =
    process.env["EVENTHUB_SUBSCRIPTION_ID"] || "e8baea74-64ce-459b-bee3-5aa4c47b3ae3";
  const resourceGroupName = process.env["EVENTHUB_RESOURCE_GROUP"] || "alitest";
  const namespaceName = "ali-ua-test-eh-system-1";
  const schemaGroupName = "testSchemaGroup1";
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const result = await client.schemaRegistry.get(resourceGroupName, namespaceName, schemaGroupName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventHubs.Models;
using Azure.ResourceManager.EventHubs;

// Generated from example definition: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/SchemaRegistry/SchemaRegistryGet.json
// this example is just showing the usage of "SchemaRegistry_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this EventHubsNamespaceResource created on azure
// for more information of creating EventHubsNamespaceResource, please refer to the document of EventHubsNamespaceResource
string subscriptionId = "e8baea74-64ce-459b-bee3-5aa4c47b3ae3";
string resourceGroupName = "alitest";
string namespaceName = "ali-ua-test-eh-system-1";
ResourceIdentifier eventHubsNamespaceResourceId = EventHubsNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
EventHubsNamespaceResource eventHubsNamespace = client.GetEventHubsNamespaceResource(eventHubsNamespaceResourceId);

// get the collection of this EventHubsSchemaGroupResource
EventHubsSchemaGroupCollection collection = eventHubsNamespace.GetEventHubsSchemaGroups();

// invoke the operation
string schemaGroupName = "testSchemaGroup1";
NullableResponse<EventHubsSchemaGroupResource> response = await collection.GetIfExistsAsync(schemaGroupName);
EventHubsSchemaGroupResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EventHubsSchemaGroupData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/e8baea74-64ce-459b-bee3-5aa4c47b3ae3/resourceGroups/alitest/providers/Microsoft.EventHub/namespaces/ali-ua-test-eh-system-1/schemagroups/testSchemaGroup1",
  "name": "testSchemaGroup1",
  "type": "Microsoft.EventHub/Namespaces/SchemaGroups",
  "location": "EAST US 2 EUAP",
  "properties": {
    "updatedAtUtc": "2021-10-13T03:08:11.1671879Z",
    "createdAtUtc": "2021-10-13T03:08:11.1671879Z",
    "eTag": "51ddcff4-a287-423c-b194-7a8ebbfd8366",
    "groupProperties": {},
    "schemaCompatibility": "Forward",
    "schemaType": "Avro"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	La respuesta de error indica que el servicio Event Hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
SchemaCompatibility
SchemaGroup	Elemento único en la operación Lista o Obtener grupo de esquemas
SchemaType
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

La respuesta de error indica que el servicio Event Hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SchemaCompatibility

Enumeración

Valor	Description
Backward
Forward
None

SchemaGroup

Object

Elemento único en la operación Lista o Obtener grupo de esquemas

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.createdAtUtc	string (date-time)	Hora exacta en que se creó el grupo de esquemas.
properties.eTag	string (uuid)	Valor de ETag.
properties.groupProperties	object	objeto dictionary para las propiedades del grupo SchemaGroup
properties.schemaCompatibility	SchemaCompatibility
properties.schemaType	SchemaType
properties.updatedAtUtc	string (date-time)	Hora exacta en que se actualizó el grupo de esquemas
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

SchemaType

Enumeración

Valor	Description
Avro
Unknown

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.