Project Catalogs - Patch

Referência

Serviço:: Dev Center

Versão da API:: 2024-02-01

Atualiza parcialmente um catálogo de projetos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
catalogName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	O nome do Catálogo.
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	O nome do projeto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.adoGit	GitCatalog	Propriedades para um tipo de catálogo do Azure DevOps.
properties.gitHub	GitCatalog	Propriedades de um tipo de catálogo do GitHub.
properties.syncType	CatalogSyncType	Indica o tipo de sincronização configurado para o catálogo.
properties.tags	object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	Catalog	O recurso foi atualizado.
202 Accepted		A solicitação será concluída de forma assíncrona. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

Catalog

O recurso foi atualizado.

202 Accepted

A solicitação será concluída de forma assíncrona.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ProjectCatalogs_Patch

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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

Definições

Nome	Description
Catalog	Representa um catálogo.
CatalogConnectionState	O estado da conexão do catálogo.
CatalogItemType	Indica tipos de item de catálogo.
CatalogSyncState	O estado de sincronização do catálogo.
CatalogSyncType	Indica o tipo de sincronização configurado para o catálogo.
CatalogUpdate	As propriedades do catálogo para atualização parcial. As propriedades não fornecidas na solicitação de atualização não serão alteradas.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GitCatalog	Propriedades de um catálogo de repositório Git.
ProvisioningState	Estado de provisionamento do recurso.
SyncStats	Estatísticas da sincronização.
systemData	Metadados relativos à criação e última modificação do recurso.

Catalog

Objeto

Representa um catálogo.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.adoGit	GitCatalog	Propriedades para um tipo de catálogo do Azure DevOps.
properties.connectionState	CatalogConnectionState	O estado da conexão do catálogo.
properties.gitHub	GitCatalog	Propriedades de um tipo de catálogo do GitHub.
properties.lastConnectionTime	string (date-time)	Quando o catálogo foi conectado pela última vez.
properties.lastSyncStats	SyncStats	Estatísticas da sincronização mais recente.
properties.lastSyncTime	string (date-time)	Quando o catálogo foi sincronizado pela última vez.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso.
properties.syncState	CatalogSyncState	O estado de sincronização do catálogo.
properties.syncType	CatalogSyncType	Indica o tipo de sincronização configurado para o catálogo.
properties.tags	object	Marcas de recurso.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CatalogConnectionState

Enumeração

O estado da conexão do catálogo.

Valor	Description
Connected
Disconnected

CatalogItemType

Enumeração

Indica tipos de item de catálogo.

Valor	Description
EnvironmentDefinition

CatalogSyncState

Enumeração

O estado de sincronização do catálogo.

Valor	Description
Canceled
Failed
InProgress
Succeeded

CatalogSyncType

Enumeração

Indica o tipo de sincronização configurado para o catálogo.

Valor	Description
Manual
Scheduled

CatalogUpdate

Objeto

As propriedades do catálogo para atualização parcial. As propriedades não fornecidas na solicitação de atualização não serão alteradas.

Nome	Tipo	Description
properties.adoGit	GitCatalog	Propriedades para um tipo de catálogo do Azure DevOps.
properties.gitHub	GitCatalog	Propriedades de um tipo de catálogo do GitHub.
properties.syncType	CatalogSyncType	Indica o tipo de sincronização configurado para o catálogo.
properties.tags	object	Marcas de recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GitCatalog

Objeto

Propriedades de um catálogo de repositório Git.

Nome	Tipo	Description
branch	string	Branch do Git.
path	string	A pasta em que os itens de catálogo podem ser encontrados dentro do repositório.
secretIdentifier	string	Uma referência ao segredo do Key Vault que contém um token de segurança para autenticar em um repositório Git.
uri	string	URI do Git.

ProvisioningState

Enumeração

Estado de provisionamento do recurso.

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

SyncStats

Objeto

Estatísticas da sincronização.

Nome	Tipo	Description
added	integer (int32) minimum: 0	Contagem de itens de catálogo adicionados durante a sincronização.
removed	integer (int32) minimum: 0	Contagem de itens de catálogo removidos durante a sincronização.
syncedCatalogItemTypes	CatalogItemType[]	Indica os tipos de item de catálogo que foram sincronizados.
synchronizationErrors	integer (int32) minimum: 0	Contagem de erros de sincronização que ocorreram durante a sincronização.
unchanged	integer (int32) minimum: 0	Contagem de itens de catálogo que não foram alterados durante a sincronização.
updated	integer (int32) minimum: 0	Contagem de itens de catálogo atualizados durante a sincronização.
validationErrors	integer (int32) minimum: 0	Contagem de itens de catálogo que tiveram erros de validação durante a sincronização.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Project Catalogs - Patch

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

ProjectCatalogs_Patch

Solicitação de exemplo

Resposta de exemplo

Definições

Catalog

CatalogConnectionState

CatalogItemType

CatalogSyncState

CatalogSyncType

CatalogUpdate

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GitCatalog

ProvisioningState

SyncStats

systemData