Project Catalogs - Patch

Dienst:: Dev Center

API-Version:: 2024-02-01

Aktualisiert teilweise einen Projektkatalog.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
catalogName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Der Name des Katalogs.
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Der Name des Projekts.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.adoGit	GitCatalog	Eigenschaften für einen Azure DevOps-Katalogtyp.
properties.gitHub	GitCatalog	Eigenschaften für einen GitHub-Katalogtyp.
properties.syncType	CatalogSyncType	Gibt den Typ der Synchronisierung an, die für den Katalog konfiguriert ist.
properties.tags	object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	Catalog	Die Ressource wurde aktualisiert.
202 Accepted		Die Anforderung wird asynchron abgeschlossen. Header Location: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

Catalog

Die Ressource wurde aktualisiert.

202 Accepted

Die Anforderung wird asynchron abgeschlossen.

Header

Location: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ProjectCatalogs_Patch

Beispielanforderung

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


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

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

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

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

Beispiel für eine Antwort

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

Statuscode:: 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

Definitionen

Name	Beschreibung
Catalog	Stellt einen Katalog dar.
CatalogConnectionState	Der Verbindungsstatus des Katalogs.
CatalogItemType	Gibt Katalogelementtypen an.
CatalogSyncState	Der Synchronisierungsstatus des Katalogs.
CatalogSyncType	Gibt den Typ der Synchronisierung an, die für den Katalog konfiguriert ist.
CatalogUpdate	Die Eigenschaften des Katalogs für partielle Aktualisierungen. Die in der Updateanforderung nicht bereitgestellten Eigenschaften werden nicht geändert.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GitCatalog	Eigenschaften für einen Git-Repositorykatalog.
ProvisioningState	Bereitstellungsstatus der Ressource.
SyncStats	Statistiken der Synchronisierung.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

Catalog

Objekt

Stellt einen Katalog dar.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.adoGit	GitCatalog	Eigenschaften für einen Azure DevOps-Katalogtyp.
properties.connectionState	CatalogConnectionState	Der Verbindungsstatus des Katalogs.
properties.gitHub	GitCatalog	Eigenschaften für einen GitHub-Katalogtyp.
properties.lastConnectionTime	string (date-time)	Zeitpunkt der letzten Verbindung des Katalogs.
properties.lastSyncStats	SyncStats	Statistiken zur neuesten Synchronisierung.
properties.lastSyncTime	string (date-time)	Wann der Katalog zuletzt synchronisiert wurde.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Ressource.
properties.syncState	CatalogSyncState	Der Synchronisierungsstatus des Katalogs.
properties.syncType	CatalogSyncType	Gibt den Typ der Synchronisierung an, die für den Katalog konfiguriert ist.
properties.tags	object	Ressourcentags.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

CatalogConnectionState

Enumeration

Der Verbindungsstatus des Katalogs.

Wert	Beschreibung
Connected
Disconnected

CatalogItemType

Enumeration

Gibt Katalogelementtypen an.

Wert	Beschreibung
EnvironmentDefinition

CatalogSyncState

Enumeration

Der Synchronisierungsstatus des Katalogs.

Wert	Beschreibung
Succeeded
InProgress
Failed
Canceled

CatalogSyncType

Enumeration

Gibt den Typ der Synchronisierung an, die für den Katalog konfiguriert ist.

Wert	Beschreibung
Manual
Scheduled

CatalogUpdate

Objekt

Die Eigenschaften des Katalogs für partielle Aktualisierungen. Die in der Updateanforderung nicht bereitgestellten Eigenschaften werden nicht geändert.

Name	Typ	Beschreibung
properties.adoGit	GitCatalog	Eigenschaften für einen Azure DevOps-Katalogtyp.
properties.gitHub	GitCatalog	Eigenschaften für einen GitHub-Katalogtyp.
properties.syncType	CatalogSyncType	Gibt den Typ der Synchronisierung an, die für den Katalog konfiguriert ist.
properties.tags	object	Ressourcentags.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GitCatalog

Objekt

Eigenschaften für einen Git-Repositorykatalog.

Name	Typ	Beschreibung
branch	string	Git Branch.
path	string	Der Ordner, in dem sich die Katalogelemente im Repository befinden.
secretIdentifier	string	Ein Verweis auf den Schlüsseltresorschlüssel, der ein Sicherheitstoken zur Authentifizierung bei einem Git-Repository enthält.
uri	string	Git-URI.

ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource.

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

SyncStats

Objekt

Statistiken der Synchronisierung.

Name	Typ	Beschreibung
added	integer (int32) minimum: 0	Anzahl der Katalogelemente, die während der Synchronisierung hinzugefügt wurden.
removed	integer (int32) minimum: 0	Anzahl der Katalogelemente, die während der Synchronisierung entfernt wurden.
syncedCatalogItemTypes	CatalogItemType[]	Gibt Katalogelementtypen an, die synchronisiert wurden.
synchronizationErrors	integer (int32) minimum: 0	Anzahl der Synchronisierungsfehler, die während der Synchronisierung aufgetreten sind.
unchanged	integer (int32) minimum: 0	Anzahl der Katalogelemente, die während der Synchronisierung unverändert waren.
updated	integer (int32) minimum: 0	Anzahl der Katalogelemente, die während der Synchronisierung aktualisiert wurden.
validationErrors	integer (int32) minimum: 0	Anzahl der Katalogelemente, bei denen während der Synchronisierung Überprüfungsfehler aufgetreten sind.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.