Catalogs - Get

Service:: Dev Center

API Version:: 2024-02-01

Gets a catalog

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

URI Parameters

Name	In	Required	Type	Description
catalogName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	The name of the Catalog.
devCenterName	path	True	string minLength: 3 maxLength: 26 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$	The name of the devcenter.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Catalog	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Catalogs_Get

Sample request

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


/**
 * Samples for Catalogs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_Get.json
     */
    /**
     * Sample code: Catalogs_Get.
     * 
     * @param manager Entry point to DevCenterManager.
     */
    public static void catalogsGet(com.azure.resourcemanager.devcenter.DevCenterManager manager) {
        manager.catalogs().getWithResponse("rg1", "Contoso", "CentralCatalog", com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.devcenter import DevCenterMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devcenter
# USAGE
    python catalogs_get.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.catalogs.get(
        resource_group_name="rg1",
        dev_center_name="Contoso",
        catalog_name="CentralCatalog",
    )
    print(response)


# x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_Get.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/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/Catalogs_Get.json
func ExampleCatalogsClient_Get() {
	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)
	}
	res, err := clientFactory.NewCatalogsClient().Get(ctx, "rg1", "Contoso", "CentralCatalog", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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/devcenters/catalogs"),
	// 	ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/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("/templates"),
	// 			Branch: to.Ptr("main"),
	// 			SecretIdentifier: to.Ptr("https://contosokv.vault.azure.net/secrets/CentralRepoPat"),
	// 			URI: to.Ptr("https://github.com/Contoso/centralrepo-fake.git"),
	// 		},
	// 		SyncType: to.Ptr(armdevcenter.CatalogSyncTypeScheduled),
	// 		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 Gets a catalog
 *
 * @summary Gets a catalog
 * x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_Get.json
 */
async function catalogsGet() {
  const subscriptionId =
    process.env["DEVCENTER_SUBSCRIPTION_ID"] || "0ac520ee-14c0-480f-b6c9-0a90c58ffff";
  const resourceGroupName = process.env["DEVCENTER_RESOURCE_GROUP"] || "rg1";
  const devCenterName = "Contoso";
  const catalogName = "CentralCatalog";
  const credential = new DefaultAzureCredential();
  const client = new DevCenterClient(credential, subscriptionId);
  const result = await client.catalogs.get(resourceGroupName, devCenterName, catalogName);
  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

Sample response

Status code:: 200

{
  "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog",
  "name": "CentralCatalog",
  "type": "Microsoft.DevCenter/devcenters/catalogs",
  "properties": {
    "gitHub": {
      "uri": "https://github.com/Contoso/centralrepo-fake.git",
      "branch": "main",
      "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat",
      "path": "/templates"
    },
    "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",
    "syncType": "Scheduled"
  },
  "systemData": {
    "createdBy": "User1",
    "createdByType": "User",
    "createdAt": "2020-11-18T18:24:24.818Z",
    "lastModifiedBy": "User1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-11-18T18:24:24.818Z"
  }
}

Definitions

Name	Description
Catalog	Represents a catalog.
CatalogConnectionState	The connection state of the catalog.
CatalogItemType	Indicates catalog item types.
CatalogSyncState	The synchronization state of the catalog.
CatalogSyncType	Indicates the type of sync that is configured for the catalog.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GitCatalog	Properties for a Git repository catalog.
ProvisioningState	Provisioning state of the resource.
SyncStats	Stats of the synchronization.
systemData	Metadata pertaining to creation and last modification of the resource.

Catalog

Object

Represents a catalog.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.adoGit	GitCatalog	Properties for an Azure DevOps catalog type.
properties.connectionState	CatalogConnectionState	The connection state of the catalog.
properties.gitHub	GitCatalog	Properties for a GitHub catalog type.
properties.lastConnectionTime	string (date-time)	When the catalog was last connected.
properties.lastSyncStats	SyncStats	Stats of the latest synchronization.
properties.lastSyncTime	string (date-time)	When the catalog was last synced.
properties.provisioningState	ProvisioningState	The provisioning state of the resource.
properties.syncState	CatalogSyncState	The synchronization state of the catalog.
properties.syncType	CatalogSyncType	Indicates the type of sync that is configured for the catalog.
properties.tags	object	Resource tags.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

CatalogConnectionState

Enumeration

The connection state of the catalog.

Value	Description
Connected
Disconnected

CatalogItemType

Enumeration

Indicates catalog item types.

Value	Description
EnvironmentDefinition

CatalogSyncState

Enumeration

The synchronization state of the catalog.

Value	Description
Succeeded
InProgress
Failed
Canceled

CatalogSyncType

Enumeration

Indicates the type of sync that is configured for the catalog.

Value	Description
Manual
Scheduled

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GitCatalog

Object

Properties for a Git repository catalog.

Name	Type	Description
branch	string	Git branch.
path	string	The folder where the catalog items can be found inside the repository.
secretIdentifier	string	A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
uri	string	Git URI.

ProvisioningState

Enumeration

Provisioning state of the resource.

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

SyncStats

Object

Stats of the synchronization.

Name	Type	Description
added	integer (int32) minimum: 0	Count of catalog items added during synchronization.
removed	integer (int32) minimum: 0	Count of catalog items removed during synchronization.
syncedCatalogItemTypes	CatalogItemType[]	Indicates catalog item types that were synced.
synchronizationErrors	integer (int32) minimum: 0	Count of synchronization errors that occured during synchronization.
unchanged	integer (int32) minimum: 0	Count of catalog items that were unchanged during synchronization.
updated	integer (int32) minimum: 0	Count of catalog items updated during synchronization.
validationErrors	integer (int32) minimum: 0	Count of catalog items that had validation errors during synchronization.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Catalogs - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Catalogs_Get

Sample request

Sample response

Definitions

Catalog

CatalogConnectionState

CatalogItemType

CatalogSyncState

CatalogSyncType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GitCatalog

ProvisioningState

SyncStats

systemData