openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 42.3 kB
JSON
{"openapi":"3.0.0","info":{"description":"Use these APIs to manage Visual Studio Team Services resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see https://docs.microsoft.com/en-us/rest/api/index.","title":"Visual Studio Resource Provider Client","version":"2017-11-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/Csm.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"visualstudio-Csm","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/microsoft.visualstudio/operations":{"get":{"description":"Gets the details of all operations possible on the Microsoft.VisualStudio resource provider.","operationId":"Operations_List","responses":{"200":{"description":"The operation succeeded. The response contains the possible operations on the Microsoft.VisualStudio resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"},"examples":{"Get a list of operations for this resource provider":{"$ref":"#/components/examples/Get_a_list_of_operations_for_this_resource_provider"}}}}}},"summary":"Operations_List","tags":["Operations"]}},"/subscriptions/{subscriptionId}/providers/microsoft.visualstudio/checkNameAvailability":{"post":{"description":"Checks if the specified Visual Studio Team Services account name is available. Resource name can be either an account name or an account name and PUID.","operationId":"Accounts_CheckNameAvailability","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityParameter"}}},"description":"Parameters describing the name to check availability for.","required":true},"responses":{"200":{"description":"The operation succeeded. The response contains the result of the name availability check.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityResult"},"examples":{"Check availability of an account name":{"$ref":"#/components/examples/Check_availability_of_an_account_name"}}}}}},"summary":"Accounts_CheckNameAvailability","tags":["Accounts"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{rootResourceName}/project":{"get":{"deprecated":true,"description":"Gets all Visual Studio Team Services project resources created in the specified Team Services account.","operationId":"Project_ListByAccountResource","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"Name of the Team Services account.","in":"path","name":"rootResourceName","required":true,"schema":{"type":"string"},"examples":{"Get a list of project resources in the Team Services account":{"value":"ExampleAccount"}}}],"responses":{"200":{"description":"The operation succeeded. The response contains the details of the Visual Studio Team Services project resources created in the specified Team Services account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResourceListResult"},"examples":{"Get a list of project resources in the Team Services account":{"$ref":"#/components/examples/Get_a_list_of_project_resources_in_the_Team_Services_account"}}}}}},"summary":"Projects_ListByAccountResource","tags":["Projects"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{rootResourceName}/project/{resourceName}":{"get":{"deprecated":true,"description":"Gets the details of a Team Services project resource.","operationId":"Projects_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"Name of the Team Services account.","in":"path","name":"rootResourceName","required":true,"schema":{"type":"string"},"examples":{"Get a project resource":{"value":"ExampleAccount"}}},{"description":"Name of the Team Services project.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Get a project resource":{"value":"ExampleProject"}}}],"responses":{"200":{"description":"The operation succeeded. The response contains the details of the updated team project resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResource"},"examples":{"Get a project resource":{"$ref":"#/components/examples/Get_a_project_resource"}}}}},"404":{"description":"The project or Azure subscription was not found."}},"summary":"Projects_Get","tags":["Projects"]},"patch":{"deprecated":true,"description":"Updates the tags of the specified Team Services project.","operationId":"Projects_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"Name of the Team Services account.","in":"path","name":"rootResourceName","required":true,"schema":{"type":"string"},"examples":{"Update a project resource":{"value":"ExampleAccount"}}},{"description":"Name of the Team Services project.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Update a project resource":{"value":"ExampleProject"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResourceUpdateParameters"}}},"description":"The request data.","required":true},"responses":{"200":{"description":"The operation succeeded. The response contains the details of the updated team project resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResource"},"examples":{"Update a project resource":{"$ref":"#/components/examples/Update_a_project_resource"}}}}}},"summary":"Projects_Update","tags":["Projects"]},"put":{"deprecated":true,"description":"Creates a Team Services project in the collection with the specified name. 'VersionControlOption' and 'ProcessTemplateId' must be specified in the resource properties. Valid values for VersionControlOption: Git, Tfvc. Valid values for ProcessTemplateId: 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC, 27450541-8E31-4150-9947-DC59F998FC01 (these IDs correspond to Scrum, Agile, and CMMI process templates).","operationId":"Projects_Create","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"Name of the Team Services account.","in":"path","name":"rootResourceName","required":true,"schema":{"type":"string"},"examples":{"Create a project resource":{"value":"ExampleAccount"}}},{"description":"Name of the Team Services project.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Create a project resource":{"value":"ExampleProject"}}},{"description":"This parameter is ignored and should be set to an empty string.","in":"query","name":"validating","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResource"}}},"description":"The request data.","required":true},"responses":{"200":{"description":"The operation succeeded. The response contains the details of the created or updated team project resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResource"},"examples":{"Create a project resource":{"$ref":"#/components/examples/Create_a_project_resource"}}}}},"202":{"description":"The operation succeeded. A job to create the team project resource has been queued. The URI to monitor the status of the job is provided in the 'location' header."}},"summary":"Projects_Create","tags":["Projects"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account":{"get":{"description":"Gets all Visual Studio Team Services account resources under the resource group linked to the specified Azure subscription.","operationId":"Accounts_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The operation succeeded. The response contains the details of the Visual Studio Team Services account resources linked to the Azure subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResourceListResult"},"examples":{"Get a list of account resources in the resource group":{"$ref":"#/components/examples/Get_a_list_of_account_resources_in_the_resource_group"}}}}}},"summary":"Accounts_ListByResourceGroup","tags":["Accounts"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{accountResourceName}/extension":{"get":{"description":"Gets the details of the extension resources created within the resource group.","operationId":"Extensions_ListByAccount","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"The name of the Visual Studio Team Services account resource.","in":"path","name":"accountResourceName","required":true,"schema":{"type":"string"},"examples":{"Get a list of extension resources within the resource group":{"value":"ExampleAccount"}}}],"responses":{"200":{"description":"The operation succeeded. The response contains all extension resource details for the specified account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionResourceListResult"},"examples":{"Get a list of extension resources within the resource group":{"$ref":"#/components/examples/Get_a_list_of_extension_resources_within_the_resource_group"}}}}}},"summary":"Extensions_ListByAccount","tags":["Extensions"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{accountResourceName}/extension/{extensionResourceName}":{"delete":{"description":"Removes an extension resource registration for a Visual Studio Team Services account.","operationId":"Extensions_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"The name of the Visual Studio Team Services account resource.","in":"path","name":"accountResourceName","required":true,"schema":{"type":"string"},"examples":{"Delete an extension resource":{"value":"Example"}}},{"description":"The name of the extension.","in":"path","name":"extensionResourceName","required":true,"schema":{"type":"string"},"examples":{"Delete an extension resource":{"value":"ms.example"}}}],"responses":{"200":{"description":"The operation succeeded. The extension resource has been deleted for the specified account."}},"summary":"Extensions_Delete","tags":["Extensions"]},"get":{"description":"Gets the details of an extension associated with a Visual Studio Team Services account resource.","operationId":"Extensions_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"The name of the Visual Studio Team Services account resource.","in":"path","name":"accountResourceName","required":true,"schema":{"type":"string"},"examples":{"Get an extension resource":{"value":"ExampleAccount"}}},{"description":"The name of the extension.","in":"path","name":"extensionResourceName","required":true,"schema":{"type":"string"},"examples":{"Get an extension resource":{"value":"ms.example"}}}],"responses":{"200":{"description":"The operation succeeded. The response contains the extension resource details for the specified account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionResource"},"examples":{"Get an extension resource":{"$ref":"#/components/examples/Get_an_extension_resource"}}}}},"404":{"description":"The specified extension has no plans defined."}},"summary":"Extensions_Get","tags":["Extensions"]},"patch":{"description":"Updates an existing extension registration for the Visual Studio Team Services account.","operationId":"Extensions_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"The name of the Visual Studio Team Services account resource.","in":"path","name":"accountResourceName","required":true,"schema":{"type":"string"},"examples":{"Update an extension resource":{"value":"ExampleAccount"}}},{"description":"The name of the extension.","in":"path","name":"extensionResourceName","required":true,"schema":{"type":"string"},"examples":{"Update an extension resource":{"value":"Example"}}}],"requestBody":{"$ref":"#/components/requestBodies/ExtensionResourceRequest"},"responses":{"200":{"description":"The operation succeeded. The extension resource was updated for the specified account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionResource"},"examples":{"Update an extension resource":{"$ref":"#/components/examples/Update_an_extension_resource"}}}}}},"summary":"Extensions_Update","tags":["Extensions"]},"put":{"description":"Registers the extension with a Visual Studio Team Services account.","operationId":"Extensions_Create","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"The name of the Visual Studio Team Services account resource.","in":"path","name":"accountResourceName","required":true,"schema":{"type":"string"},"examples":{"Create an extension resource":{"value":"ExampleAccount"}}},{"description":"The name of the extension.","in":"path","name":"extensionResourceName","required":true,"schema":{"type":"string"},"examples":{"Create an extension resource":{"value":"ms.example"}}}],"requestBody":{"$ref":"#/components/requestBodies/ExtensionResourceRequest"},"responses":{"200":{"description":"The operation succeeded. The extension resource was created for the specified account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionResource"},"examples":{"Create an extension resource":{"$ref":"#/components/examples/Create_an_extension_resource"}}}}}},"summary":"Extensions_Create","tags":["Extensions"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{resourceName}":{"delete":{"description":"Deletes a Visual Studio Team Services account resource.","operationId":"Accounts_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Delete an account resource":{"value":"Example"}}}],"responses":{"200":{"description":"The operation succeeded. The Visual Studio Team Services account resource was deleted."}},"summary":"Accounts_Delete","tags":["Accounts"]},"get":{"description":"Gets the Visual Studio Team Services account resource details.","operationId":"Accounts_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Get an account resource":{"value":"Example"}}}],"responses":{"200":{"description":"The operation succeeded. The response contains the details of the Visual Studio Team Services account resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResource"},"examples":{"Get an account resource":{"$ref":"#/components/examples/Get_an_account_resource"}}}}},"404":{"description":"The Visual Studio Team Services account does not exist."}},"summary":"Accounts_Get","tags":["Accounts"]},"put":{"description":"Creates or updates a Visual Studio Team Services account resource.","operationId":"Accounts_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Create an account resource":{"value":"Example"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResourceRequest"}}},"description":"The request data.","required":true},"responses":{"200":{"description":"The operation succeeded. The Visual Studio Team Services account resource was created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResource"},"examples":{"Create an account resource":{"$ref":"#/components/examples/Create_an_account_resource"}}}}},"404":{"description":"The Visual Studio Team Services account does not exist."}},"summary":"Accounts_CreateOrUpdate","tags":["Accounts"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_a_list_of_operations_for_this_resource_provider":{"value":{"value":[{"display":{"description":"Set Account","operation":"Creates or updates the Account","provider":"Visual Studio","resource":"Account"},"name":"Microsoft.VisualStudio/Account/Write"},{"display":{"description":"Delete Account","operation":"Deletes the Account","provider":"Visual Studio","resource":"Account"},"name":"Microsoft.VisualStudio/Account/Delete"},{"display":{"description":"Read Account","operation":"Reads the Account","provider":"Visual Studio","resource":"Account"},"name":"Microsoft.VisualStudio/Account/Read"},{"display":{"description":"Set Project","operation":"Creates or updates the Project","provider":"Visual Studio","resource":"Project"},"name":"Microsoft.VisualStudio/Project/Write"},{"display":{"description":"Delete Project","operation":"Deletes the Project","provider":"Visual Studio","resource":"Project"},"name":"Microsoft.VisualStudio/Project/Delete"},{"display":{"description":"Read Project","operation":"Reads the Project","provider":"Visual Studio","resource":"Project"},"name":"Microsoft.VisualStudio/Project/Read"},{"display":{"description":"Set Extension","operation":"Creates or updates the Extension","provider":"Visual Studio","resource":"Extension"},"name":"Microsoft.VisualStudio/Extension/Write"},{"display":{"description":"Delete Extension","operation":"Deletes the Extension","provider":"Visual Studio","resource":"Extension"},"name":"Microsoft.VisualStudio/Extension/Delete"},{"display":{"description":"Read Extension","operation":"Reads the Extension","provider":"Visual Studio","resource":"Extension"},"name":"Microsoft.VisualStudio/Extension/Read"}]}},"Check_availability_of_an_account_name":{"value":{"nameAvailable":true}},"Get_a_list_of_project_resources_in_the_Team_Services_account":{"value":{"value":[{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/project/ExampleProject","kind":"bootstrappedProject","location":"Central US","name":"ExampleProject","properties":{"bootstrapPipelineTemplate":{"applicationSource":{"applicationConfiguration":{"nodeJsVersion":"8.5.0"},"applicationType":"NodeJs","sourceType":"CodeTemplate"},"applicationTarget":{"resources":[{"id":"/subscriptions/ea99dfc9-1597-48ed-85f6-9bf922591395/resourceGroups/testrg/providers/Microsoft.Web/sites/MyWebSite","role":"AppService"}],"targetType":"WindowsAppService"},"authorizationDetails":{}},"processTemplateId":"Scrum","tfsUniqueIdentifier":"vstfs:///Classification/TeamProject/d921d601-0600-4e45-8600-3914ffc8811a","versionControlOption":"Git"},"tags":{},"type":"Microsoft.VisualStudio/account/project"}]}},"Get_a_project_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/microsoft.visualstudio/account/ExampleAccount/project/ExampleProject","kind":"bootstrappedProject","location":"North Central US","name":"ExampleProject","properties":{"bootstrapPipelineTemplate":{"applicationSource":{"applicationConfiguration":{"nodeJsVersion":"8.5.0"},"applicationType":"NodeJs","sourceType":"CodeTemplate"},"applicationTarget":{"resources":[{"id":"/subscriptions/ea99dfc9-1597-48ed-85f6-9bf922591395/resourceGroups/testrg/providers/Microsoft.Web/sites/MyWebSite","role":"AppService"}],"targetType":"WindowsAppService"},"authorizationDetails":{}},"processTemplateId":"Scrum","tfsUniqueIdentifier":"vstfs:///Classification/TeamProject/7a4e6ba5-35bf-4667-86a4-9b598a88fa25","versionControlOption":"Git"},"tags":{},"type":"microsoft.visualstudio/account/project"}},"Update_a_project_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/microsoft.visualstudio/account/ExampleAccount/project/ExampleProject","kind":"bootstrappedProject","location":"North Central US","name":"ExampleProject","properties":{"bootstrapPipelineTemplate":{"applicationSource":{"applicationConfiguration":{"nodeJsVersion":"8.5.0"},"applicationType":"NodeJs","sourceType":"CodeTemplate"},"applicationTarget":{"resources":[{"id":"/subscriptions/ea99dfc9-1597-48ed-85f6-9bf922591395/resourceGroups/testrg/providers/Microsoft.Web/sites/MyWebSite","role":"AppService"}],"targetType":"WindowsAppService"},"authorizationDetails":{}},"processTemplateId":"Scrum","tfsUniqueIdentifier":"vstfs:///Classification/TeamProject/7a4e6ba5-35bf-4667-86a4-9b598a88fa25","versionControlOption":"Git"},"tags":{"NewTag":"NewTagValue"},"type":"microsoft.visualstudio/account/project"}},"Create_a_project_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/microsoft.visualstudio/account/ExampleAccount/project/ExampleProject","kind":"bootstrappedProject","location":"North Central US","name":"ExampleProject","properties":{"bootstrapPipelineTemplate":{"applicationSource":{"applicationConfiguration":{"nodeJsVersion":"8.5.0"},"applicationType":"NodeJs","sourceType":"CodeTemplate"},"applicationTarget":{"resources":[{"id":"/subscriptions/ea99dfc9-1597-48ed-85f6-9bf922591395/resourceGroups/testrg/providers/Microsoft.Web/sites/MyWebSite","role":"AppService"}],"targetType":"WindowsAppService"},"authorizationDetails":{}},"processTemplateId":"Scrum","tfsUniqueIdentifier":"vstfs:///Classification/TeamProject/7a4e6ba5-35bf-4667-86a4-9b598a88fa25","versionControlOption":"Git"},"tags":{},"type":"microsoft.visualstudio/account/project"}},"Get_a_list_of_account_resources_in_the_resource_group":{"value":{"value":[{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/Example","location":"Central US","name":"VS-Example-Group","properties":{"AccountURL":""},"tags":{},"type":"Microsoft.VisualStudio/account"}]}},"Get_a_list_of_extension_resources_within_the_resource_group":{"value":{"value":[{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/extension/ms.example","location":"Central US","name":"ms.example","plan":{"name":"ExamplePlan","product":"ExampleExtensionName","promotionCode":"","publisher":"ExampleExtensionPublisher","version":"1.0"},"properties":{},"tags":{},"type":"Microsoft.VisualStudio/account/extension"}]}},"Get_an_extension_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/extension/ms.example","location":"Central US","name":"ms.example","plan":{"name":"ExamplePlan","product":"ExampleExtensionName","promotionCode":"","publisher":"ExampleExtensionPublisher","version":"1.0"},"properties":{},"tags":{},"type":"Microsoft.VisualStudio/account/extension"}},"Update_an_extension_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/extension/ms.example","location":"Central US","name":"ms.example","plan":{"name":"ExamplePlan","product":"ExampleExtensionName","promotionCode":"","publisher":"ExampleExtensionPublisher","version":"1.0"},"properties":{},"tags":{},"type":"Microsoft.VisualStudio/account/extension"}},"Create_an_extension_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/extension/ms.example","location":"Central US","name":"ms.example","plan":{"name":"ExamplePlan","product":"ExampleExtensionName","promotionCode":"","publisher":"ExampleExtensionPublisher","version":"1.0"},"properties":{},"tags":{},"type":"Microsoft.VisualStudio/account/extension"}},"Get_an_account_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/Example","location":"Central US","name":"VS-Example-Group","properties":{"AccountURL":""},"tags":{},"type":"Microsoft.VisualStudio/account"}},"Create_an_account_resource":{"value":{"id":"/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/Example","location":"Central US","name":"VS-Example-Group","properties":{"AccountURL":""},"tags":{},"type":"Microsoft.VisualStudio/account"}}},"parameters":{"apiVersionParameter":{"description":"API Version","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Check availability of an account name":{"value":"2014-04-01-preview"},"Get a list of project resources in the Team Services account":{"value":"2017-11-01-preview"},"Get a project resource":{"value":"2017-11-01-preview"},"Update a project resource":{"value":"2017-11-01-preview"},"Create a project resource":{"value":"2017-11-01-preview"},"Get a list of account resources in the resource group":{"value":"2014-04-01-preview"},"Get a list of extension resources within the resource group":{"value":"2014-04-01-preview"},"Delete an extension resource":{"value":"2014-04-01-preview"},"Get an extension resource":{"value":"2014-04-01-preview"},"Update an extension resource":{"value":"2014-04-01-preview"},"Create an extension resource":{"value":"2014-04-01-preview"},"Delete an account resource":{"value":"2014-04-01-preview"},"Get an account resource":{"value":"2014-04-01-preview"},"Create an account resource":{"value":"2014-04-01-preview"}}},"resourceGroupNameParameter":{"description":"Name of the resource group within the Azure subscription.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get a list of project resources in the Team Services account":{"value":"VS-Example-Group"},"Get a project resource":{"value":"VS-Example-Group"},"Update a project resource":{"value":"VS-Example-Group"},"Create a project resource":{"value":"VS-Example-Group"},"Get a list of account resources in the resource group":{"value":"VS-Example-Group"},"Get a list of extension resources within the resource group":{"value":"VS-Example-Group"},"Delete an extension resource":{"value":"VS-Example-Group"},"Get an extension resource":{"value":"VS-Example-Group"},"Update an extension resource":{"value":"VS-Example-Group"},"Create an extension resource":{"value":"VS-Example-Group"},"Delete an account resource":{"value":"VS-Example-Group"},"Get an account resource":{"value":"VS-Example-Group"},"Create an account resource":{"value":"VS-Example-Group"}}},"subscriptionIdParameter":{"description":"The Azure subscription identifier.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Check availability of an account name":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Get a list of project resources in the Team Services account":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Get a project resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Update a project resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Create a project resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Get a list of account resources in the resource group":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Get a list of extension resources within the resource group":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Delete an extension resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Get an extension resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Update an extension resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Create an extension resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Delete an account resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Get an account resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"},"Create an account resource":{"value":"0de7f055-dbea-498d-8e9e-da287eedca90"}}}},"requestBodies":{"ExtensionResourceRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionResourceRequest"}}},"description":"An object containing additional information related to the extension request.","required":true}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"AccountResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"The response to an account resource GET request.","properties":{"properties":{"additionalProperties":{"type":"string"},"description":"Resource properties.","type":"object","x-ms-client-flatten":true}},"type":"object"},"AccountResourceListResult":{"description":"The response to an account resource list GET request.","properties":{"value":{"description":"Array of resource details.","items":{"$ref":"#/components/schemas/AccountResource"},"type":"array"}},"type":"object"},"AccountResourceRequest":{"description":"The body of a PUT request to modify a Visual Studio account resource.","properties":{"accountName":{"description":"The account name.","type":"string"},"location":{"description":"The Azure instance location.","type":"string"},"operationType":{"description":"The type of the operation.","enum":["unknown","create","update","link"],"x-ms-enum":{"name":"AccountResourceRequestOperationType"}},"properties":{"additionalProperties":{"type":"string"},"description":"The custom properties of the resource.","type":"object","x-ms-client-flatten":true},"tags":{"additionalProperties":{"type":"string"},"description":"The custom tags of the resource.","type":"object"}},"type":"object"},"ApplicationSource":{"description":"Defines the source application for a VSTS pipeline.","discriminator":{"propertyName":"sourceType"},"properties":{"applicationConfiguration":{"additionalProperties":{"type":"string"},"description":"Application specific properties.","type":"object"},"applicationType":{"description":"Type of application.","enum":["AspDotNet","AspDotNetCore","NodeJs"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ApplicationType"}},"sourceType":{"description":"Type of application source.","enum":["CodeTemplate","CodeRepository"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ApplicationSourceType"}}},"required":["sourceType","applicationType"],"type":"object"},"ApplicationTarget":{"description":"Defines the target resources for a VSTS pipeline.","properties":{"resources":{"description":"List of target resources.","items":{"$ref":"#/components/schemas/TargetResource"},"type":"array"},"targetType":{"description":"Type of target.","enum":["WindowsAppService"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ApplicationTargetType"}}},"required":["targetType","resources"],"type":"object"},"Authorization":{"description":"Defines the authorization type and its parameters.","properties":{"authorizationType":{"description":"Type of authorization.","enum":["authorizationToken","personalAccessToken"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AuthorizationType"}},"parameters":{"additionalProperties":{"type":"string"},"description":"Authorization parameters corresponding to the authorization type.","type":"object"}},"required":["authorizationType"],"type":"object"},"CheckNameAvailabilityParameter":{"description":"The body of a POST request to check name availability.","properties":{"resourceName":{"description":"The name of the resource to check availability for.","type":"string"},"resourceType":{"description":"The type of resource to check availability for.","type":"string"}},"type":"object"},"CheckNameAvailabilityResult":{"description":"The response to a name availability request.","properties":{"message":{"description":"The message describing the detailed reason.","type":"string"},"nameAvailable":{"description":"The value which indicates whether the provided name is available.","type":"boolean"}},"type":"object"},"CodeRepository":{"description":"Defines a code repository.","properties":{"authorizationReference":{"description":"Reference to the authorization info used to access the code repository. This value is used as a key into the global authorization details dictionary.","type":"string"},"defaultBranch":{"description":"Default branch for which continuous integration should be configured in the VSTS pipeline.","type":"string"},"id":{"description":"Unique identifier of the code repository.","type":"string"},"properties":{"additionalProperties":{"type":"string"},"description":"Repository-specific properties.","type":"object"},"repositoryType":{"description":"Type of code repository.","enum":["gitHub","vstsGit"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"CodeRepositoryType"}}},"required":["repositoryType","id","defaultBranch"],"type":"object"},"CodeRepositoryApplicationSource":{"allOf":[{"$ref":"#/components/schemas/ApplicationSource"}],"description":"Defines the source application, when it resides in a code repository.","properties":{"repository":{"$ref":"#/components/schemas/CodeRepository"}},"required":["repository"],"type":"object","x-ms-discriminator-value":"CodeRepository"},"CodeTemplateApplicationSource":{"allOf":[{"$ref":"#/components/schemas/ApplicationSource"}],"description":"Defines the source application template.","type":"object","x-ms-discriminator-value":"CodeTemplate"},"ExtensionResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"The response to an extension resource GET request.","properties":{"plan":{"$ref":"#/components/schemas/ExtensionResourcePlan"},"properties":{"additionalProperties":{"type":"string"},"description":"Resource properties.","type":"object"}},"type":"object"},"ExtensionResourceListResult":{"description":"The response to an extension resource list GET request.","properties":{"value":{"description":"Array of extension resource details.","items":{"$ref":"#/components/schemas/ExtensionResource"},"type":"array"}},"type":"object"},"ExtensionResourcePlan":{"description":"Plan data for an extension resource.","properties":{"name":{"description":"Name of the plan.","type":"string"},"product":{"description":"Product name.","type":"string"},"promotionCode":{"description":"Optional: the promotion code associated with the plan.","type":"string"},"publisher":{"description":"Name of the extension publisher.","type":"string"},"version":{"description":"A string that uniquely identifies the plan version.","type":"string"}},"type":"object"},"ExtensionResourceRequest":{"description":"The body of an extension resource PUT request.","properties":{"location":{"description":"The Azure region of the Visual Studio account associated with this request (i.e 'southcentralus'.)","type":"string"},"plan":{"$ref":"#/components/schemas/ExtensionResourcePlan"},"properties":{"additionalProperties":{"type":"string"},"description":"A dictionary of extended properties. This property is currently unused.","type":"object","x-ms-client-flatten":true},"tags":{"additionalProperties":{"type":"string"},"description":"A dictionary of user-defined tags to be stored with the extension resource.","type":"object"}},"type":"object"},"Operation":{"description":"Properties of an operation supported by the resource provider.","properties":{"display":{"$ref":"#/components/schemas/OperationProperties"},"name":{"description":"The name of the resource operation.","type":"string"}},"type":"object"},"OperationListResult":{"description":"Container for a list of operations supported by a resource provider.","properties":{"value":{"description":"A list of operations supported by a resource provider.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"}},"type":"object"},"OperationProperties":{"description":"Properties of an operation supported by the resource provider.","properties":{"description":{"description":"The description of the resource operation.","type":"string"},"operation":{"description":"The operation name.","type":"string"},"provider":{"description":"The provider name.","type":"string"},"resource":{"description":"The resource name.","type":"string"}},"type":"object"},"PipelineTemplate":{"description":"Defines a VSTS pipeline template.","properties":{"applicationSource":{"$ref":"#/components/schemas/ApplicationSource"},"applicationTarget":{"$ref":"#/components/schemas/ApplicationTarget"},"authorizationDetails":{"additionalProperties":{"$ref":"#/components/schemas/Authorization"},"description":"Global dictionary of authorization details used by the pipeline, with a friendly name as key. Individual resource in the pipeline can reference to a specific authorization info using the friendly name.","type":"object"}},"required":["applicationSource","applicationTarget","authorizationDetails"],"type":"object"},"ProjectResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"A Visual Studio Team Services project resource.","properties":{"kind":{"description":"Kind of project resource","enum":["project","bootstrappedProject"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProjectResourceKind"}},"properties":{"$ref":"#/components/schemas/ProjectResourceProperties"}},"type":"object"},"ProjectResourceListResult":{"description":"The response to a request to list Team Services project resources in a resource group/account.","properties":{"value":{"description":"List of project resource details.","items":{"$ref":"#/components/schemas/ProjectResource"},"type":"array"}},"type":"object"},"ProjectResourceProperties":{"description":"Defines the custom properties of project resource.","properties":{"bootstrapPipelineTemplate":{"$ref":"#/components/schemas/PipelineTemplate"},"ownerUpn":{"description":"Optional UPN of the owner, on-behalf-of whom the project is being created.","type":"string"},"processTemplateId":{"description":"Process template to use in the project.","enum":["Scrum","Agile","Cmmi"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProcessTemplate"}},"tfsUniqueIdentifier":{"description":"Unique identifier of the VSTS project.","readOnly":true,"type":"string"},"versionControlOption":{"description":"Version control to use for the default repo created in the project.","enum":["Git","Tfvc"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"VersionControlOption"}}},"type":"object"},"ProjectResourceUpdateParameters":{"description":"The parameters to update a project resource.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"The custom tags to be set on the resource.","type":"object"}},"type":"object"},"Resource":{"description":"A generic Azure Resource Manager resource.","properties":{"id":{"description":"Unique identifier of the resource.","readOnly":true,"type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true},"TargetResource":{"description":"Defines a single resource used as target for a VSTS pipeline.","properties":{"authorizationReference":{"description":"Reference to the authorization info used to access the target resource. This value is used as a key into the global authorization details dictionary.","type":"string"},"id":{"description":"Unique identifier of the target resource.","type":"string"},"role":{"description":"Role of the target resource.","type":"string"}},"required":["id","role"],"type":"object"}}}}