Rules - List By Subscriptions

Szolgáltatás:

Service Bus

API-verzió:

2024-01-01

Az adott témakör-előfizetés összes szabályának listázása

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

Opcionális paraméterekkel:

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}

URI-paraméterek

Name	In	Kötelező	Típus	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	A névtér neve
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
subscriptionName	path	True	string minLength: 1 maxLength: 50	Az előfizetés neve.
topicName	path	True	string minLength: 1	A témakör neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.
$skip	query		integer minimum: 0 maximum: 1000	A kihagyás csak akkor használatos, ha egy korábbi művelet részleges eredményt adott vissza. Ha egy előző válasz tartalmaz nextLink elemet, a nextLink elem értéke tartalmaz egy kihagyási paramétert, amely meghatározza a későbbi hívásokhoz használandó kiindulási pontot.
$top	query		integer minimum: 1 maximum: 1000	Az eredmények számát a legutóbbi N usageDetails értékre korlátozhatja.

Válaszok

Name	Típus	Description
200 OK	RuleListResult	Sikeresen lekérte a szabályok listáját.
Other Status Codes	ErrorResponse	ServiceBus-hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

RulesListBySubscriptions

Mintakérelem

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

dotnet

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

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/Rules/RuleListBySubscription.json
// this example is just showing the usage of "Rules_ListBySubscriptions" 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 ServiceBusSubscriptionResource created on azure
// for more information of creating ServiceBusSubscriptionResource, please refer to the document of ServiceBusSubscriptionResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-1319";
string topicName = "sdk-Topics-2081";
string subscriptionName = "sdk-Subscriptions-8691";
ResourceIdentifier serviceBusSubscriptionResourceId = ServiceBusSubscriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, topicName, subscriptionName);
ServiceBusSubscriptionResource serviceBusSubscription = client.GetServiceBusSubscriptionResource(serviceBusSubscriptionResourceId);

// get the collection of this ServiceBusRuleResource
ServiceBusRuleCollection collection = serviceBusSubscription.GetServiceBusRules();

// invoke the operation and iterate over the result
await foreach (ServiceBusRuleResource item in collection.GetAllAsync())
{
    // the variable item 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
    ServiceBusRuleData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Mintaválasz

Állapotkód:

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
        }
      }
    }
  ]
}

Definíciók

Name	Description
Action	A szűrőkifejezéssel egyeztetett üzenetek átalakításához engedélyezett szűrőműveleteket jelöli.
CorrelationFilter	A korrelációs szűrőkifejezést jelöli.
createdByType	Az erőforrást létrehozó identitás típusa.
Error	A hibaobjektum.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Az erőforrás-kezelési hibaválasz.
FilterType	Szabályszűrő-típusok
Rule	A szabályerőforrás leírása.
RuleListResult	A Listaszabály művelet válasza.
SqlFilter	Olyan szűrőt jelöl, amely egy kifejezés és egy, a pubban/alfolyamatban végrehajtott művelet összetétele.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Action

Objektum

A szűrőkifejezéssel egyeztetett üzenetek átalakításához engedélyezett szűrőműveleteket jelöli.

Name	Típus	Alapértelmezett érték	Description
compatibilityLevel	integer (int32)		Ez a tulajdonság későbbi használatra van fenntartva. A kompatibilitási szintet mutató egész szám, amely jelenleg 20-ra van kódolva.
requiresPreprocessing	boolean	True	Az az érték, amely jelzi, hogy a szabályművelet előfeldolgozást igényel-e.
sqlExpression	string		SQL-kifejezés. Pl. MyProperty='ABC'

CorrelationFilter

Objektum

A korrelációs szűrőkifejezést jelöli.

Name	Típus	Alapértelmezett érték	Description
contentType	string		Az üzenet tartalomtípusa.
correlationId	string		A korreláció azonosítója.
label	string		Alkalmazásspecifikus címke.
messageId	string		Az üzenet azonosítója.
properties	object		szótárobjektum egyéni szűrőkhöz
replyTo	string		Annak az üzenetsornak a címe, amelyre válaszolni szeretne.
replyToSessionId	string		Válaszolandó munkamenet-azonosító.
requiresPreprocessing	boolean	True	Az az érték, amely jelzi, hogy a szabályművelet előfeldolgozást igényel-e.
sessionId	string		Munkamenet-azonosító.
to	string		A címzett címe.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

Error

Objektum

A hibaobjektum.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Objektum

Az erőforrás-kezelési hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

FilterType

Enumerálás

Szabályszűrő-típusok

Érték	Description
CorrelationFilter
SqlFilter

Rule

Objektum

A szabályerőforrás leírása.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.action	Action	A szűrőkifejezéssel egyeztetett üzenetek átalakításához engedélyezett szűrőműveleteket jelöli.
properties.correlationFilter	CorrelationFilter	A korrelációs szűrő tulajdonságai
properties.filterType	FilterType	A BrokeredMessage alapján kiértékelt szűrőtípus.
properties.sqlFilter	SqlFilter	Az sqlFilter tulajdonságai
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa. Pl. "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

RuleListResult

Objektum

A Listaszabály művelet válasza.

Name	Típus	Description
nextLink	string	A következő találatkészletre mutató hivatkozás. Nem üres, ha az Érték hiányos szabálylistát tartalmaz
value	Rule[]	A Listaszabályok művelet eredménye.

SqlFilter

Objektum

Olyan szűrőt jelöl, amely egy kifejezés és egy, a pubban/alfolyamatban végrehajtott művelet összetétele.

Name	Típus	Alapértelmezett érték	Description
compatibilityLevel	integer (int32)		Ez a tulajdonság későbbi használatra van fenntartva. A kompatibilitási szintet mutató egész szám, amely jelenleg 20-ra van kódolva.
requiresPreprocessing	boolean	True	Az az érték, amely jelzi, hogy a szabályművelet előfeldolgozást igényel-e.
sqlExpression	string		Az SQL-kifejezés. Pl. MyProperty='ABC'

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.