openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 20.6 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 Projects Resource Provider Client","version":"2018-08-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/2018-08-01-preview/Projects.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"visualstudio-Projects","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/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":"Projects_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 or updates 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_CreateOrUpdate","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/update the team project resource has been queued. The URI to monitor the status of the job is provided in the 'location' header."}},"summary":"Projects_CreateOrUpdate","tags":["Projects"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"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":{"pipelineBootstrapConfigurations":[{"name":"ExampleApplicationDeployPipelineConfiguration","templateId":"ms-portal-extension-nodejsAppOnWindowsWebApp","templateParameters":{"servicePlanTier":"Standard","webAppName":"ExampleWebApp"}}],"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":{"pipelineBootstrapConfigurations":[{"name":"ExampleApplicationDeployPipelineConfiguration","templateId":"ms-portal-extension-nodejsAppOnWindowsWebApp","templateParameters":{"servicePlanTier":"Standard","webAppName":"ExampleWebApp"}}],"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":{"pipelineBootstrapConfigurations":[{"name":"ExampleApplicationDeployPipelineConfiguration","templateId":"ms-portal-extension-nodejsAppOnWindowsWebApp","templateParameters":{"servicePlanTier":"Standard","webAppName":"ExampleWebApp"}},{"name":"ExampleApplicationDeployPipelineConfiguration2","templateId":"ms-portal-extension-nodejsAppOnLinuxWebApp","templateParameters":{"servicePlanTier":"Standard","webAppName":"ExampleWebApp2"}}],"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":{"pipelineBootstrapConfigurations":[{"name":"ExampleApplicationDeployPipelineConfiguration","templateId":"ms-portal-extension-nodejsAppOnWindowsWebApp","templateParameters":{"servicePlanTier":"Standard","webAppName":"ExampleWebApp"}}],"processTemplateId":"Scrum","tfsUniqueIdentifier":"vstfs:///Classification/TeamProject/7a4e6ba5-35bf-4667-86a4-9b598a88fa25","versionControlOption":"Git"},"tags":{},"type":"microsoft.visualstudio/account/project"}}},"parameters":{"apiVersionParameter":{"description":"API Version","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get a list of project resources in the Team Services account":{"value":"2018-08-01-preview"},"Get a project resource":{"value":"2018-08-01-preview"},"Update a project resource":{"value":"2018-08-01-preview"},"Create a project resource":{"value":"2018-08-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"}}},"subscriptionIdParameter":{"description":"The Azure subscription identifier.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"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"}}}},"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":{"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"},"CodeRepository":{"description":"Defines a code repository.","properties":{"authorization":{"$ref":"#/components/schemas/Authorization"},"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/CodeRepositoryLegacy"}},"required":["repository"],"type":"object","x-ms-discriminator-value":"CodeRepository"},"CodeRepositoryLegacy":{"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"},"CodeTemplateApplicationSource":{"allOf":[{"$ref":"#/components/schemas/ApplicationSource"}],"description":"Defines the source application template.","type":"object","x-ms-discriminator-value":"CodeTemplate"},"PipelineBootstrapConfiguration":{"description":"Defines bootstrap configuration for a CI/CD pipeline.","properties":{"name":{"description":"Name of the bootstrap configuration.","type":"string"},"repository":{"$ref":"#/components/schemas/CodeRepository"},"templateId":{"description":"Identifier of the pipeline template used for configuring pipeline.","type":"string"},"templateParameters":{"additionalProperties":{"type":"string"},"description":"Dictionary of inputs used for configuring pipeline. The keys for inputs are defined by pipeline template.","type":"object"}},"required":["name","templateId"],"type":"object"},"PipelineTemplateLegacy":{"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. A bootStrappedProject is a project which has additional bootstrap information to create a CI/CD pipeline in the project.","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/PipelineTemplateLegacy"},"ownerUpn":{"description":"Optional UPN of the owner, on-behalf-of whom the project is being created.","type":"string"},"pipelineBootstrapConfigurations":{"description":"Bootstrap configuration for pipelines in Team Project.","items":{"$ref":"#/components/schemas/PipelineBootstrapConfiguration"},"type":"array"},"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":{"properties":{"description":"Custom properties of project resource.","properties":{"pipelineBootstrapConfigurations":{"description":"Bootstrap configurations for pipelines in Team Project.","items":{"$ref":"#/components/schemas/PipelineBootstrapConfiguration"},"type":"array"}},"type":"object"},"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.","readOnly":true,"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"}}}}