ReleaseRestClient class
VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf
- Extends
Oluşturucular
| Release |
Özellikler
| RESOURCE_AREA_ID |
Yöntemler
Oluşturucu Ayrıntıları
ReleaseRestClient(IVssRestClientOptions)
Özellik Ayrıntıları
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
Özellik Değeri
string
Yöntem Ayrıntıları
addDefinitionTag(string, number, string)
Tanıma etiket ekler
function addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseDefinitionId
-
number
- tag
-
string
Döndürülenler
Promise<string[]>
addDefinitionTags(string[], string, number)
Tanıma birden çok etiket ekler
function addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>
Parametreler
- tags
-
string[]
- project
-
string
Proje kimliği veya proje adı
- releaseDefinitionId
-
number
Döndürülenler
Promise<string[]>
addReleaseTag(string, number, string)
releaseId'ye etiket ekler
function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
- tag
-
string
Döndürülenler
Promise<string[]>
addReleaseTags(string[], string, number)
Yayına etiket ekler
function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>
Parametreler
- tags
-
string[]
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Döndürülenler
Promise<string[]>
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)
Tanım ortamı şablonu oluşturur
function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>
Parametreler
- template
- ReleaseDefinitionEnvironmentTemplate
Oluşturulacak tanım ortamı şablonu
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ReleaseDefinitionEnvironmentTemplate>
createFavorites(FavoriteItem[], string, string, string)
function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>
Parametreler
- favoriteItems
- project
-
string
Proje kimliği veya proje adı
- scope
-
string
- identityId
-
string
Döndürülenler
Promise<FavoriteItem[]>
createFolder(Folder, string, string)
createRelease(ReleaseStartMetadata, string)
Bir sürüm oluşturun.
function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>
Parametreler
- releaseStartMetadata
- ReleaseStartMetadata
Yayın oluşturmak için meta veriler.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<Release>
createReleaseDefinition(ReleaseDefinition, string)
Yayın tanımı oluşturma
function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>
Parametreler
- releaseDefinition
- ReleaseDefinition
oluşturulacak release definition nesnesi.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ReleaseDefinition>
deleteDefinitionEnvironmentTemplate(string, string)
Tanım ortamı şablonunu silme
function deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- templateId
-
string
Tanım ortamı şablonunun kimliği
Döndürülenler
Promise<void>
deleteDefinitionTag(string, number, string)
Tanımdan etiket siler
function deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseDefinitionId
-
number
- tag
-
string
Döndürülenler
Promise<string[]>
deleteFavorites(string, string, string, string)
function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- scope
-
string
- identityId
-
string
- favoriteItemIds
-
string
Döndürülenler
Promise<void>
deleteFolder(string, string)
Belirli bir klasör adı ve yolu için bir tanım klasörünü ve tüm mevcut tanımlarını siler.
function deleteFolder(project: string, path: string): Promise<void>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- path
-
string
Silinecek klasörün yolu.
Döndürülenler
Promise<void>
deleteRelease(string, number, string)
Sürümü geçici silme
function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- comment
-
string
Bir sürümü silmeye yönelik açıklama.
Döndürülenler
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
Yayın tanımını silin.
function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Yayın tanımının kimliği.
- comment
-
string
Yayın tanımını silmeye yönelik açıklama.
- forceDelete
-
boolean
Devam eden tüm yayın dağıtımlarını otomatik olarak iptal etmek ve yayın tanımı silme işlemine devam etmek için 'true'. Varsayılan değer 'false'tur.
Döndürülenler
Promise<void>
deleteReleaseTag(string, number, string)
Yayından etiket siler
function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
- tag
-
string
Döndürülenler
Promise<string[]>
getAgentArtifactDefinitions(string, number)
Otomasyon aracısının gerektirdiği yapıt ayrıntılarını döndürür
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Döndürülenler
Promise<AgentArtifactDefinition[]>
getApproval(string, number, boolean)
Onay alın.
function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- approvalId
-
number
Onay kimliği.
- includeHistory
-
boolean
Onay geçmişini eklemek için 'true'. Varsayılan değer 'false'tur.
Döndürülenler
Promise<ReleaseApproval>
getApprovalHistory(string, number)
Onay geçmişini alın.
function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- approvalStepId
-
number
Onay kimliği.
Döndürülenler
Promise<ReleaseApproval>
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)
Onayların listesini alma
function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- assignedToFilter
-
string
Bu kullanıcıya atanan onaylar.
- statusFilter
- ApprovalStatus
Bu duruma sahip onaylar. Varsayılan değer 'beklemede'dir.
- releaseIdsFilter
-
number[]
Filtrede belirtilen sürüm kimlikleri için onaylar. ',' ile ayrılarak birden çok sürümden bahsedilebilir; örneğin releaseIdsFilter=1,2,3,4.
- typeFilter
- ApprovalType
Bu tür onay.
- top
-
number
Alınacak onay sayısı. Varsayılan değer 50'dir.
- continuationToken
-
number
Sağlanan devamlılık belirtecinin ardından onayları alır.
- queryOrder
- ReleaseQueryOrder
Sonuçları, oluşturulan onayların tanımlı sırasına göre alır. Varsayılan değer 'azalan'dır.
- includeMyGroupApprovals
-
boolean
Grup onaylarımı dahil etmek için 'true'. Varsayılan değer 'false'tur.
Döndürülenler
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ArtifactTypeDefinition[]>
getArtifactVersions(string, number)
function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseDefinitionId
-
number
Döndürülenler
Promise<ArtifactVersionQueryResult>
getArtifactVersionsForSources(Artifact[], string)
function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>
Parametreler
- artifacts
-
Artifact[]
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ArtifactVersionQueryResult>
getAutoTriggerIssues(string, string, string, string)
function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>
Parametreler
- artifactType
-
string
- sourceId
-
string
- artifactVersionId
-
string
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<AutoTriggerIssue[]>
getDefinitionEnvironments(string, string, string[])
function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- taskGroupId
-
string
- propertyFilters
-
string[]
Döndürülenler
Promise<DefinitionEnvironmentReference[]>
getDefinitionEnvironmentTemplate(string, string)
Tanım ortamı şablonu alır
function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- templateId
-
string
Tanım ortamı şablonunun kimliği
Döndürülenler
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
Belirli bir definitionId ve düzeltme için yayın tanımını alma
function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Tanımın kimliği.
- revision
-
number
Düzeltmenin kimliği.
Döndürülenler
Promise<string>
getDefinitionTags(string, number)
Tanımın etiketlerini alır
function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseDefinitionId
-
number
Döndürülenler
Promise<string[]>
getDeploymentBadge(string, number, number, string)
Bir ortam için en son dağıtımın durumunu gösteren bir rozet alır.
function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>
Parametreler
- projectId
-
string
Projenin kimliği.
- releaseDefinitionId
-
number
Yayın Tanımının Kimliği.
- environmentId
-
number
Ortamın Kimliği.
- branchName
-
string
Dalın adı.
Döndürülenler
Promise<string>
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)
Dağıtımların listesini alma
function getDeployments(project: string, definitionId?: number, definitionEnvironmentId?: number, createdBy?: string, minModifiedTime?: Date, maxModifiedTime?: Date, deploymentStatus?: DeploymentStatus, operationStatus?: DeploymentOperationStatus, latestAttemptsOnly?: boolean, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, createdFor?: string, minStartedTime?: Date, maxStartedTime?: Date, sourceBranch?: string): Promise<PagedList<Deployment>>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Belirli bir tanım kimliği için dağıtımları listeleyin.
- definitionEnvironmentId
-
number
Belirli bir tanım ortamı kimliği için dağıtımları listeleyin.
- createdBy
-
string
Dağıtımların oluşturulduğu dağıtımları belirtilen kimlik olarak listeleyin.
- minModifiedTime
-
Date
LastModified time >= minModifiedTime ile dağıtımları listeleyin.
- maxModifiedTime
-
Date
LastModified time <= maxModifiedTime ile dağıtımları listeleyin.
- deploymentStatus
- DeploymentStatus
Verilen dağıtım durumuna sahip dağıtımları listeleyin. Varsayılan değer 'Tümü'dür.
- operationStatus
- DeploymentOperationStatus
Verilen işlem durumuna sahip dağıtımları listeleyin. Varsayılan değer 'Tümü'dür.
- latestAttemptsOnly
-
boolean
Yalnızca en son denemeye sahip dağıtımları dahil etmek için 'true'. Varsayılan değer 'false'tur.
- queryOrder
- ReleaseQueryOrder
Verilen sorgu sırasına sahip dağıtımları listeleyin. Varsayılan değer 'Azalan'dır.
- top
-
number
Verilen üstteki dağıtımları listeleyin. Varsayılan üst '50' ve Maksimum üst ise '100' şeklindedir.
- continuationToken
-
number
Dağıtım kimliği >= continuationToken ile dağıtımları listeleyin.
- createdFor
-
string
Dağıtımların istendiği dağıtımları kimlik olarak listeleyin.
- minStartedTime
-
Date
StartedOn time >= minStartedTime ile dağıtımları listeleyin.
- maxStartedTime
-
Date
StartedOn time <= maxStartedTime ile dağıtımları listeleyin.
- sourceBranch
-
string
Verilen dal adından dağıtılan dağıtımları listeleyin.
Döndürülenler
Promise<PagedList<Deployment>>
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>
Parametreler
- queryParameters
- DeploymentQueryParameters
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<Deployment[]>
getFavorites(string, string, string)
function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- scope
-
string
- identityId
-
string
Döndürülenler
Promise<FavoriteItem[]>
getFolders(string, string, FolderPathQueryOrder)
Klasörleri alır.
function getFolders(project: string, path?: string, queryOrder?: FolderPathQueryOrder): Promise<Folder[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- path
-
string
Klasörün yolu.
- queryOrder
- FolderPathQueryOrder
Sonuçları tanımlı sırada alır. Varsayılan değer :'Yok'.
Döndürülenler
Promise<Folder[]>
getGateLog(string, number, number, number, number)
Geçit günlüklerini alır
function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- gateId
-
number
Geçidin kimliği.
- taskId
-
number
Günlük için ReleaseTask Kimliği.
Döndürülenler
Promise<string>
getInputValues(InputValuesQuery, string)
function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>
Parametreler
- query
- InputValuesQuery
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<InputValuesQuery>
getIssues(string, number, string)
function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- buildId
-
number
- sourceId
-
string
Döndürülenler
Promise<AutoTriggerIssue[]>
getLog(string, number, number, number, number)
Günlükleri alır
function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- taskId
-
number
Günlük için ReleaseTask Kimliği.
- attemptId
-
number
Girişimin kimliği.
Döndürülenler
Promise<string>
getLogs(string, number)
Yayın kimliği için günlükleri alın.
function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
Döndürülenler
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
Belirli bir sürüm ve el ile müdahale kimliği için el ile müdahale alın.
function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- manualInterventionId
-
number
El ile müdahalenin kimliği.
Döndürülenler
Promise<ManualIntervention>
getManualInterventions(string, number)
Belirli bir sürüm için tüm el ile müdahaleleri listeleyin.
function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
Döndürülenler
Promise<ManualIntervention[]>
getMetrics(string, Date)
function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- minMetricsTime
-
Date
Döndürülenler
Promise<Metric[]>
getOrgPipelineReleaseSettings()
Kuruluş işlem hattı yayın ayarlarını alır
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>
Döndürülenler
Promise<OrgPipelineReleaseSettings>
getPipelineReleaseSettings(string)
İşlem hattı sürüm ayarlarını alır
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>
Parametreler
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ProjectPipelineReleaseSettings>
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number, boolean)
Yayın Alma
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number, includeDisabledDefinitions?: boolean): Promise<Release>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- approvalFilters
- ApprovalFilters
Onay adımlarının otomatik veya el ile olmasına bağlı olarak seçmeli olarak getirilebilmesini sağlayan bir filtre. Bu, onay öncesi anlık görüntülerini alıp göndermememizi de karar verir. Varsayılan olarak Tümünü Varsayar
- propertyFilters
-
string[]
Alınacak genişletilmiş özelliklerin virgülle ayrılmış listesi. Ayarlanırsa, döndürülen Sürüm belirtilen özellik kimlikleri (varsa) için değerler içerir. Ayarlanmadıysa, özellikler dahil edilmeyecektir.
- expand
- SingleReleaseExpands
Yayında genişletilmesi gereken bir özellik.
- topGateRecords
-
number
Alınacak yayın geçidi kayıtlarının sayısı. Varsayılan değer 5'tir.
- includeDisabledDefinitions
-
boolean
Devre dışı bırakılmış tanımları dahil et ('false' olarak ayarlanırsa hata döndürür, varsayılan değer 'true')
Döndürülenler
Promise<Release>
getReleaseChanges(string, number, number, number, string)
function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Döndürülenler
Promise<Change[]>
getReleaseDefinition(string, number, string[], boolean)
Yayın tanımını alın.
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[], includeDisabled?: boolean): Promise<ReleaseDefinition>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Yayın tanımının kimliği.
- propertyFilters
-
string[]
Alınacak genişletilmiş özelliklerin virgülle ayrılmış listesi. Ayarlanırsa, döndürülen Yayın Tanımı belirtilen özellik kimlikleri (varsa) için değerler içerir. Ayarlanmadıysa, özellikler dahil edilmeyecektir.
- includeDisabled
-
boolean
Devre dışı bırakılmış tanımları eklemek için Boole bayrağı.
Döndürülenler
Promise<ReleaseDefinition>
getReleaseDefinitionHistory(string, number)
Yayın tanımı için düzeltme geçmişini alma
function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Tanımın kimliği.
Döndürülenler
Promise<ReleaseDefinitionRevision[]>
getReleaseDefinitionRevision(string, number, number)
Belirli bir düzeltmenin yayın tanımını alın.
function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Yayın tanımının kimliği.
- revision
-
number
Yayın tanımının düzeltme numarası.
Döndürülenler
Promise<string>
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)
Yayın tanımlarının listesini alın.
function getReleaseDefinitions(project: string, searchText?: string, expand?: ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean, searchTextContainsFolderName?: boolean): Promise<PagedList<ReleaseDefinition>>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- searchText
-
string
searchText içeren adlara sahip yayın tanımlarını alın.
- expand
- ReleaseDefinitionExpands
Yayın tanımları listesinde genişletilmesi gereken özellikler.
- artifactType
-
string
Verilen artifactType ile yayın tanımları döndürülür. Değerler Build, Jenkins, GitHub, Nuget, Team Build (dış), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild olabilir.
- artifactSourceId
-
string
Verilen artifactSourceId ile yayın tanımları döndürülür. Örneğin derleme için {projectGuid}:{BuildDefinitionId}, Jenkins için {JenkinsConnectionId}:{JenkinsDefinitionId}, TfsOnPrem için {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId} olabilir. TeamCity, BitBucket gibi üçüncü taraf yapıtlar için https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsvss-extension.json içinde 'uniqueSourceIdentifier'a başvurabilirsiniz.
- top
-
number
Alınacak yayın tanımlarının sayısı.
- continuationToken
-
string
Sağlanan devamlılık belirtecinin ardından yayın tanımlarını alır.
- queryOrder
- ReleaseDefinitionQueryOrder
Sonuçları tanımlı sırada alır. Varsayılan değer :'IdAscending'.
- path
-
string
Belirtilen yolun altındaki yayın tanımlarını alır.
- isExactNameMatch
-
boolean
searchText'te belirtilen tam eşleşmeye sahip yayın tanımlarını almak için 'true'. Varsayılan değer 'false'tur.
- tagFilter
-
string[]
Virgülle ayrılmış etiketler listesi. Yalnızca bu etiketlere sahip yayın tanımları döndürülür.
- propertyFilters
-
string[]
Alınacak genişletilmiş özelliklerin virgülle ayrılmış listesi. Ayarlanırsa, döndürülen Yayın Tanımları belirtilen özellik kimlikleri (varsa) için değerler içerir. Ayarlanmadıysa, özellikler dahil edilmeyecektir. Bunun, özellik kümesi olup olmadığına bakılmaksızın sonuçlardan herhangi bir Yayın Tanımını filtrelemeyeceğini unutmayın.
- definitionIdFilter
-
string[]
Alınacak yayın tanımlarının virgülle ayrılmış listesi.
- isDeleted
-
boolean
Silinmiş sürüm tanımlarını almak için 'true'. Varsayılan değer 'false'
- searchTextContainsFolderName
-
boolean
SearchText'te belirtilen adlı klasörün altında yayın tanımlarını almak için 'true'. Varsayılan değer 'false'tur.
Döndürülenler
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
Belirli bir tanım kimliğinin yayın özetini alın.
function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Yayın özetini almak için tanımın kimliği.
- releaseCount
-
number
Özete eklenecek yayınların sayısı.
- includeArtifact
-
boolean
Yapıt ayrıntılarını ekleyin. Varsayılan değer 'false'tur.
- definitionEnvironmentIdsFilter
-
number[]
Döndürülenler
Promise<ReleaseDefinitionSummary>
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)
Bir yayın ortamı edinin.
function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- expand
- ReleaseEnvironmentExpands
Ortamda genişletilmesi gereken bir özellik.
Döndürülenler
Promise<ReleaseEnvironment>
getReleaseHistory(string, number)
function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Döndürülenler
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>
Parametreler
- artifactType
-
string
- artifactSourceId
-
string
Döndürülenler
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
Belirli bir düzeltme numarasının yayınını alın.
function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- definitionSnapshotRevision
-
number
Tanım anlık görüntüsü düzeltme numarası.
Döndürülenler
Promise<string>
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)
Yayınların listesini alma
function getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<Release[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Bu yayın tanımı kimliğinden yayınlar.
- definitionEnvironmentId
-
number
- searchText
-
string
searchText içeren adlarla yayınlar.
- createdBy
-
string
Bu kullanıcı tarafından oluşturulan sürümler.
- statusFilter
- ReleaseStatus
Bu duruma sahip sürümler.
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
Bu süreden sonra oluşturulan sürümler.
- maxCreatedTime
-
Date
Bu saatten önce oluşturulan sürümler.
- queryOrder
- ReleaseQueryOrder
Sonuçları, sürümler için oluşturulan tarihin tanımlı sırasına göre alır. Varsayılan değer azalandır.
- top
-
number
Alınacak sürüm sayısı. Varsayılan değer 50'dir.
- continuationToken
-
number
Sağlanan devamlılık belirtecinin ardından sürümleri alır.
- expand
- ReleaseExpands
Yayın listesinde genişletilmesi gereken özellik.
- artifactTypeId
-
string
Verilen artifactTypeId içeren sürümler döndürülür. Değerler Build, Jenkins, GitHub, Nuget, Team Build (dış), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild olabilir.
- sourceId
-
string
Kullanılan yapıtın benzersiz tanımlayıcısı. Örneğin derleme için {projectGuid}:{BuildDefinitionId}, Jenkins için {JenkinsConnectionId}:{JenkinsDefinitionId}, TfsOnPrem için {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId} olabilir. TeamCity, BitBucket gibi üçüncü taraf yapıtlar için vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensionsiçinde 'uniqueSourceIdentifier' öğesine başvurabilirsiniz.
- artifactVersionId
-
string
Verilen artifactVersionId içeren sürümler döndürülür. Örneğin Build artifactType olması durumunda buildId değeridir.
- sourceBranchFilter
-
string
Verilen sourceBranchFilter'a sahip sürümler döndürülür (environmentStatusFilter ile kullanılmaz).
- isDeleted
-
boolean
Doğruysa geçici olarak silinen sürümleri alır.
- tagFilter
-
string[]
Virgülle ayrılmış etiketler listesi. Yalnızca bu etiketlere sahip sürümler döndürülür.
- propertyFilters
-
string[]
Alınacak genişletilmiş özelliklerin virgülle ayrılmış listesi. Ayarlanırsa, döndürülen Sürümler belirtilen özellik kimlikleri (varsa) için değerler içerir. Ayarlanmadıysa, özellikler dahil edilmeyecektir. Bunun, özellik kümesi olup olmadığına bakılmaksızın sonuçlardan herhangi bir Yayın'ı filtrelemeyeceğini unutmayın.
- releaseIdFilter
-
number[]
Yayın kimliklerinin virgülle ayrılmış listesi. Yalnızca bu kimliklere sahip sürümler döndürülür.
- path
-
string
Bu klasör yolu altındaki sürümler döndürülür
Döndürülenler
Promise<Release[]>
getReleaseSettings(string)
Sürüm ayarlarını alır
function getReleaseSettings(project: string): Promise<ReleaseSettings>
Parametreler
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ReleaseSettings>
getReleaseTags(string, number)
Bir sürümün etiketlerini alır
function getReleaseTags(project: string, releaseId: number): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Döndürülenler
Promise<string[]>
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)
Bir yayın görevi eki alın.
function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- attemptId
-
number
Dağıtım denemesi sayısı.
- planId
-
string
Dağıtım aşamasının Plan Kimliği.
- timelineId
-
string
Görevin Zaman Çizelgesi Kimliği.
- recordId
-
string
Ekin kayıt kimliği.
- type
-
string
Ekin türü.
- name
-
string
Ekin adı.
Döndürülenler
Promise<ArrayBuffer>
getReleaseTaskAttachments(string, number, number, number, string, string)
Yayın görevi eklerini alın.
function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- attemptId
-
number
Dağıtım denemesi sayısı.
- planId
-
string
Dağıtım aşamasının Plan Kimliği.
- type
-
string
Ekin türü.
Döndürülenler
Promise<ReleaseTaskAttachment[]>
getReleaseWorkItemsRefs(string, number, number, number, string)
function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
Döndürülenler
Promise<ReleaseWorkItemRef[]>
getSourceBranches(string, number)
function getSourceBranches(project: string, definitionId: number): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Döndürülenler
Promise<string[]>
getSummaryMailSections(string, number)
function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Döndürülenler
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<string[]>
getTaskAttachmentContent(string, number, number, number, string, string, string, string)
Görev eki alma.
function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- attemptId
-
number
Dağıtım denemesi sayısı.
- timelineId
-
string
Görevin Zaman Çizelgesi Kimliği.
- recordId
-
string
Ekin kayıt kimliği.
- type
-
string
Ekin türü.
- name
-
string
Ekin adı.
Döndürülenler
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
Görev eklerini alın.
function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- attemptId
-
number
Dağıtım denemesi sayısı.
- timelineId
-
string
Görevin Zaman Çizelgesi Kimliği.
- type
-
string
Ekin türü.
Döndürülenler
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
Yayının görev günlüğünü düz metin dosyası olarak alır.
function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- releaseDeployPhaseId
-
number
Yayın dağıtım aşaması kimliği.
- taskId
-
number
Günlük için ReleaseTask Kimliği.
- startLine
-
number
Günlükler için başlangıç satırı numarası
- endLine
-
number
Günlükler için bitiş satırı numarası
Döndürülenler
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
Yayının görev günlüğünü düz metin dosyası olarak alır.
function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
- attemptId
-
number
- timelineId
-
string
- taskId
-
number
Günlük için ReleaseTask Kimliği.
- startLine
-
number
Günlükler için başlangıç satırı numarası
- endLine
-
number
Günlükler için bitiş satırı numarası
Döndürülenler
Promise<string>
getTasks(string, number, number, number)
function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
Döndürülenler
Promise<ReleaseTask[]>
getTasks2(string, number, number, number, string)
function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
- timelineId
-
string
Döndürülenler
Promise<ReleaseTask[]>
getTasksForTaskGroup(string, number, number, number)
function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
- environmentId
-
number
- releaseDeployPhaseId
-
number
Döndürülenler
Promise<ReleaseTask[]>
listDefinitionEnvironmentTemplates(string, boolean)
Tanım ortamı şablonlarının listesini alır
function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- isDeleted
-
boolean
Silinmiş olan tanım ortamı şablonlarını almak için 'true'. Varsayılan değer 'false'
Döndürülenler
Promise<ReleaseDefinitionEnvironmentTemplate[]>
sendSummaryMail(MailMessage, string, number)
function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>
Parametreler
- mailMessage
- MailMessage
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Döndürülenler
Promise<void>
undeleteRelease(string, number, string)
Geçici olarak silinen bir sürümü geri kaldırın.
function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Silinecek yayın kimliği.
- comment
-
string
Geri alma için herhangi bir açıklama.
Döndürülenler
Promise<void>
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)
Yayın tanımını geri alın.
function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>
Parametreler
- releaseDefinitionUndeleteParameter
- ReleaseDefinitionUndeleteParameter
Sürüm tanımını geri kaldırma nesnesi.
- project
-
string
Proje kimliği veya proje adı
- definitionId
-
number
Kaldırılacak yayın tanımının kimliği
Döndürülenler
Promise<ReleaseDefinition>
undeleteReleaseDefinitionEnvironmentTemplate(string, string)
Yayın tanımı ortam şablonunun geri alın.
function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>
Parametreler
- project
-
string
Proje kimliği veya proje adı
- templateId
-
string
Tanım ortamı şablonunun silinecek kimliği
Döndürülenler
Promise<ReleaseDefinitionEnvironmentTemplate>
updateFolder(Folder, string, string)
Belirtilen mevcut yolda var olan bir klasörü güncelleştirir.
function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>
Parametreler
- folder
- Folder
klasör.
- project
-
string
Proje kimliği veya proje adı
- path
-
string
Güncelleştirilecek klasörün yolu.
Döndürülenler
Promise<Folder>
updateGates(GateUpdateMetadata, string, number)
Dağıtım için geçidi güncelleştirir.
function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>
Parametreler
- gateUpdateMetadata
- GateUpdateMetadata
Yayın Geçitlerine düzeltme eki uygulamak için meta veriler.
- project
-
string
Proje kimliği veya proje adı
- gateStepId
-
number
Kapı adımı kimliği.
Döndürülenler
Promise<ReleaseGates>
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)
El ile müdahaleyi güncelleştirin.
function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>
Parametreler
- manualInterventionUpdateMetadata
- ManualInterventionUpdateMetadata
El ile müdahaleyi güncelleştirmek için meta veriler.
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- manualInterventionId
-
number
El ile müdahalenin kimliği.
Döndürülenler
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
Kuruluş işlem hattı yayın ayarlarını güncelleştirir
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>
Parametreler
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
Döndürülenler
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
İşlem hattı yayın ayarlarını güncelleştirir
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>
Parametreler
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ProjectPipelineReleaseSettings>
updateRelease(Release, string, number)
Tam sürüm nesnesini güncelleştirin.
function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>
Parametreler
- release
- Release
Güncelleştirme için yayın nesnesi.
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Güncelleştirilecek sürümün kimliği.
Döndürülenler
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
Onay durumunu güncelleştirme
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>
Parametreler
- approval
- ReleaseApproval
Durum, onaylayan ve açıklamalara sahip ReleaseApproval nesnesi.
- project
-
string
Proje kimliği veya proje adı
- approvalId
-
number
Onay kimliği.
Döndürülenler
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>
Parametreler
- approvals
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ReleaseApproval[]>
updateReleaseDefinition(ReleaseDefinition, string, boolean)
Yayın tanımını güncelleştirme.
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string, skipTasksValidation?: boolean): Promise<ReleaseDefinition>
Parametreler
- releaseDefinition
- ReleaseDefinition
Güncelleştirilecek sürüm tanımı nesnesi.
- project
-
string
Proje kimliği veya proje adı
- skipTasksValidation
-
boolean
Görev doğrulama boole bayrağını atla
Döndürülenler
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
Yayın ortamının durumunu güncelleştirme
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>
Parametreler
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
Ortam güncelleştirme meta verileri.
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Yayının kimliği.
- environmentId
-
number
Yayın ortamının kimliği.
Döndürülenler
Promise<ReleaseEnvironment>
updateReleaseResource(ReleaseUpdateMetadata, string, number)
Bir sürümün birkaç özelliğini güncelleştirin.
function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>
Parametreler
- releaseUpdateMetadata
- ReleaseUpdateMetadata
Güncelleştirilecek sürümün özellikleri.
- project
-
string
Proje kimliği veya proje adı
- releaseId
-
number
Güncelleştirilecek sürümün kimliği.
Döndürülenler
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
Sürüm ayarlarını güncelleştirir
function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>
Parametreler
- releaseSettings
- ReleaseSettings
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<ReleaseSettings>