Project Catalogs - Patch

서비스:
Dev Center
API 버전:
2024-02-01

프로젝트 카탈로그를 부분적으로 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}?api-version=2024-02-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
catalogName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$

카탈로그의 이름입니다.
projectName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$

프로젝트의 이름입니다.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId
 path True

string

minLength: 1

대상 구독의 ID입니다.
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.

요청 본문

Name 형식 Description
properties.adoGit

GitCatalog

Azure DevOps 카탈로그 형식의 속성입니다.
properties.gitHub

GitCatalog

GitHub 카탈로그 형식의 속성입니다.
properties.syncType

CatalogSyncType

카탈로그에 대해 구성된 동기화 유형을 나타냅니다.
properties.tags

object

리소스 태그.

응답

Name 형식 Description
200 OK

Catalog

리소스가 업데이트되었습니다.
202 Accepted

요청이 비동기적으로 완료됩니다.

헤더

Location: string
Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ProjectCatalogs_Patch

샘플 요청

PATCH https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog?api-version=2024-02-01

{
  "properties": {
    "gitHub": {
      "path": "/environments"
    }
  }
}

샘플 응답

상태 코드:
200 
{
  "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog",
  "name": "CentralCatalog",
  "type": "Microsoft.DevCenter/projects/catalogs",
  "properties": {
    "gitHub": {
      "uri": "https://github.com/Contoso/centralrepo-fake.git",
      "branch": "main",
      "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat",
      "path": "/environments"
    },
    "lastSyncStats": {
      "added": 1,
      "updated": 1,
      "unchanged": 1,
      "removed": 1,
      "validationErrors": 1,
      "synchronizationErrors": 1
    },
    "lastConnectionTime": "2020-11-18T18:28:00.314Z",
    "lastSyncTime": "2020-11-18T18:28:00.314Z",
    "provisioningState": "Succeeded",
    "connectionState": "Connected",
    "syncState": "Succeeded"
  },
  "systemData": {
    "createdBy": "User1",
    "createdByType": "User",
    "createdAt": "2020-11-18T18:24:24.818Z",
    "lastModifiedBy": "User1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-11-18T18:24:24.818Z"
  }
}
상태 코드:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview

정의

Name Description
Catalog

카탈로그를 나타냅니다.
CatalogConnectionState

카탈로그의 연결 상태입니다.
CatalogItemType

카탈로그 항목 유형을 나타냅니다.
CatalogSyncState

카탈로그의 동기화 상태입니다.
CatalogSyncType

카탈로그에 대해 구성된 동기화 유형을 나타냅니다.
CatalogUpdate

부분 업데이트에 대한 카탈로그의 속성입니다. 업데이트 요청에 제공되지 않는 속성은 변경되지 않습니다.
createdByType

리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
ErrorDetail

오류 세부 정보입니다.
ErrorResponse

오류 응답
GitCatalog

Git 리포지토리 카탈로그의 속성입니다.
ProvisioningState

리소스의 프로비전 상태입니다.
SyncStats

동기화의 통계입니다.
systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Catalog

Object

카탈로그를 나타냅니다.

Name 형식 Description
id

string (arm-id)

리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

리소스의 이름
properties.adoGit

GitCatalog

Azure DevOps 카탈로그 형식의 속성입니다.
properties.connectionState

CatalogConnectionState

카탈로그의 연결 상태입니다.
properties.gitHub

GitCatalog

GitHub 카탈로그 형식의 속성입니다.
properties.lastConnectionTime

string (date-time)

카탈로그가 마지막으로 연결되었을 때입니다.
properties.lastSyncStats

SyncStats

최신 동기화의 통계입니다.
properties.lastSyncTime

string (date-time)

카탈로그가 마지막으로 동기화된 경우입니다.
properties.provisioningState

ProvisioningState

리소스의 프로비전 상태입니다.
properties.syncState

CatalogSyncState

카탈로그의 동기화 상태입니다.
properties.syncType

CatalogSyncType

카탈로그에 대해 구성된 동기화 유형을 나타냅니다.
properties.tags

object

리소스 태그.
systemData

systemData

createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type

string

리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

CatalogConnectionState

열거형

카탈로그의 연결 상태입니다.

값 Description
Connected
Disconnected

CatalogItemType

열거형

카탈로그 항목 유형을 나타냅니다.

값 Description
EnvironmentDefinition

CatalogSyncState

열거형

카탈로그의 동기화 상태입니다.

값 Description
Succeeded
InProgress
Failed
Canceled

CatalogSyncType

열거형

카탈로그에 대해 구성된 동기화 유형을 나타냅니다.

값 Description
Manual
Scheduled

CatalogUpdate

Object

부분 업데이트에 대한 카탈로그의 속성입니다. 업데이트 요청에 제공되지 않는 속성은 변경되지 않습니다.

Name 형식 Description
properties.adoGit

GitCatalog

Azure DevOps 카탈로그 형식의 속성입니다.
properties.gitHub

GitCatalog

GitHub 카탈로그 형식의 속성입니다.
properties.syncType

CatalogSyncType

카탈로그에 대해 구성된 동기화 유형을 나타냅니다.
properties.tags

object

리소스 태그.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값 Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.
type

string

추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

ErrorResponse

Object

오류 응답

Name 형식 Description
error

ErrorDetail

오류 개체입니다.

GitCatalog

Object

Git 리포지토리 카탈로그의 속성입니다.

Name 형식 Description
branch

string

Git 분기입니다.
path

string

리포지토리 내에서 카탈로그 항목을 찾을 수 있는 폴더입니다.
secretIdentifier

string

Git 리포지토리에 인증할 보안 토큰이 포함된 Key Vault 비밀에 대한 참조입니다.
uri

string

Git URI를 사용합니다.

ProvisioningState

열거형

리소스의 프로비전 상태입니다.

값 Description
NotSpecified
Accepted
Running
Creating
Created
Updating
Updated
Deleting
Deleted
Succeeded
Failed
Canceled
MovingResources
TransientFailure
RolloutInProgress
StorageProvisioningFailed

SyncStats

Object

동기화의 통계입니다.

Name 형식 Description
added

integer (int32)

minimum: 0

동기화 중에 추가된 카탈로그 항목의 수입니다.
removed

integer (int32)

minimum: 0

동기화 중에 제거된 카탈로그 항목의 수입니다.
syncedCatalogItemTypes

CatalogItemType[]

동기화된 카탈로그 항목 유형을 나타냅니다.
synchronizationErrors

integer (int32)

minimum: 0

동기화 중에 발생한 동기화 오류 수입니다.
unchanged

integer (int32)

minimum: 0

동기화 중에 변경되지 않은 카탈로그 항목의 수입니다.
updated

integer (int32)

minimum: 0

동기화 중에 업데이트된 카탈로그 항목의 수입니다.
validationErrors

integer (int32)

minimum: 0

동기화 중에 유효성 검사 오류가 발생한 카탈로그 항목의 수입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name 형식 Description
createdAt

string (date-time)

리소스 만들기의 타임스탬프(UTC)입니다.
createdBy

string

리소스를 만든 ID입니다.
createdByType

createdByType

리소스를 만든 ID의 형식입니다.
lastModifiedAt

string (date-time)

리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy

string

리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType

createdByType

리소스를 마지막으로 수정한 ID의 형식입니다.