Projects - Create

Referens

Tjänst:: Visual Studio

API-version:: 2017-11-01-preview

Projects_Create
Skapar ett Team Services-projekt i samlingen med det angivna namnet. "VersionControlOption" och "ProcessTemplateId" måste anges i resursegenskaperna. Giltiga värden för VersionControlOption: Git, Tfvc. Giltiga värden för ProcessTemplateId: 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC, 27450541-8E31-4150-9947-DC59F998FC01 (dessa ID:er motsvarar Scrum-, Agile- och CMMI-processmallar).

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{rootResourceName}/project/{resourceName}?api-version=2017-11-01-preview

Med valfria parametrar:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{rootResourceName}/project/{resourceName}?api-version=2017-11-01-preview&validating={validating}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i Azure-prenumerationen.
resourceName	path	True	string	Namnet på Team Services-projektet.
rootResourceName	path	True	string	Namnet på Team Services-kontot.
subscriptionId	path	True	string	Azure-prenumerationsidentifieraren.
api-version	query	True	string	API-version
validating	query		string	Den här parametern ignoreras och ska anges till en tom sträng.

Begärandetext

Name	Typ	Description
kind	ProjectResourceKind	Typ av projektresurs
location	string	Resursplats.
properties.bootstrapPipelineTemplate	PipelineTemplate	Mall som används för att konfigurera en bootstrap-pipeline i VSTS-projektet.
properties.ownerUpn	string	Valfritt UPN för ägaren, som projektet skapas för.
properties.processTemplateId	ProcessTemplate	Processmall som ska användas i projektet.
properties.versionControlOption	VersionControlOption	Versionskontroll som ska användas för standardlagringsplatsen som skapats i projektet.
tags	object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	ProjectResource	Åtgärden lyckades. Svaret innehåller information om den skapade eller uppdaterade gruppprojektresursen.
202 Accepted		Åtgärden lyckades. Ett jobb för att skapa gruppprojektresursen har placerats i kö. URI:n för att övervaka jobbets status anges i "location"-huvudet.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create a project resource

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/microsoft.visualstudio/account/ExampleAccount/project/ExampleProject?api-version=2017-11-01-preview

{
  "id": "/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/project/ExampleProject",
  "name": "ExampleProject",
  "type": "Microsoft.VisualStudio/account/project",
  "location": "Central US",
  "tags": {},
  "properties": {
    "processTemplateId": "Scrum",
    "versionControlOption": "Git",
    "bootstrapPipelineTemplate": {
      "applicationSource": {
        "sourceType": "CodeTemplate",
        "applicationType": "NodeJs",
        "applicationConfiguration": {
          "nodeJsVersion": "8.5.0"
        }
      },
      "applicationTarget": {
        "targetType": "WindowsAppService",
        "resources": [
          {
            "id": "/subscriptions/ea99dfc9-1597-48ed-85f6-9bf922591395/resourceGroups/testrg/providers/Microsoft.Web/sites/MyWebSite",
            "role": "AppService"
          }
        ]
      },
      "authorizationDetails": {
        "azure": {
          "authorizationType": "authorizationToken",
          "parameters": {
            "token": "AAD_Access_Token_For_VSTS_Resource"
          }
        }
      }
    }
  }
}

Exempelsvar

Statuskod:: 200

{
  "id": "/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/microsoft.visualstudio/account/ExampleAccount/project/ExampleProject",
  "name": "ExampleProject",
  "type": "microsoft.visualstudio/account/project",
  "location": "North Central US",
  "tags": {},
  "kind": "bootstrappedProject",
  "properties": {
    "processTemplateId": "Scrum",
    "versionControlOption": "Git",
    "tfsUniqueIdentifier": "vstfs:///Classification/TeamProject/7a4e6ba5-35bf-4667-86a4-9b598a88fa25",
    "bootstrapPipelineTemplate": {
      "applicationSource": {
        "sourceType": "CodeTemplate",
        "applicationType": "NodeJs",
        "applicationConfiguration": {
          "nodeJsVersion": "8.5.0"
        }
      },
      "applicationTarget": {
        "targetType": "WindowsAppService",
        "resources": [
          {
            "id": "/subscriptions/ea99dfc9-1597-48ed-85f6-9bf922591395/resourceGroups/testrg/providers/Microsoft.Web/sites/MyWebSite",
            "role": "AppService"
          }
        ]
      },
      "authorizationDetails": {}
    }
  }
}

Statuskod:: 202

location: https://management.azure.com/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/microsoft.visualstudio/account/ExampleAccount/project/ExampleProject/subContainers/ExampleProject/status/?api-version=2017-11-01-preview&jobId=126167d2-d710-4b5d-80a8-a1d58717142d&operation=put
retry-after: 5

Definitioner

Name	Description
ApplicationTarget	Definierar målresurserna för en VSTS-pipeline.
ApplicationTargetType	Typ av mål.
ApplicationType	Typ av program.
Authorization	Definierar auktoriseringstypen och dess parametrar.
AuthorizationType	Typ av auktorisering.
CodeRepository	Definierar en kodlagringsplats.
CodeRepositoryApplicationSource	Definierar källprogrammet när det finns i en kodlagringsplats.
CodeRepositoryType	Typ av kodlagringsplats.
CodeTemplateApplicationSource	Definierar källprogrammallen.
PipelineTemplate	Definierar en VSTS-pipelinemall.
ProcessTemplate	Processmall som ska användas i projektet.
ProjectResource	En Visual Studio Team Services-projektresurs.
ProjectResourceKind	Typ av projektresurs
TargetResource	Definierar en enskild resurs som används som mål för en VSTS-pipeline.
VersionControlOption	Versionskontroll som ska användas för standardlagringsplatsen som skapats i projektet.

ApplicationTarget

Definierar målresurserna för en VSTS-pipeline.

Name	Typ	Description
resources	TargetResource[]	Lista över målresurser.
targetType	ApplicationTargetType	Typ av mål.

ApplicationTargetType

Typ av mål.

Name	Typ	Description
WindowsAppService	string

ApplicationType

Typ av program.

Name	Typ	Description
AspDotNet	string
AspDotNetCore	string
NodeJs	string

Authorization

Definierar auktoriseringstypen och dess parametrar.

Name	Typ	Description
authorizationType	AuthorizationType	Typ av auktorisering.
parameters	object	Auktoriseringsparametrar som motsvarar auktoriseringstypen.

AuthorizationType

Typ av auktorisering.

Name	Typ	Description
authorizationToken	string
personalAccessToken	string

CodeRepository

Definierar en kodlagringsplats.

Name	Typ	Description
authorizationReference	string	Referens till den auktoriseringsinformation som används för att komma åt kodlagringsplatsen. Det här värdet används som en nyckel i ordlistan med global auktoriseringsinformation.
defaultBranch	string	Standardgren som kontinuerlig integrering ska konfigureras för i VSTS-pipelinen.
id	string	Unik identifierare för kodlagringsplatsen.
properties	object	Lagringsplatsspecifika egenskaper.
repositoryType	CodeRepositoryType	Typ av kodlagringsplats.

CodeRepositoryApplicationSource

Definierar källprogrammet när det finns i en kodlagringsplats.

Name	Typ	Description
applicationConfiguration	object	Programspecifika egenskaper.
applicationType	ApplicationType	Typ av program.
repository	CodeRepository	Kodlagringsplats där programkällan finns.
sourceType	string: CodeRepository	Typ av programkälla.

CodeRepositoryType

Typ av kodlagringsplats.

Name	Typ	Description
gitHub	string
vstsGit	string

CodeTemplateApplicationSource

Definierar källprogrammallen.

Name	Typ	Description
applicationConfiguration	object	Programspecifika egenskaper.
applicationType	ApplicationType	Typ av program.
sourceType	string: CodeTemplate	Typ av programkälla.

PipelineTemplate

Definierar en VSTS-pipelinemall.

Name	Typ	Description
applicationSource	ApplicationSource: CodeRepositoryApplicationSource CodeTemplateApplicationSource	Källprogram för VSTS-pipelinen.
applicationTarget	ApplicationTarget	Målresurser för VSTS-pipelinen.
authorizationDetails	<string, Authorization>	Global ordlista med auktoriseringsinformation som används av pipelinen, med ett eget namn som nyckel. Enskilda resurser i pipelinen kan referera till en specifik auktoriseringsinformation med hjälp av det egna namnet.

ProcessTemplate

Processmall som ska användas i projektet.

Name	Typ	Description
Agile	string
Cmmi	string
Scrum	string

ProjectResource

En Visual Studio Team Services-projektresurs.

Name	Typ	Description
id	string	Unik identifierare för resursen.
kind	ProjectResourceKind	Typ av projektresurs
location	string	Resursplats.
name	string	Resursnamn.
properties.bootstrapPipelineTemplate	PipelineTemplate	Mall som används för att konfigurera en bootstrap-pipeline i VSTS-projektet.
properties.ownerUpn	string	Valfritt UPN för ägaren, som projektet skapas för.
properties.processTemplateId	ProcessTemplate	Processmall som ska användas i projektet.
properties.tfsUniqueIdentifier	string	Unik identifierare för VSTS-projektet.
properties.versionControlOption	VersionControlOption	Versionskontroll som ska användas för standardlagringsplatsen som skapats i projektet.
tags	object	Resurstaggar.
type	string	Resurstyp.

ProjectResourceKind

Typ av projektresurs

Name	Typ	Description
bootstrappedProject	string
project	string

TargetResource

Definierar en enskild resurs som används som mål för en VSTS-pipeline.

Name	Typ	Description
authorizationReference	string	Referens till den auktoriseringsinformation som används för att komma åt målresursen. Det här värdet används som en nyckel i ordlistan med global auktoriseringsinformation.
id	string	Unik identifierare för målresursen.
role	string	Målresursens roll.

VersionControlOption

Versionskontroll som ska användas för standardlagringsplatsen som skapats i projektet.

Name	Typ	Description
Git	string
Tfvc	string

Dela via