copilot_settings

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

Overview

Name	copilot_settings
Type	Resource
Id	azure_extras.portal_services_copilot.copilot_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accessControlEnabled	boolean	Boolean indicating if role-based access control is enabled for copilot in this tenant. Required.
provisioningState	string	The status of the last provisioning operation performed on the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Get a CopilotSettingsResource.
create_or_update	insert			Create a CopilotSettingsResource.
update	update			Update a CopilotSettingsResource.
create_or_update	replace			Create a CopilotSettingsResource.
delete	delete			Delete a CopilotSettingsResource.

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

SELECT examples

get

Get a CopilotSettingsResource.

SELECT
id,
name,
accessControlEnabled,
provisioningState,
systemData,
type
FROM azure_extras.portal_services_copilot.copilot_settings
;

INSERT examples

create_or_update

Create a CopilotSettingsResource.

INSERT INTO azure_extras.portal_services_copilot.copilot_settings (
properties
)
SELECT 
'{{ properties }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: copilot_settings
props:
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      accessControlEnabled: {{ accessControlEnabled }}
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a CopilotSettingsResource.

UPDATE azure_extras.portal_services_copilot.copilot_settings
SET 
properties = '{{ properties }}'
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a CopilotSettingsResource.

REPLACE azure_extras.portal_services_copilot.copilot_settings
SET 
properties = '{{ properties }}'
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a CopilotSettingsResource.

DELETE FROM azure_extras.portal_services_copilot.copilot_settings
;