Project Catalogs - Patch

Service:

Dev Center

API-versie:

2024-02-01

Hiermee wordt een projectcatalogus gedeeltelijk bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
catalogName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	De naam van de catalogus.
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	De naam van het project.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.adoGit	GitCatalog	Eigenschappen voor een Azure DevOps-catalogustype.
properties.gitHub	GitCatalog	Eigenschappen voor een GitHub-catalogustype.
properties.syncType	CatalogSyncType	Geeft het type synchronisatie aan dat is geconfigureerd voor de catalogus.
properties.tags	object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	Catalog	De resource is bijgewerkt.
202 Accepted		De aanvraag wordt asynchroon voltooid. Kopteksten Location: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ProjectCatalogs_Patch

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
Catalog	Vertegenwoordigt een catalogus.
CatalogConnectionState	De verbindingsstatus van de catalogus.
CatalogItemType	Geeft catalogusitemtypen aan.
CatalogSyncState	De synchronisatiestatus van de catalogus.
CatalogSyncType	Geeft het type synchronisatie aan dat is geconfigureerd voor de catalogus.
CatalogUpdate	De eigenschappen van de catalogus voor gedeeltelijke updates. Eigenschappen die niet zijn opgegeven in de updateaanvraag, worden niet gewijzigd.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GitCatalog	Eigenschappen voor een Git-opslagplaatscatalogus.
ProvisioningState	Inrichtingsstatus van de resource.
SyncStats	Statistieken van de synchronisatie.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Catalog

Object

Vertegenwoordigt een catalogus.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.adoGit	GitCatalog	Eigenschappen voor een Azure DevOps-catalogustype.
properties.connectionState	CatalogConnectionState	De verbindingsstatus van de catalogus.
properties.gitHub	GitCatalog	Eigenschappen voor een GitHub-catalogustype.
properties.lastConnectionTime	string (date-time)	Toen de catalogus voor het laatst is verbonden.
properties.lastSyncStats	SyncStats	Statistieken van de meest recente synchronisatie.
properties.lastSyncTime	string (date-time)	Toen de catalogus voor het laatst werd gesynchroniseerd.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource.
properties.syncState	CatalogSyncState	De synchronisatiestatus van de catalogus.
properties.syncType	CatalogSyncType	Geeft het type synchronisatie aan dat is geconfigureerd voor de catalogus.
properties.tags	object	Resourcetags.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

CatalogConnectionState

Inventarisatie

De verbindingsstatus van de catalogus.

Waarde	Description
Connected
Disconnected

CatalogItemType

Inventarisatie

Geeft catalogusitemtypen aan.

Waarde	Description
EnvironmentDefinition

CatalogSyncState

Inventarisatie

De synchronisatiestatus van de catalogus.

Waarde	Description
Succeeded
InProgress
Failed
Canceled

CatalogSyncType

Inventarisatie

Geeft het type synchronisatie aan dat is geconfigureerd voor de catalogus.

Waarde	Description
Manual
Scheduled

CatalogUpdate

Object

De eigenschappen van de catalogus voor gedeeltelijke updates. Eigenschappen die niet zijn opgegeven in de updateaanvraag, worden niet gewijzigd.

Name	Type	Description
properties.adoGit	GitCatalog	Eigenschappen voor een Azure DevOps-catalogustype.
properties.gitHub	GitCatalog	Eigenschappen voor een GitHub-catalogustype.
properties.syncType	CatalogSyncType	Geeft het type synchronisatie aan dat is geconfigureerd voor de catalogus.
properties.tags	object	Resourcetags.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GitCatalog

Object

Eigenschappen voor een Git-opslagplaatscatalogus.

Name	Type	Description
branch	string	Git-vertakking.
path	string	De map waarin de catalogusitems zich in de opslagplaats bevinden.
secretIdentifier	string	Een verwijzing naar het Key Vault-geheim met een beveiligingstoken om te verifiëren bij een Git-opslagplaats.
uri	string	Git-URI.

ProvisioningState

Inventarisatie

Inrichtingsstatus van de resource.

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

SyncStats

Object

Statistieken van de synchronisatie.

Name	Type	Description
added	integer (int32) minimum: 0	Het aantal catalogusitems dat is toegevoegd tijdens de synchronisatie.
removed	integer (int32) minimum: 0	Het aantal catalogusitems dat tijdens de synchronisatie is verwijderd.
syncedCatalogItemTypes	CatalogItemType[]	Hiermee wordt aangegeven welke catalogusitemtypen zijn gesynchroniseerd.
synchronizationErrors	integer (int32) minimum: 0	Het aantal synchronisatiefouten dat is opgetreden tijdens de synchronisatie.
unchanged	integer (int32) minimum: 0	Het aantal catalogusitems dat tijdens de synchronisatie ongewijzigd is gebleven.
updated	integer (int32) minimum: 0	Het aantal catalogusitems dat is bijgewerkt tijdens de synchronisatie.
validationErrors	integer (int32) minimum: 0	Aantal catalogusitems met validatiefouten tijdens de synchronisatie.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.