Configuration - Patch

Dienst:: Event Hubs

API-Version:: 2024-01-01

Ersetzen Sie alle angegebenen Event Hubs Cluster-Einstellungen durch diejenigen, die im Anforderungstext enthalten sind. Lässt die Im Anforderungstext nicht angegebenen Einstellungen unverändert.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default?api-version=2024-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string minLength: 6 maxLength: 50	Der Name des Event Hubs-Clusters.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Name der Ressourcengruppe innerhalb des Azure-Abonnements.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
settings	object	Alle möglichen Clustereinstellungen – eine Sammlung von Schlüssel-Wert-Paareinstellungen, die für Kontingente und Konfigurationen gelten, die dem Cluster auferlegt werden.

Antworten

Name	Typ	Beschreibung
200 OK	ClusterQuotaConfigurationProperties	Die Konfiguration der Event Hubs-Clustereinstellungen wurde zurückgegeben.
201 Created	ClusterQuotaConfigurationProperties	Konfigurationsanforderung für Event Hubs-Clustereinstellungen wurde erfolgreich akzeptiert.
202 Accepted		Event Hubs Cluster-Updateanforderung akzeptiert.
Other Status Codes	ErrorResponse	Ereignishubs Cluster-Fehlerantwort, die beschreibt, warum der Vorgang zum Abrufen von Clusterkontingenten und -einstellungen fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ClustersQuotasConfigurationPatch

Beispielanforderung

PATCH https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/clusters/testCluster/quotaConfiguration/default?api-version=2024-01-01

{
  "settings": {
    "namespaces-per-cluster-quota": "200",
    "eventhub-per-namespace-quota": "20"
  }
}


import com.azure.resourcemanager.eventhubs.fluent.models.ClusterQuotaConfigurationPropertiesInner;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Configuration Patch.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/Clusters/
     * ClusterQuotaConfigurationPatch.json
     */
    /**
     * Sample code: ClustersQuotasConfigurationPatch.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void clustersQuotasConfigurationPatch(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.eventHubs().manager().serviceClient().getConfigurations().patchWithResponse("ArunMonocle", "testCluster",
            new ClusterQuotaConfigurationPropertiesInner()
                .withSettings(mapOf("eventhub-per-namespace-quota", "20", "namespaces-per-cluster-quota", "200")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventhub import EventHubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventhub
# USAGE
    python cluster_quota_configuration_patch.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="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.configuration.patch(
        resource_group_name="ArunMonocle",
        cluster_name="testCluster",
        parameters={"settings": {"eventhub-per-namespace-quota": "20", "namespaces-per-cluster-quota": "200"}},
    )
    print(response)


# x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/Clusters/ClusterQuotaConfigurationPatch.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

package armeventhub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/Clusters/ClusterQuotaConfigurationPatch.json
func ExampleConfigurationClient_Patch() {
	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.NewConfigurationClient().Patch(ctx, "ArunMonocle", "testCluster", armeventhub.ClusterQuotaConfigurationProperties{
		Settings: map[string]*string{
			"eventhub-per-namespace-quota": to.Ptr("20"),
			"namespaces-per-cluster-quota": to.Ptr("200"),
		},
	}, 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.ClusterQuotaConfigurationProperties = armeventhub.ClusterQuotaConfigurationProperties{
	// 	Settings: map[string]*string{
	// 		"eventhub-per-namespace-quota": to.Ptr("20"),
	// 		"namespaces-per-cluster-quota": to.Ptr("200"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
 *
 * @summary Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
 * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/Clusters/ClusterQuotaConfigurationPatch.json
 */
async function clustersQuotasConfigurationPatch() {
  const subscriptionId =
    process.env["EVENTHUB_SUBSCRIPTION_ID"] || "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = process.env["EVENTHUB_RESOURCE_GROUP"] || "ArunMonocle";
  const clusterName = "testCluster";
  const parameters = {
    settings: {
      eventhubPerNamespaceQuota: "20",
      namespacesPerClusterQuota: "200",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const result = await client.configuration.patch(resourceGroupName, clusterName, parameters);
  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

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.Resources.Models;
using Azure.ResourceManager.EventHubs;

// Generated from example definition: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/Clusters/ClusterQuotaConfigurationPatch.json
// this example is just showing the usage of "Configuration_Patch" 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 EventHubsClusterResource created on azure
// for more information of creating EventHubsClusterResource, please refer to the document of EventHubsClusterResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string clusterName = "testCluster";
ResourceIdentifier eventHubsClusterResourceId = EventHubsClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
EventHubsClusterResource eventHubsCluster = client.GetEventHubsClusterResource(eventHubsClusterResourceId);

// invoke the operation
ClusterQuotaConfigurationProperties clusterQuotaConfigurationProperties = new ClusterQuotaConfigurationProperties
{
    Settings =
    {
    ["eventhub-per-namespace-quota"] = "20",
    ["namespaces-per-cluster-quota"] = "200"
    },
};
ClusterQuotaConfigurationProperties result = await eventHubsCluster.PatchConfigurationAsync(clusterQuotaConfigurationProperties);

Console.WriteLine($"Succeeded: {result}");

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "settings": {
    "namespaces-per-cluster-quota": "200",
    "eventhub-per-namespace-quota": "20"
  }
}

Statuscode:: 201

{
  "settings": {
    "namespaces-per-cluster-quota": "200",
    "eventhub-per-namespace-quota": "20"
  }
}

Statuscode:: 202

Definitionen

Name	Beschreibung
ClusterQuotaConfigurationProperties	Enthält alle Einstellungen für den Cluster.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

ClusterQuotaConfigurationProperties

Objekt

Enthält alle Einstellungen für den Cluster.

Name	Typ	Beschreibung
settings	object	Alle möglichen Clustereinstellungen – eine Sammlung von Schlüssel-Wert-Paareinstellungen, die für Kontingente und Konfigurationen gelten, die dem Cluster auferlegt werden.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.