Ericchoi/main/event hub/2024 01 01

specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json

@@ -0,0 +1,347 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "EventHubManagementClient",
+    "description": "Azure Event Hubs client",
+    "version": "2024-01-01"
+  },
+  "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"
+            },
+            "clientAppGroupIdentifier": {
+              "type": "string",
+              "description": "The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)"
+            },
+            "policies": {
+              "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."
+        },
+        "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": {}
+}