dev_centers

Creates, updates, deletes, gets or lists a dev_centers resource.

Overview

Name	dev_centers
Type	Resource
Id	azure.devcenter.dev_centers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
devCenterUri	string	The URI of the Dev Center.
displayName	string	The display name of the devcenter.
encryption	object	Encryption settings to be used for server-side encryption for proprietary content (such as catalogs, logs, customizations).
identity	object	Managed identity properties.
location	string	The geo-location where the resource lives. Required.
projectCatalogSettings	object	Dev Center settings to be used when associating a project with a catalog.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
devCenterUri	string	The URI of the Dev Center.
displayName	string	The display name of the devcenter.
encryption	object	Encryption settings to be used for server-side encryption for proprietary content (such as catalogs, logs, customizations).
identity	object	Managed identity properties.
location	string	The geo-location where the resource lives. Required.
projectCatalogSettings	object	Dev Center settings to be used when associating a project with a catalog.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
devCenterUri	string	The URI of the Dev Center.
displayName	string	The display name of the devcenter.
encryption	object	Encryption settings to be used for server-side encryption for proprietary content (such as catalogs, logs, customizations).
identity	object	Managed identity properties.
location	string	The geo-location where the resource lives. Required.
projectCatalogSettings	object	Dev Center settings to be used when associating a project with a catalog.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dev_center_name, subscription_id		Gets a devcenter.
list_by_resource_group	select	resource_group_name, subscription_id	$top	Lists all devcenters in a resource group.
list_by_subscription	select	subscription_id	$top	Lists all devcenters in a subscription.
create_or_update	insert	resource_group_name, dev_center_name, subscription_id, location		Creates or updates a devcenter resource.
update	update	resource_group_name, dev_center_name, subscription_id		Partially updates a devcenter.
create_or_update	replace	resource_group_name, dev_center_name, subscription_id, location		Creates or updates a devcenter resource.
delete	delete	resource_group_name, dev_center_name, subscription_id		Deletes a devcenter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dev_center_name	string	The name of the devcenter. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a devcenter.

SELECT
id,
name,
devCenterUri,
displayName,
encryption,
identity,
location,
projectCatalogSettings,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.dev_centers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all devcenters in a resource group.

SELECT
id,
name,
devCenterUri,
displayName,
encryption,
identity,
location,
projectCatalogSettings,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.dev_centers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

Lists all devcenters in a subscription.

SELECT
id,
name,
devCenterUri,
displayName,
encryption,
identity,
location,
projectCatalogSettings,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.dev_centers
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a devcenter resource.

INSERT INTO azure.devcenter.dev_centers (
tags,
location,
identity,
properties,
resource_group_name,
dev_center_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dev_center_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dev_centers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dev_centers resource.
  - name: dev_center_name
    value: "{{ dev_center_name }}"
    description: Required parameter for the dev_centers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dev_centers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      Managed identity properties.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      encryption:
        customerManagedKeyEncryption:
          keyEncryptionKeyIdentity:
            identityType: "{{ identityType }}"
            userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
            delegatedIdentityClientId: "{{ delegatedIdentityClientId }}"
          keyEncryptionKeyUrl: "{{ keyEncryptionKeyUrl }}"
      displayName: "{{ displayName }}"
      projectCatalogSettings:
        catalogItemSyncEnableStatus: "{{ catalogItemSyncEnableStatus }}"

UPDATE examples

update

Partially updates a devcenter.

UPDATE azure.devcenter.dev_centers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a devcenter resource.

REPLACE azure.devcenter.dev_centers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a devcenter.

DELETE FROM azure.devcenter.dev_centers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;