Projects - Create

Odwołanie

Usługa:: Visual Studio

Wersja interfejsu API:: 2017-11-01-preview

Projects_Create
Tworzy projekt usługi Team Services w kolekcji o określonej nazwie. Wartości "VersionControlOption" i "ProcessTemplateId" muszą być określone we właściwościach zasobu. Prawidłowe wartości opcji VersionControlOption: Git, Tfvc. Prawidłowe wartości identyfikatora ProcessTemplateId: 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC, 27450541-8E31-4150-9947-DC59F998FC01 (te identyfikatory odpowiadają szablonom procesów Scrum, Agile i CMMI).

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji platformy Azure.
resourceName	path	True	string	Nazwa projektu usługi Team Services.
rootResourceName	path	True	string	Nazwa konta usługi Team Services.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure.
api-version	query	True	string	Wersja interfejsu API
validating	query		string	Ten parametr jest ignorowany i powinien być ustawiony na pusty ciąg.

Treść żądania

Nazwa	Typ	Opis
kind	ProjectResourceKind	Rodzaj zasobu projektu
location	string	Lokalizacja zasobu.
properties.bootstrapPipelineTemplate	PipelineTemplate	Szablon służący do konfigurowania potoku uruchamiania w projekcie usługi VSTS.
properties.ownerUpn	string	Opcjonalna nazwa UPN właściciela, w imieniu którego jest tworzony projekt.
properties.processTemplateId	ProcessTemplate	Szablon procesu używany w projekcie.
properties.versionControlOption	VersionControlOption	Kontrola wersji do użycia dla domyślnego repozytorium utworzonego w projekcie.
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ProjectResource	Operacja zakończyła się pomyślnie. Odpowiedź zawiera szczegóły utworzonego lub zaktualizowanego zasobu projektu zespołowego.
202 Accepted		Operacja zakończyła się pomyślnie. Zadanie tworzenia zasobu projektu zespołowego zostało utworzone w kolejce. Identyfikator URI do monitorowania stanu zadania jest udostępniany w nagłówku "location".

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create a project resource

Przykładowe żądanie

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"
          }
        }
      }
    }
  }
}

Przykładowa odpowiedź

Kod stanu:: 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": {}
    }
  }
}

Kod stanu:: 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

Definicje

Nazwa	Opis
ApplicationTarget	Definiuje zasoby docelowe dla potoku usługi VSTS.
ApplicationTargetType	Typ obiektu docelowego.
ApplicationType	Typ aplikacji.
Authorization	Definiuje typ autoryzacji i jego parametry.
AuthorizationType	Typ autoryzacji.
CodeRepository	Definiuje repozytorium kodu.
CodeRepositoryApplicationSource	Definiuje aplikację źródłową, gdy znajduje się w repozytorium kodu.
CodeRepositoryType	Typ repozytorium kodu.
CodeTemplateApplicationSource	Definiuje szablon aplikacji źródłowej.
PipelineTemplate	Definiuje szablon potoku usługi VSTS.
ProcessTemplate	Szablon procesu używany w projekcie.
ProjectResource	Zasób projektu Visual Studio Team Services.
ProjectResourceKind	Rodzaj zasobu projektu
TargetResource	Definiuje pojedynczy zasób używany jako element docelowy dla potoku usługi VSTS.
VersionControlOption	Kontrola wersji do użycia dla domyślnego repozytorium utworzonego w projekcie.

ApplicationTarget

Object

Definiuje zasoby docelowe dla potoku usługi VSTS.

Nazwa	Typ	Opis
resources	TargetResource[]	Lista zasobów docelowych.
targetType	ApplicationTargetType	Typ obiektu docelowego.

ApplicationTargetType

Enumeration

Typ obiektu docelowego.

Wartość	Opis
WindowsAppService

ApplicationType

Enumeration

Typ aplikacji.

Wartość	Opis
AspDotNet
AspDotNetCore
NodeJs

Authorization

Object

Definiuje typ autoryzacji i jego parametry.

Nazwa	Typ	Opis
authorizationType	AuthorizationType	Typ autoryzacji.
parameters	object	Parametry autoryzacji odpowiadające typowi autoryzacji.

AuthorizationType

Enumeration

Typ autoryzacji.

Wartość	Opis
authorizationToken
personalAccessToken

CodeRepository

Object

Definiuje repozytorium kodu.

Nazwa	Typ	Opis
authorizationReference	string	Odwołanie do informacji autoryzacji używanych do uzyskiwania dostępu do repozytorium kodu. Ta wartość jest używana jako klucz do słownika szczegółów autoryzacji globalnej.
defaultBranch	string	Domyślna gałąź, dla której należy skonfigurować ciągłą integrację w potoku usługi VSTS.
id	string	Unikatowy identyfikator repozytorium kodu.
properties	object	Właściwości specyficzne dla repozytorium.
repositoryType	CodeRepositoryType	Typ repozytorium kodu.

CodeRepositoryApplicationSource

Object

Definiuje aplikację źródłową, gdy znajduje się w repozytorium kodu.

Nazwa	Typ	Opis
applicationConfiguration	object	Właściwości specyficzne dla aplikacji.
applicationType	ApplicationType	Typ aplikacji.
repository	CodeRepository	Repozytorium kodu, w którym znajduje się źródło aplikacji.
sourceType	string: CodeRepository	Typ źródła aplikacji.

CodeRepositoryType

Enumeration

Typ repozytorium kodu.

Wartość	Opis
gitHub
vstsGit

CodeTemplateApplicationSource

Object

Definiuje szablon aplikacji źródłowej.

Nazwa	Typ	Opis
applicationConfiguration	object	Właściwości specyficzne dla aplikacji.
applicationType	ApplicationType	Typ aplikacji.
sourceType	string: CodeTemplate	Typ źródła aplikacji.

PipelineTemplate

Object

Definiuje szablon potoku usługi VSTS.

Nazwa	Typ	Opis
applicationSource	ApplicationSource: CodeRepositoryApplicationSource CodeTemplateApplicationSource	Aplikacja źródłowa dla potoku usługi VSTS.
applicationTarget	ApplicationTarget	Docelowe zasoby dla potoku usługi VSTS.
authorizationDetails	<string, Authorization>	Globalny słownik szczegółów autoryzacji używanych przez potok z przyjazną nazwą jako kluczem. Pojedynczy zasób w potoku może odwoływać się do określonych informacji autoryzacji przy użyciu przyjaznej nazwy.

ProcessTemplate

Enumeration

Szablon procesu używany w projekcie.

Wartość	Opis
Agile
Cmmi
Scrum

ProjectResource

Object

Zasób projektu Visual Studio Team Services.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu.
kind	ProjectResourceKind	Rodzaj zasobu projektu
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.bootstrapPipelineTemplate	PipelineTemplate	Szablon służący do konfigurowania potoku uruchamiania w projekcie usługi VSTS.
properties.ownerUpn	string	Opcjonalna nazwa UPN właściciela, w imieniu którego jest tworzony projekt.
properties.processTemplateId	ProcessTemplate	Szablon procesu używany w projekcie.
properties.tfsUniqueIdentifier	string	Unikatowy identyfikator projektu usługi VSTS.
properties.versionControlOption	VersionControlOption	Kontrola wersji do użycia dla domyślnego repozytorium utworzonego w projekcie.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

ProjectResourceKind

Enumeration

Rodzaj zasobu projektu

Wartość	Opis
bootstrappedProject
project

TargetResource

Object

Definiuje pojedynczy zasób używany jako element docelowy dla potoku usługi VSTS.

Nazwa	Typ	Opis
authorizationReference	string	Odwołanie do informacji autoryzacji używanych do uzyskiwania dostępu do zasobu docelowego. Ta wartość jest używana jako klucz do słownika szczegółów autoryzacji globalnej.
id	string	Unikatowy identyfikator zasobu docelowego.
role	string	Rola zasobu docelowego.

VersionControlOption

Enumeration

Kontrola wersji do użycia dla domyślnego repozytorium utworzonego w projekcie.

Wartość	Opis
Git
Tfvc

Udostępnij za pośrednictwem

Projects - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Create a project resource

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ApplicationTarget

ApplicationTargetType

ApplicationType

Authorization

AuthorizationType

CodeRepository

CodeRepositoryApplicationSource

CodeRepositoryType

CodeTemplateApplicationSource

PipelineTemplate

ProcessTemplate

ProjectResource

ProjectResourceKind

TargetResource

VersionControlOption

Dodatkowe zasoby