Subscriptions - Create Or Update

Referencia

Servicio:: Service Bus

Versión de la API:: 2024-01-01

Crea una suscripción de tema.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}?api-version=2024-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Nombre del espacio de nombres
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
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.
subscriptionName	path	True	string minLength: 1 maxLength: 50	Nombre de la suscripción.
topicName	path	True	string minLength: 1	Nombre del tema.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.autoDeleteOnIdle	string (duration)	Intervalo de inactividad de timeSpan iso 8061 después del cual el tema se elimina automáticamente. La duración mínima es de 5 minutos.
properties.clientAffineProperties	SBClientAffineProperties	Propiedades específicas de las suscripciones de cliente affine.
properties.deadLetteringOnFilterEvaluationExceptions	boolean	Valor que indica si una suscripción tiene compatibilidad con mensajes fallidos en las excepciones de evaluación de filtros.
properties.deadLetteringOnMessageExpiration	boolean	Valor que indica si una suscripción tiene compatibilidad con mensajes fallidos cuando expira un mensaje.
properties.defaultMessageTimeToLive	string (duration)	El intervalo de tiempo de vida predeterminado del mensaje ISO 8061. Esta es la duración después de la cual expira el mensaje, a partir de cuándo se envía el mensaje a Service Bus. Este es el valor predeterminado que se usa cuando TimeToLive no está establecido en un mensaje en sí.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Estructura timeSpan iso 8601 que define la duración del historial de detección de duplicados. El valor predeterminado es 10 minutos.
properties.enableBatchedOperations	boolean	Valor que indica si las operaciones por lotes del lado servidor están habilitadas.
properties.forwardDeadLetteredMessagesTo	string	Nombre de la cola o tema para reenviar el mensaje de mensajes fallidos
properties.forwardTo	string	Nombre de cola o tema para reenviar los mensajes
properties.isClientAffine	boolean	Valor que indica si la suscripción tiene una afinidad con el identificador de cliente.
properties.lockDuration	string (duration)	Intervalo de tiempo de duración de bloqueo ISO 8061 para la suscripción. El valor predeterminado es 1 minuto.
properties.maxDeliveryCount	integer (int32)	Número de entregas máximas.
properties.requiresSession	boolean	Valor que indica si una suscripción admite el concepto de sesiones.
properties.status	EntityStatus	Enumera los valores posibles para el estado de una entidad de mensajería.

Respuestas

Nombre	Tipo	Description
200 OK	SBSubscription	Solicitud de creación de suscripciones aceptada.
Other Status Codes	ErrorResponse	Respuesta de error de ServiceBus 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

SubscriptionCreate

PUT https://management.azure.com/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178?api-version=2024-01-01

{
  "properties": {
    "enableBatchedOperations": true
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/Subscriptions/SBSubscriptionCreate.json
// this example is just showing the usage of "Subscriptions_CreateOrUpdate" 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 ServiceBusTopicResource created on azure
// for more information of creating ServiceBusTopicResource, please refer to the document of ServiceBusTopicResource
string subscriptionId = "Subscriptionid";
string resourceGroupName = "ResourceGroup";
string namespaceName = "sdk-Namespace-1349";
string topicName = "sdk-Topics-8740";
ResourceIdentifier serviceBusTopicResourceId = ServiceBusTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, topicName);
ServiceBusTopicResource serviceBusTopic = client.GetServiceBusTopicResource(serviceBusTopicResourceId);

// get the collection of this ServiceBusSubscriptionResource
ServiceBusSubscriptionCollection collection = serviceBusTopic.GetServiceBusSubscriptions();

// invoke the operation
string subscriptionName = "sdk-Subscriptions-2178";
ServiceBusSubscriptionData data = new ServiceBusSubscriptionData
{
    EnableBatchedOperations = true,
};
ArmOperation<ServiceBusSubscriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, subscriptionName, data);
ServiceBusSubscriptionResource result = lro.Value;

// 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
ServiceBusSubscriptionData 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/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178",
  "name": "sdk-Subscriptions-2178",
  "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions",
  "properties": {
    "lockDuration": "PT1M",
    "requiresSession": false,
    "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S",
    "deadLetteringOnMessageExpiration": true,
    "deadLetteringOnFilterEvaluationExceptions": true,
    "messageCount": 0,
    "maxDeliveryCount": 10,
    "status": "Active",
    "enableBatchedOperations": true,
    "createdAt": "2021-01-04T18:02:20.5992764Z",
    "updatedAt": "2021-01-04T18:02:20.5992764Z",
    "accessedAt": "2021-01-04T18:02:20.5992764Z",
    "countDetails": {
      "activeMessageCount": 0,
      "deadLetterMessageCount": 0,
      "scheduledMessageCount": 0,
      "transferMessageCount": 0,
      "transferDeadLetterMessageCount": 0
    },
    "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
    "forwardTo": "sdk-Topics-3065",
    "forwardDeadLetteredMessagesTo": "sdk-Topics-3065"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
EntityStatus	Estado de la entidad.
Error	Objeto de error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error de administración de recursos.
MessageCountDetails	Detalles del recuento de mensajes.
SBClientAffineProperties	Propiedades específicas de las suscripciones de cliente affine.
SBSubscription	Descripción del recurso de suscripción.
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

EntityStatus

Enumeración

Estado de la entidad.

Valor	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

Objeto de error.

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

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.

ErrorResponse

Object

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.

MessageCountDetails

Object

Detalles del recuento de mensajes.

Nombre	Tipo	Description
activeMessageCount	integer (int64)	Número de mensajes activos en la cola, el tema o la suscripción.
deadLetterMessageCount	integer (int64)	Número de mensajes fallidos.
scheduledMessageCount	integer (int64)	Número de mensajes programados.
transferDeadLetterMessageCount	integer (int64)	Número de mensajes transferidos a mensajes fallidos.
transferMessageCount	integer (int64)	Número de mensajes transferidos a otra cola, tema o suscripción.

SBClientAffineProperties

Object

Propiedades específicas de las suscripciones de cliente affine.

Nombre	Tipo	Description
clientId	string	Indica el identificador de cliente de la aplicación que creó la suscripción de cliente affine.
isDurable	boolean	En el caso de las suscripciones de cliente affine, este valor indica si la suscripción es duradera o no.
isShared	boolean	En el caso de las suscripciones de cliente affine, este valor indica si la suscripción se comparte o no.

SBSubscription

Object

Descripción del recurso de suscripción.

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.accessedAt	string (date-time)	La última vez que se ha producido una solicitud de recepción a esta suscripción.
properties.autoDeleteOnIdle	string (duration)	Intervalo de inactividad de timeSpan iso 8061 después del cual el tema se elimina automáticamente. La duración mínima es de 5 minutos.
properties.clientAffineProperties	SBClientAffineProperties	Propiedades específicas de las suscripciones de cliente affine.
properties.countDetails	MessageCountDetails	Detalles del recuento de mensajes
properties.createdAt	string (date-time)	Hora exacta en que se creó el mensaje.
properties.deadLetteringOnFilterEvaluationExceptions	boolean	Valor que indica si una suscripción tiene compatibilidad con mensajes fallidos en las excepciones de evaluación de filtros.
properties.deadLetteringOnMessageExpiration	boolean	Valor que indica si una suscripción tiene compatibilidad con mensajes fallidos cuando expira un mensaje.
properties.defaultMessageTimeToLive	string (duration)	El intervalo de tiempo de vida predeterminado del mensaje ISO 8061. Esta es la duración después de la cual expira el mensaje, a partir de cuándo se envía el mensaje a Service Bus. Este es el valor predeterminado que se usa cuando TimeToLive no está establecido en un mensaje en sí.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Estructura timeSpan iso 8601 que define la duración del historial de detección de duplicados. El valor predeterminado es 10 minutos.
properties.enableBatchedOperations	boolean	Valor que indica si las operaciones por lotes del lado servidor están habilitadas.
properties.forwardDeadLetteredMessagesTo	string	Nombre de la cola o tema para reenviar el mensaje de mensajes fallidos
properties.forwardTo	string	Nombre de cola o tema para reenviar los mensajes
properties.isClientAffine	boolean	Valor que indica si la suscripción tiene una afinidad con el identificador de cliente.
properties.lockDuration	string (duration)	Intervalo de tiempo de duración de bloqueo ISO 8061 para la suscripción. El valor predeterminado es 1 minuto.
properties.maxDeliveryCount	integer (int32)	Número de entregas máximas.
properties.messageCount	integer (int64)	Número de mensajes.
properties.requiresSession	boolean	Valor que indica si una suscripción admite el concepto de sesiones.
properties.status	EntityStatus	Enumera los valores posibles para el estado de una entidad de mensajería.
properties.updatedAt	string (date-time)	Hora exacta en que se actualizó el mensaje.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

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.

Compartir a través de

Subscriptions - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

SubscriptionCreate

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBClientAffineProperties

SBSubscription

systemData