{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-apimanagement-apimgroups","description":"ApiManagementClient","version":"2019-12-01-preview","base_url":"https://management.azure.com","endpoints":10,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api ApiManagementClient\n@base https://management.azure.com\n@version 2019-12-01-preview\n@auth OAuth2\n@endpoints 10\n@toc subscriptions(10)\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups\n@desc Lists a collection of groups defined within a service instance.\n@optional {$filter: any # |   Field     |     Usage     |     Supported operators     |     Supported functions     ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aadObjectId | filter | eq |     |}\n@returns(200) Lists a collection of Group entities.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}\n@desc Gets the entity state (Etag) version of the group specified by its identifier.\n@returns(200) Specified group entity exists and current entity state version is present in the ETag header.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}\n@desc Gets the details of the group specified by its identifier.\n@returns(200) The response body contains the specified Group entity.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}\n@desc Creates or Updates a group.\n@required {parameters: any # Create parameters.}\n@returns(200) Group already exists.\n@returns(201) Group was created successfully.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}\n@desc Updates the details of the group specified by its identifier.\n@required {parameters: any # Update parameters.}\n@returns(204) The group details were successfully updated.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}\n@desc Deletes specific group of the API Management service instance.\n@returns(200) The group was successfully deleted.\n@returns(204) The group was successfully deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users\n@desc Lists a collection of user entities associated with the group.\n@optional {$filter: any # |   Field     |     Usage     |     Supported operators     |     Supported functions     ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | registrationDate | filter | ge, le, eq, ne, gt, lt |     | | note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |}\n@returns(200) Lists a collection of user entities associated with the group.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}\n@desc Checks that user entity specified by identifier is associated with the group entity.\n@returns(204) Entity exists\n@errors {404: Entity does not exists.}\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}\n@desc Add existing user to existing group\n@returns(200) The specified user is already a member of the specified group.\n@returns(201) The user was successfully added to the group.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}\n@desc Remove existing user from existing group.\n@returns(200) The user was successfully removed from the group.\n@returns(204) The user was successfully removed from the group.\n\n@end\n"}