Rules - List By Subscriptions

Service:: Service Bus

Version d'API:: 2024-01-01

Répertorier toutes les règles dans un abonnement à une rubrique donnée

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Nom de l’espace de noms
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
subscriptionName	path	True	string minLength: 1 maxLength: 50	Nom de l’abonnement.
topicName	path	True	string minLength: 1	Nom de la rubrique.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$skip	query		integer minimum: 0 maximum: 1000	Ignorer n’est utilisé que si une opération précédente a retourné un résultat partiel. Si une réponse précédente contient un élément nextLink, la valeur de l’élément nextLink inclut un paramètre skip qui spécifie un point de départ à utiliser pour les appels suivants.
$top	query		integer minimum: 1 maximum: 1000	Peut être utilisé pour limiter le nombre de résultats aux N usageDetails les plus récents.

Réponses

Nom	Type	Description
200 OK	RuleListResult	Liste des règles récupérées avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur ServiceBus décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

RulesListBySubscriptions

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules?api-version=2024-01-01

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571",
      "name": "sdk-Rules-6571",
      "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules",
      "properties": {
        "action": {},
        "filterType": "SqlFilter",
        "sqlFilter": {
          "sqlExpression": "1=1",
          "compatibilityLevel": 20
        }
      }
    }
  ]
}

Définitions

Nom	Description
Action	Représente les actions de filtre autorisées pour la transformation d’un message qui ont été mis en correspondance par une expression de filtre.
CorrelationFilter	Représente l’expression de filtre de corrélation.
createdByType	Type d’identité qui a créé la ressource.
Error	Objet d’erreur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur de gestion des ressources.
FilterType	Types de filtres de règles
Rule	Description de la ressource de règle.
RuleListResult	Réponse de l’opération de règle de liste.
SqlFilter	Représente un filtre qui est une composition d’une expression et une action exécutée dans le pipeline pub/sub.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

Action

Object

Représente les actions de filtre autorisées pour la transformation d’un message qui ont été mis en correspondance par une expression de filtre.

Nom	Type	Valeur par défaut	Description
compatibilityLevel	integer (int32)		Cette propriété est réservée à une utilisation ultérieure. Valeur entière montrant le niveau de compatibilité, actuellement codé en dur à 20.
requiresPreprocessing	boolean	True	Valeur qui indique si l’action de règle nécessite un prétraitement.
sqlExpression	string		Expression SQL. Par exemple, MyProperty='ABC'

CorrelationFilter

Object

Représente l’expression de filtre de corrélation.

Nom	Type	Valeur par défaut	Description
contentType	string		Type de contenu du message.
correlationId	string		Identificateur de la corrélation.
label	string		Étiquette spécifique à l’application.
messageId	string		Identificateur du message.
properties	object		objet dictionnaire pour les filtres personnalisés
replyTo	string		Adresse de la file d’attente à laquelle répondre.
replyToSessionId	string		Identificateur de session auquel répondre.
requiresPreprocessing	boolean	True	Valeur qui indique si l’action de règle nécessite un prétraitement.
sessionId	string		Identificateur de session.
to	string		Adresse à envoyer.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

Error

Object

Objet d’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorResponse

Object

Réponse d’erreur de gestion des ressources.

Nom	Type	Description
error	Error	Objet d’erreur.

FilterType

Énumération

Types de filtres de règles

Valeur	Description
SqlFilter
CorrelationFilter

Rule

Object

Description de la ressource de règle.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.action	Action	Représente les actions de filtre autorisées pour la transformation d’un message qui ont été mis en correspondance par une expression de filtre.
properties.correlationFilter	CorrelationFilter	Propriétés de correlationFilter
properties.filterType	FilterType	Type de filtre évalué par rapport à un brokeredMessage.
properties.sqlFilter	SqlFilter	Propriétés de sqlFilter
systemData	systemData	Métadonnées système relatives à cette ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs »

RuleListResult

Object

Réponse de l’opération de règle de liste.

Nom	Type	Description
nextLink	string	Lien vers l’ensemble de résultats suivant. Non vide si La valeur contient une liste incomplète de règles
value	Rule[]	Résultat de l’opération Règles de liste.

SqlFilter

Object

Représente un filtre qui est une composition d’une expression et une action exécutée dans le pipeline pub/sub.

Nom	Type	Valeur par défaut	Description
compatibilityLevel	integer (int32)		Cette propriété est réservée à une utilisation ultérieure. Valeur entière montrant le niveau de compatibilité, actuellement codé en dur à 20.
requiresPreprocessing	boolean	True	Valeur qui indique si l’action de règle nécessite un prétraitement.
sqlExpression	string		Expression SQL. Par exemple, MyProperty='ABC'

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Type d’identité qui a modifié la ressource pour la dernière fois.
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Rules - List By Subscriptions

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

RulesListBySubscriptions

Exemple de requête

Exemple de réponse

Définitions

Action

CorrelationFilter

createdByType

Error

ErrorAdditionalInfo

ErrorResponse

FilterType

Rule

RuleListResult

SqlFilter

systemData