Namespaces - Patch

Referencia

Servicio:: Notification Hubs

Versión de la API:: 2017-04-01

Parches del espacio de nombres existente

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}?api-version=2017-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string	Nombre del espacio de nombres.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Obtiene las credenciales de suscripción que identifican de forma única la 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 api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
sku	Sku	SKU del espacio de nombres creado
tags	object	Etiquetas de recursos

Respuestas

Nombre	Tipo	Description
200 OK	NamespaceResource	El espacio de nombres se actualiza

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

NameSpaceUpdate

Solicitud de ejemplo

PATCH https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns?api-version=2017-04-01

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}


import com.azure.resourcemanager.notificationhubs.models.NamespaceResource;
import com.azure.resourcemanager.notificationhubs.models.Sku;
import com.azure.resourcemanager.notificationhubs.models.SkuName;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Namespaces Patch.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/
     * NHNameSpaceUpdate.json
     */
    /**
     * Sample code: NameSpaceUpdate.
     * 
     * @param manager Entry point to NotificationHubsManager.
     */
    public static void nameSpaceUpdate(com.azure.resourcemanager.notificationhubs.NotificationHubsManager manager) {
        NamespaceResource resource = manager.namespaces()
            .getByResourceGroupWithResponse("5ktrial", "nh-sdk-ns", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("tag1", "value1", "tag2", "value2"))
            .withSku(new Sku().withName(SkuName.STANDARD).withTier("Standard")).apply();
    }

    // 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.notificationhubs import NotificationHubsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-notificationhubs
# USAGE
    python name_space_update.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 = NotificationHubsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="29cfa613-cbbc-4512-b1d6-1b3a92c7fa40",
    )

    response = client.namespaces.patch(
        resource_group_name="5ktrial",
        namespace_name="nh-sdk-ns",
        parameters={"sku": {"name": "Standard", "tier": "Standard"}, "tags": {"tag1": "value1", "tag2": "value2"}},
    )
    print(response)


# x-ms-original-file: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceUpdate.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 armnotificationhubs_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/notificationhubs/armnotificationhubs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceUpdate.json
func ExampleNamespacesClient_Patch() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnotificationhubs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().Patch(ctx, "5ktrial", "nh-sdk-ns", armnotificationhubs.NamespacePatchParameters{
		SKU: &armnotificationhubs.SKU{
			Name: to.Ptr(armnotificationhubs.SKUNameStandard),
			Tier: to.Ptr("Standard"),
		},
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
	}, 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.NamespaceResource = armnotificationhubs.NamespaceResource{
	// 	Name: to.Ptr("sdk-Namespace-3285"),
	// 	Type: to.Ptr("Microsoft.NotificationHubs/Namespaces"),
	// 	ID: to.Ptr("/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-3285"),
	// 	Location: to.Ptr("South Central US"),
	// 	SKU: &armnotificationhubs.SKU{
	// 		Name: to.Ptr(armnotificationhubs.SKUNameStandard),
	// 		Tier: to.Ptr("Standard"),
	// 	},
	// 	Tags: map[string]*string{
	// 		"tag3": to.Ptr("value3"),
	// 		"tag4": to.Ptr("value4"),
	// 	},
	// 	Properties: &armnotificationhubs.NamespaceProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-25T23:07:58.170Z"); return t}()),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ServiceBusEndpoint: to.Ptr("https://sdk-Namespace-3285.servicebus.windows-int.net:443/"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Patches the existing namespace
 *
 * @summary Patches the existing namespace
 * x-ms-original-file: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceUpdate.json
 */
async function nameSpaceUpdate() {
  const subscriptionId = "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40";
  const resourceGroupName = "5ktrial";
  const namespaceName = "nh-sdk-ns";
  const parameters = {
    sku: { name: "Standard", tier: "Standard" },
    tags: { tag1: "value1", tag2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NotificationHubsManagementClient(credential, subscriptionId);
  const result = await client.namespaces.patch(resourceGroupName, namespaceName, parameters);
  console.log(result);
}

nameSpaceUpdate().catch(console.error);

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.NotificationHubs;
using Azure.ResourceManager.NotificationHubs.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceUpdate.json
// this example is just showing the usage of "Namespaces_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 NotificationHubNamespaceResource created on azure
// for more information of creating NotificationHubNamespaceResource, please refer to the document of NotificationHubNamespaceResource
string subscriptionId = "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40";
string resourceGroupName = "5ktrial";
string namespaceName = "nh-sdk-ns";
ResourceIdentifier notificationHubNamespaceResourceId = NotificationHubNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
NotificationHubNamespaceResource notificationHubNamespace = client.GetNotificationHubNamespaceResource(notificationHubNamespaceResourceId);

// invoke the operation
NotificationHubNamespacePatch patch = new NotificationHubNamespacePatch()
{
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
    Sku = new NotificationHubSku(NotificationHubSkuName.Standard)
    {
        Tier = "Standard",
    },
};
NotificationHubNamespaceResource result = await notificationHubNamespace.UpdateAsync(patch);

// 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
NotificationHubNamespaceData 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

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-3285",
  "name": "sdk-Namespace-3285",
  "type": "Microsoft.NotificationHubs/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag3": "value3",
    "tag4": "value4"
  },
  "properties": {
    "provisioningState": "Updating",
    "createdAt": "2017-05-25T23:07:58.17Z",
    "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/"
  }
}

Definiciones

Nombre	Description
NamespacePatchParameters	Parámetros proporcionados a la operación Patch Namespace.
NamespaceResource	Descripción de un recurso de espacio de nombres.
NamespaceType	Tipo de espacio de nombres.
Sku	Descripción de la SKU de un espacio de nombres
SkuName	Nombre de la SKU del centro de notificaciones

NamespacePatchParameters

Object

Parámetros proporcionados a la operación Patch Namespace.

Nombre	Tipo	Description
sku	Sku	SKU del espacio de nombres creado
tags	object	Etiquetas de recursos

NamespaceResource

Object

Descripción de un recurso de espacio de nombres.

Nombre	Tipo	Description
id	string	Identificador de recurso
location	string	Ubicación del recurso
name	string	Nombre del recurso
properties.createdAt	string (date-time)	Hora en que se creó el espacio de nombres.
properties.critical	boolean	Indica si el espacio de nombres se establece como Crítico.
properties.dataCenter	string	Centro de datos para el espacio de nombres
properties.enabled	boolean	Indica si el espacio de nombres está habilitado actualmente.
properties.metricId	string	Identificador de las métricas de Azure Insights
properties.name	string	Nombre del espacio de nombres.
properties.namespaceType	NamespaceType	Tipo de espacio de nombres.
properties.provisioningState	string	Estado de aprovisionamiento del espacio de nombres.
properties.region	string	Especifica la región de destino en la que se debe crear el espacio de nombres. Puede ser cualquiera de los siguientes valores: Este de Australia, Sudeste de Australia, Centro de EE. UU., Este de EE. UU. 2, Oeste de EE. UU., Centro-norte de EE. UU., Centro-sur de EE. UU., Este de Asia, Sudeste de Asia, Sur de Brasil, Este de Japón, Oeste de Japón, Norte de Europa, Oeste de Europa
properties.scaleUnit	string	ScaleUnit donde se crea el espacio de nombres
properties.serviceBusEndpoint	string	Punto de conexión que puede usar para realizar operaciones de NotificationHub.
properties.status	string	Estado del espacio de nombres. Puede ser cualquiera de estos valores:1 = Created/Active2 = Creating3 = Suspended4 = Eliminar
properties.subscriptionId	string	Identificador de la suscripción de Azure asociada al espacio de nombres.
properties.updatedAt	string (date-time)	Hora en que se actualizó el espacio de nombres.
sku	Sku	SKU del espacio de nombres creado
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

NamespaceType

Enumeración

Tipo de espacio de nombres.

Valor	Description
Messaging
NotificationHub

Sku

Object

Descripción de la SKU de un espacio de nombres

Nombre	Tipo	Description
capacity	integer	Capacidad del recurso
family	string	La familia de SKU
name	SkuName	Nombre de la SKU del centro de notificaciones
size	string	Tamaño de SKU
tier	string	Nivel de SKU concreto

SkuName

Enumeración

Nombre de la SKU del centro de notificaciones

Valor	Description
Basic
Free
Standard