{"files":{"SKILL.md":"---\nname: azuredigitaltwinsmanagementclient\ndescription: \"AzureDigitalTwinsManagementClient API skill. Use when working with AzureDigitalTwinsManagementClient for subscriptions, providers. Covers 12 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# AzureDigitalTwinsManagementClient\nAPI version: 2020-03-01-preview\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://management.azure.com\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /providers/Microsoft.DigitalTwins/operations -- lists all of the available digitaltwins service rest api operations.\n3. POST /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability -- create first checkNameAvailability\n\n## Endpoints\n12 endpoints across 2 groups. See references/api-spec.lap for full details.\n\n### Subscriptions\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} | Get DigitalTwinsInstances resource. |\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} | Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. |\n| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} | Update metadata of DigitalTwinsInstance. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} | Delete a DigitalTwinsInstance. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints | Get DigitalTwinsInstance Endpoints. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName} | Get DigitalTwinsInstances Endpoint. |\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName} | Create or update DigitalTwinsInstance endpoint. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName} | Delete a DigitalTwinsInstance endpoint. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances | Get all the DigitalTwinsInstances in a subscription. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances | Get all the DigitalTwinsInstances in a resource group. |\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability | Check if a DigitalTwinsInstance name is available. |\n\n### Providers\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /providers/Microsoft.DigitalTwins/operations | Lists all of the available DigitalTwins service REST API operations. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Get digitalTwinsInstance details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n- \"Update a digitalTwinsInstance?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n- \"Partially update a digitalTwinsInstance?\" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n- \"Delete a digitalTwinsInstance?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n- \"List all endpoints?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints\n- \"Get endpoint details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}\n- \"Update a endpoint?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}\n- \"Delete a endpoint?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}\n- \"List all digitalTwinsInstances?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances\n- \"List all operations?\" -> GET /providers/Microsoft.DigitalTwins/operations\n- \"Create a checkNameAvailability?\" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AzureDigitalTwinsManagementClient\n@base https://management.azure.com\n@version 2020-03-01-preview\n@auth OAuth2\n@common_fields {api-version: any # Version of the DigitalTwinsInstance Management API.}\n@endpoints 12\n@toc subscriptions(11), providers(1)\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n@desc Get DigitalTwinsInstances resource.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance.}\n@returns(200) The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n@desc Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance., digitalTwinsCreate: map # The DigitalTwinsInstance and security metadata.}\n@returns(200) This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(201) Created - Put request accepted; the operation will complete asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n@desc Update metadata of DigitalTwinsInstance.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance., digitalTwinsPatchDescription: map # The DigitalTwinsInstance and security metadata.}\n@returns(200) This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(201) Accepted - Put request accepted; the operation will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}\n@desc Delete a DigitalTwinsInstance.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance.}\n@returns(200) This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(202) Accepted - Delete request accepted; the operation will complete asynchronously.\n@returns(204) Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the DigitalTwins service metadata in the service and the status of the delete operation is set to a completed state.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints\n@desc Get DigitalTwinsInstance Endpoints.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance.}\n@returns(200) The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}\n@desc Get DigitalTwinsInstances Endpoint.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance., endpointName: any # Name of Endpoint Resource.}\n@returns(200) The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}\n@desc Create or update DigitalTwinsInstance endpoint.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance., endpointName: any # Name of Endpoint Resource., endpointDescription: any # The DigitalTwinsInstance endpoint metadata and security metadata.}\n@returns(200) This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(201) Created - Put request accepted; the operation will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}\n@desc Delete a DigitalTwinsInstance endpoint.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance., resourceName: any # The name of the DigitalTwinsInstance., endpointName: any # Name of Endpoint Resource.}\n@returns(200) This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(202) Accepted - Delete request accepted; the operation will complete asynchronously.\n@returns(204) Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the DigitalTwins service metadata in the service and the status of the delete operation is set to a completed state.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances\n@desc Get all the DigitalTwinsInstances in a subscription.\n@required {subscriptionId: any # The subscription identifier.}\n@returns(200) This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DigitalTwinsInstances in the subscription.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances\n@desc Get all the DigitalTwinsInstances in a resource group.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the DigitalTwinsInstance.}\n@returns(200) This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DigitalTwinsInstances in the resource group.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.DigitalTwins/operations\n@desc Lists all of the available DigitalTwins service REST API operations.\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability\n@desc Check if a DigitalTwinsInstance name is available.\n@required {subscriptionId: any # The subscription identifier., location: any # Location of DigitalTwinsInstance., digitalTwinsInstanceCheckName: map # Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.}\n@returns(200) This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the DigitalTwins service name is available. If the name is not available, the body contains the reason.\n\n@endgroup\n\n@end\n"}}