Adding ApplicationGroup to EventHub Namespace #17430
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,347 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "EventHubManagementClient", | ||
| "description": "Azure Event Hubs client", | ||
| "version": "2022-01-01-preview" | ||
| }, | ||
| "host": "management.azure.com", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "security": [ | ||
| { | ||
| "azure_auth": [ | ||
| "user_impersonation" | ||
| ] | ||
| } | ||
| ], | ||
| "securityDefinitions": { | ||
| "azure_auth": { | ||
| "type": "oauth2", | ||
| "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", | ||
| "flow": "implicit", | ||
| "description": "Azure Active Directory OAuth2 Flow", | ||
| "scopes": { | ||
| "user_impersonation": "impersonate your user account" | ||
| } | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups": { | ||
| "get": { | ||
| "tags": [ | ||
| "ApplicationGroup" | ||
| ], | ||
| "operationId": "ApplicationGroup_ListByNamespace", | ||
| "x-ms-examples": { | ||
| "ListApplicationGroups": { | ||
| "$ref": "./examples/ApplicationGroup/ApplicationGroupListByNamespace.json" | ||
| } | ||
| }, | ||
| "description": "Gets a list of application groups for a Namespace.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Namespace ApplicationGroups successfully returned.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ApplicationGroupListResult" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Eventhub error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-pageable": { | ||
| "nextLinkName": "nextLink" | ||
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}": { | ||
| "put": { | ||
| "tags": [ | ||
| "ApplicationGroup" | ||
| ], | ||
| "operationId": "ApplicationGroup_CreateOrUpdateApplicationGroup", | ||
| "x-ms-azure-resource": true, | ||
| "x-ms-examples": { | ||
| "ApplicationGroupCreate": { | ||
| "$ref": "./examples/ApplicationGroup/ApplicationGroupCreate.json" | ||
| } | ||
| }, | ||
| "description": "Creates or updates an ApplicationGroup for a Namespace.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v2/definitions.json#/parameters/ApplicationGroupNameParameter" | ||
| }, | ||
| { | ||
| "name": "parameters", | ||
| "in": "body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/ApplicationGroup" | ||
| }, | ||
| "description": "The ApplicationGroup." | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "ApplicationGroup successfully created.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ApplicationGroup" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Eventhub error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "delete": { | ||
| "tags": [ | ||
| "ApplicationGroup" | ||
| ], | ||
| "operationId": "ApplicationGroup_Delete", | ||
| "x-ms-examples": { | ||
| "ApplicationGroupDelete": { | ||
| "$ref": "./examples/ApplicationGroup/ApplicationGroupDelete.json" | ||
| } | ||
| }, | ||
| "description": "Deletes an ApplicationGroup for a Namespace.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v2/definitions.json#/parameters/ApplicationGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "ApplicationGroup successfully deleted." | ||
| }, | ||
| "204": { | ||
| "description": "No content." | ||
| }, | ||
| "default": { | ||
| "description": "Eventhub error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "get": { | ||
| "tags": [ | ||
| "ApplicationGroup" | ||
| ], | ||
| "operationId": "ApplicationGroup_Get", | ||
| "x-ms-examples": { | ||
| "ApplicationGroupGet": { | ||
| "$ref": "./examples/ApplicationGroup/ApplicationGroupGet.json" | ||
| } | ||
| }, | ||
| "description": "Gets an ApplicationGroup for a Namespace.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v2/definitions.json#/parameters/ApplicationGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Namespace ApplicationGroup returned successfully.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ApplicationGroup" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Eventhub error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "ApplicationGroupListResult": { | ||
| "type": "object", | ||
| "properties": { | ||
| "value": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/ApplicationGroup" | ||
| }, | ||
| "description": "Result of the List Application Groups operation." | ||
| }, | ||
| "nextLink": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules" | ||
| } | ||
| }, | ||
| "description": "The response from the List Application Groups operation." | ||
| }, | ||
| "ApplicationGroup": { | ||
| "type": "object", | ||
| "properties": { | ||
| "properties": { | ||
| "type": "object", | ||
| "x-ms-client-flatten": true, | ||
| "properties": { | ||
| "isEnabled": { | ||
| "type": "boolean", | ||
| "description": "Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed" | ||
|
There was a problem hiding this comment. I have mentioned "no" new connections will be allowed. Do let me know if you think any fixes need to be made. There was a problem hiding this comment. Sorry I seemed to have read it wrong then. This is good. |
||
| }, | ||
| "clientAppGroupIdentifier": { | ||
| "type": "string", | ||
| "description": "The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)" | ||
| }, | ||
| "policies": { | ||
|
There was a problem hiding this comment. instead of an array why not just model it as policies.rateLimitThresholdPolicy.IncomingBytes Isnt it cleaner this way and you can also save on a lot of validations you might have to implement if you leave it as an array? #Closed There was a problem hiding this comment. I think you are coming from the perspective that there can only be 1 policy based on the metric Id which is applicable? This makes sense to me, but:
There was a problem hiding this comment. There was a problem hiding this comment. @rkmanda This is also a smart approach. But it does not look extendable if we have to add more properties related to "throttlingPolicy" for the same metricId e.g if we want to add "throttlingApplicableTill" timestamp field and has the flexibility that it can be applied at individual metricId, then we loose out on that extendibility. With arrays, yes we need to have certain checks & balances which will be present in service code and will keep getting added as the feature matures. There was a problem hiding this comment. Ok please be aware that either ways when you add new policies, they will need to be added in a new API version. API version 1 will have to populate the policies specific to that version and API version 2 will have to add a different set on a GET verb. The other issue with arrays is that when the client wants to modify only a single element, they still have to ensure theres logic in place to manipulate the whole array. So in general we are discouraging teams from using arrays. If you are willing to deal with the validation/ versioning complexities it is fine but pl do so with the understanding of all the implications. |
||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/ApplicationGroupPolicy" | ||
| }, | ||
| "x-ms-identifiers": [], | ||
| "description": "List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "clientAppGroupIdentifier" | ||
| ] | ||
| }, | ||
| "systemData": { | ||
| "readOnly": true, | ||
| "description": "The system meta data relating to this resource.", | ||
| "$ref": "../../../common/v1/definitions.json#/definitions/systemData" | ||
| } | ||
| }, | ||
| "allOf": [ | ||
| { | ||
| "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" | ||
| } | ||
| ], | ||
| "description": "The Application Group object" | ||
| }, | ||
| "ApplicationGroupPolicy": { | ||
| "type": "object", | ||
| "discriminator": "type", | ||
| "description": "Properties of the Application Group policy", | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "The Name of this policy" | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "ThrottlingPolicy" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "ApplicationGroupPolicyType", | ||
| "modelAsString": true | ||
| }, | ||
| "description": "Application Group Policy types" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "name", | ||
| "type" | ||
| ] | ||
| }, | ||
| "ThrottlingPolicy": { | ||
| "type": "object", | ||
| "x-ms-discriminator-value": "ThrottlingPolicy", | ||
| "description": "Properties of the throttling policy", | ||
| "properties": { | ||
| "rateLimitThreshold": { | ||
| "format": "int64", | ||
| "type": "integer", | ||
| "description": "The Threshold limit above which the application group will be throttled.Rate limit is always per second." | ||
|
There was a problem hiding this comment. do we have any upper/lower limit, if there is please add in the description. There was a problem hiding this comment. @yogeshgargmsft Is there one? or is it limited it int64 size? |
||
| }, | ||
| "metricId": { | ||
| "type": "string", | ||
| "description": "Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal", | ||
| "enum": [ | ||
| "IncomingBytes", | ||
| "OutgoingBytes", | ||
| "IncomingMessages", | ||
| "OutgoingMessages" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "MetricId", | ||
| "modelAsString": true | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "rateLimitThreshold", | ||
| "metricId" | ||
| ], | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/ApplicationGroupPolicy" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "parameters": {} | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.