{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-apimanagement-apimproducts","description":"ApiManagementClient","version":"2019-12-01-preview","base_url":"https://management.azure.com","endpoints":25,"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 25\n@hint download_for_search\n@toc subscriptions(25)\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products\n@desc Lists a collection of products in the specified 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 | | terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq |     | | groups | expand |     |     |, expandGroups: any # When set to true, the response contains an array of groups that have visibility to the product. The default is false., tags: any # Products which are part of a specific tag.}\n@returns(200) A Collection of the Product entities for the specified API Management service instance.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}\n@desc Gets the entity state (Etag) version of the product specified by its identifier.\n@returns(200) Specified Product 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}/products/{productId}\n@desc Gets the details of the product specified by its identifier.\n@returns(200) The response body contains the specified Product entity.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}\n@desc Creates or Updates a product.\n@required {parameters: any # Create or update parameters.}\n@returns(200) Product was successfully updated.\n@returns(201) Product was successfully created.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}\n@desc Update existing product details.\n@required {parameters: any # Update parameters.}\n@returns(204) Product details was successfully updated.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}\n@desc Delete product.\n@optional {deleteSubscriptions: any # Delete existing subscriptions associated with the product or not.}\n@returns(200) Product was successfully removed.\n@returns(204) Product was successfully removed by previous request or does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis\n@desc Lists a collection of the APIs associated with a product.\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 | | serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |}\n@returns(200) The response body contains a collection of Api entities in the product.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}\n@desc Checks that API entity specified by identifier is associated with the Product entity.\n@returns(204) Entity exists\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}\n@desc Adds an API to the specified product.\n@returns(200) The specified API is already added to the product.\n@returns(201) The API was successfully added to the product.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}\n@desc Deletes the specified API from the specified product.\n@returns(200) API was successfully removed from product\n@returns(204) API successfully removed by previous request or does not exist in product\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups\n@desc Lists the collection of developer groups associated with the specified product.\n@optional {$filter: any # |   Field     |     Usage     |     Supported operators     |     Supported functions     ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt |     | | displayName | filter | eq, ne |     | | description | filter | eq, ne |     |}\n@returns(200) Lists a collection of Group entities.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}\n@desc Checks that Group entity specified by identifier is associated with the Product entity.\n@returns(204) The Group is associated with the Product.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}\n@desc Adds the association between the specified developer group with the specified product.\n@returns(200) The specified group is already associated with the product.\n@returns(201) The group was successfully associated with the product.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}\n@desc Deletes the association between the specified group and product.\n@returns(200) The group was successfully disassociated with the product.\n@returns(204) The group was successfully disassociated with the product.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions\n@desc Lists the collection of subscriptions to the specified product.\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 | | stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq |     | | user | expand |     |     |}\n@returns(200) Lists a collection of subscription entities.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies\n@desc Get the policy configuration at the Product level.\n@returns(200) Product Policy information.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}\n@desc Get the ETag of the policy configuration at the Product level.\n@returns(200) Product Policy Etag information.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}\n@desc Get the policy configuration at the Product level.\n@returns(200) Product Policy information.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}\n@desc Creates or updates policy configuration for the Product.\n@required {parameters: any # The policy contents to apply.}\n@returns(200) Product policy configuration of the tenant was successfully updated.\n@returns(201) Product policy configuration was successfully created.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}\n@desc Deletes the policy configuration at the Product.\n@returns(200) Successfully deleted the policy configuration at the Product level.\n@returns(204) Successfully deleted the policy configuration at the Product level.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags\n@desc Lists all Tags associated with the Product.\n@optional {$filter: any # |   Field     |     Usage     |     Supported operators     |     Supported functions     ||-------------|-------------|-------------|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |}\n@returns(200) The operation returns a collection of tags associated with the Product entity.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}\n@desc Gets the entity state version of the tag specified by its identifier.\n@returns(200) Empty response body, ETag header entity state version.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}\n@desc Get tag associated with the Product.\n@returns(200) Gets the details of the tag specified by its identifier.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}\n@desc Assign tag to the Product.\n@returns(200) Tag is already assigned to the Product.\n@returns(201) Tag was assigned to the Product.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}\n@desc Detach the tag from the Product.\n@returns(200) Successfully detached the tag from the Product.\n@returns(204) Successfully detached the tag from the Product.\n\n@end\n"}