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 參數

名稱	位於	必要	類型	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	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
properties.adoGit	GitCatalog	Azure DevOps 目錄類型的屬性。
properties.gitHub	GitCatalog	GitHub 目錄類型的屬性。
properties.syncType	CatalogSyncType	指出針對目錄設定的同步類型。
properties.tags	object	資源標籤。

回應

名稱	類型	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

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ProjectCatalogs_Patch

範例要求

HTTP

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

Java

import com.azure.resourcemanager.devcenter.models.Catalog;
import com.azure.resourcemanager.devcenter.models.GitCatalog;

/**
 * Samples for ProjectCatalogs Patch.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/ProjectCatalogs_Patch.
     * json
     */
    /**
     * Sample code: ProjectCatalogs_Patch.
     * 
     * @param manager Entry point to DevCenterManager.
     */
    public static void projectCatalogsPatch(com.azure.resourcemanager.devcenter.DevCenterManager manager) {
        Catalog resource = manager.projectCatalogs()
            .getWithResponse("rg1", "DevProject", "CentralCatalog", com.azure.core.util.Context.NONE).getValue();
        resource.update().withGitHub(new GitCatalog().withPath("/environments")).apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.devcenter import DevCenterMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devcenter
# USAGE
    python project_catalogs_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevCenterMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="0ac520ee-14c0-480f-b6c9-0a90c58ffff",
    )

    response = client.project_catalogs.begin_patch(
        resource_group_name="rg1",
        project_name="DevProject",
        catalog_name="CentralCatalog",
        body={"properties": {"gitHub": {"path": "/environments"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/ProjectCatalogs_Patch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdevcenter_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devcenter/armdevcenter/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/ProjectCatalogs_Patch.json
func ExampleProjectCatalogsClient_BeginPatch() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevcenter.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProjectCatalogsClient().BeginPatch(ctx, "rg1", "DevProject", "CentralCatalog", armdevcenter.CatalogUpdate{
		Properties: &armdevcenter.CatalogUpdateProperties{
			GitHub: &armdevcenter.GitCatalog{
				Path: to.Ptr("/environments"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Catalog = armdevcenter.Catalog{
	// 	Name: to.Ptr("CentralCatalog"),
	// 	Type: to.Ptr("Microsoft.DevCenter/projects/catalogs"),
	// 	ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog"),
	// 	SystemData: &armdevcenter.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:24:24.818Z"); return t}()),
	// 		CreatedBy: to.Ptr("User1"),
	// 		CreatedByType: to.Ptr(armdevcenter.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:24:24.818Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("User1"),
	// 		LastModifiedByType: to.Ptr(armdevcenter.CreatedByTypeUser),
	// 	},
	// 	Properties: &armdevcenter.CatalogProperties{
	// 		GitHub: &armdevcenter.GitCatalog{
	// 			Path: to.Ptr("/environments"),
	// 			Branch: to.Ptr("main"),
	// 			SecretIdentifier: to.Ptr("https://contosokv.vault.azure.net/secrets/CentralRepoPat"),
	// 			URI: to.Ptr("https://github.com/Contoso/centralrepo-fake.git"),
	// 		},
	// 		ConnectionState: to.Ptr(armdevcenter.CatalogConnectionStateConnected),
	// 		LastConnectionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:28:00.314Z"); return t}()),
	// 		LastSyncStats: &armdevcenter.SyncStats{
	// 			Added: to.Ptr[int32](1),
	// 			Removed: to.Ptr[int32](1),
	// 			SynchronizationErrors: to.Ptr[int32](1),
	// 			Unchanged: to.Ptr[int32](1),
	// 			Updated: to.Ptr[int32](1),
	// 			ValidationErrors: to.Ptr[int32](1),
	// 		},
	// 		LastSyncTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:28:00.314Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armdevcenter.ProvisioningStateSucceeded),
	// 		SyncState: to.Ptr(armdevcenter.CatalogSyncStateSucceeded),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DevCenterClient } = require("@azure/arm-devcenter");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Partially updates a project catalog.
 *
 * @summary Partially updates a project catalog.
 * x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/ProjectCatalogs_Patch.json
 */
async function projectCatalogsPatch() {
  const subscriptionId =
    process.env["DEVCENTER_SUBSCRIPTION_ID"] || "0ac520ee-14c0-480f-b6c9-0a90c58ffff";
  const resourceGroupName = process.env["DEVCENTER_RESOURCE_GROUP"] || "rg1";
  const projectName = "DevProject";
  const catalogName = "CentralCatalog";
  const body = { gitHub: { path: "/environments" } };
  const credential = new DefaultAzureCredential();
  const client = new DevCenterClient(credential, subscriptionId);
  const result = await client.projectCatalogs.beginPatchAndWait(
    resourceGroupName,
    projectName,
    catalogName,
    body,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

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

定義

名稱	Description
Catalog	表示目錄。
CatalogConnectionState	目錄的連接狀態。
CatalogItemType	表示目錄項目類型。
CatalogSyncState	目錄的同步處理狀態。
CatalogSyncType	指出針對目錄設定的同步類型。
CatalogUpdate	部分更新的目錄屬性。 更新要求中未提供的屬性將不會變更。
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GitCatalog	Git 存放庫目錄的屬性。
ProvisioningState	資源布建狀態。
SyncStats	同步處理的統計數據。
systemData	與建立和上次修改資源相關的元數據。

Catalog

Object

表示目錄。

名稱	類型	Description
id	string (arm-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

部分更新的目錄屬性。 更新要求中未提供的屬性將不會變更。

名稱	類型	Description
properties.adoGit	GitCatalog	Azure DevOps 目錄類型的屬性。
properties.gitHub	GitCatalog	GitHub 目錄類型的屬性。
properties.syncType	CatalogSyncType	指出針對目錄設定的同步類型。
properties.tags	object	資源標籤。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GitCatalog

Object

Git 存放庫目錄的屬性。

名稱	類型	Description
branch	string	Git 分支。
path	string	您可以在存放庫內找到目錄項目的資料夾。
secretIdentifier	string	Key Vault 秘密的參考，其中包含要向 Git 存放庫驗證的安全性令牌。
uri	string	Git URI。

ProvisioningState

列舉型別

資源布建狀態。

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

SyncStats

Object

同步處理的統計數據。

名稱	類型	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

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。