{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-managementgroups-management","description":"Management Groups API","version":"2018-03-01-preview","base_url":"https://management.azure.com","endpoints":13,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Management Groups API\n@base https://management.azure.com\n@version 2018-03-01-preview\n@auth OAuth2\n@common_fields {api-version: any # Version of the API to be used with the client request. The current version is 2018-01-01-preview.}\n@endpoints 13\n@toc providers(13)\n\n@endpoint GET /providers/Microsoft.Management/managementGroups\n@desc List management groups for the authenticated user.\n@optional {Cache-Control: any # Indicates that the request shouldn't utilize any caches., $skiptoken: any # Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.}\n@returns(200) OK\n\n@endpoint GET /providers/Microsoft.Management/managementGroups/{groupId}\n@desc Get the details of the management group.\n@required {groupId: any # Management Group ID.}\n@optional {$expand: any # The $expand=children query string parameter allows clients to request inclusion of children in the response payload., $recurse: any # The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that  $expand=children must be passed up if $recurse is set to true., $filter: any # A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription'), Cache-Control: any # Indicates that the request shouldn't utilize any caches.}\n@returns(200) OK\n\n@endpoint PUT /providers/Microsoft.Management/managementGroups/{groupId}\n@desc Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.\n@required {groupId: any # Management Group ID., createManagementGroupRequest: map # Management group creation parameters.}\n@optional {Cache-Control: any # Indicates that the request shouldn't utilize any caches.}\n@returns(200) OK\n@returns(202) Accepted\n\n@endpoint PATCH /providers/Microsoft.Management/managementGroups/{groupId}\n@desc Update a management group.\n@required {groupId: any # Management Group ID., patchGroupRequest: map # Management group patch parameters.}\n@optional {Cache-Control: any # Indicates that the request shouldn't utilize any caches.}\n@returns(200) OK\n\n@endpoint DELETE /providers/Microsoft.Management/managementGroups/{groupId}\n@desc Delete management group. If a management group contains child resources, the request will fail.\n@required {groupId: any # Management Group ID.}\n@optional {Cache-Control: any # Indicates that the request shouldn't utilize any caches.}\n@returns(202) Accepted\n@returns(204) NoContent\n\n@endpoint GET /providers/Microsoft.Management/managementGroups/{groupId}/descendants\n@desc List all entities that descend from a management group.\n@required {groupId: any # Management Group ID.}\n@optional {$skiptoken: any # Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls., $top: any # Number of elements to return when retrieving results. Passing this in will override $skipToken.}\n@returns(200) OK\n\n@endpoint PUT /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}\n@desc Associates existing subscription with the management group.\n@required {groupId: any # Management Group ID., subscriptionId: any # Subscription ID.}\n@optional {Cache-Control: any # Indicates that the request shouldn't utilize any caches.}\n@returns(204) NoContent\n\n@endpoint DELETE /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}\n@desc De-associates subscription from the management group.\n@required {groupId: any # Management Group ID., subscriptionId: any # Subscription ID.}\n@optional {Cache-Control: any # Indicates that the request shouldn't utilize any caches.}\n@returns(204) NoContent\n\n@endpoint GET /providers/Microsoft.Management/operations\n@desc Lists all of the available Management REST API operations.\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /providers/Microsoft.Management/checkNameAvailability\n@desc Checks if the specified management group name is valid and unique\n@required {checkNameAvailabilityRequest: map # Management group name availability check parameters.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /providers/Microsoft.Management/getEntities\n@desc List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.\n@optional {$skiptoken: any # Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls., $skip: any # Number of entities to skip over when retrieving results. Passing this in will override $skipToken., $top: any # Number of elements to return when retrieving results. Passing this in will override $skipToken., $select: any # This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken., $search: any # The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and  first level of children that the user has either direct access to or indirect access via one of their descendants., $filter: any # The filter parameter allows you to filter on the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}')  and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively., $view: any # The view parameter allows clients to filter the type of data that is returned by the getEntities call., groupName: any # A filter which allows the get entities call to focus on a particular group (i.e. \"$filter=name eq 'groupName'\"), Cache-Control: any # Indicates that the request shouldn't utilize any caches.}\n@returns(200) OK\n\n@endpoint POST /providers/Microsoft.Management/startTenantBackfill\n@desc Starts backfilling subscriptions for the Tenant.\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /providers/Microsoft.Management/tenantBackfillStatus\n@desc Gets tenant backfill status\n@returns(200) OK. The request has succeeded.\n\n@end\n"}