custom_locations
Creates, updates, deletes, gets or lists a custom_locations
resource.
Overview
Name | custom_locations |
Type | Resource |
Id | azure.custom_locations.custom_locations |
Fields
- vw_custom_locations
- custom_locations
Name | Datatype | Description |
---|---|---|
authentication | text | field from the properties object |
cluster_extension_ids | text | field from the properties object |
display_name | text | field from the properties object |
host_resource_id | text | field from the properties object |
host_type | text | field from the properties object |
identity | text | Identity for the resource. |
location | text | The geo-location where the resource lives |
namespace | text | field from the properties object |
provisioning_state | text | field from the properties object |
resourceGroupName | text | field from the properties object |
resourceName | text | field from the properties object |
subscriptionId | text | field from the properties object |
system_data | text | field from the properties object |
tags | text | Resource tags. |
Name | Datatype | Description |
---|---|---|
identity | object | Identity for the resource. |
location | string | The geo-location where the resource lives |
properties | object | Properties for a custom location. |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
tags | object | Resource tags. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | resourceGroupName, resourceName, subscriptionId | Gets the details of the customLocation with a specified resource group and name. |
list_by_resource_group | SELECT | resourceGroupName, subscriptionId | Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location. |
list_by_subscription | SELECT | subscriptionId | Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location |
create_or_update | INSERT | resourceGroupName, resourceName, subscriptionId | Creates or updates a Custom Location in the specified Subscription and Resource Group |
delete | DELETE | resourceGroupName, resourceName, subscriptionId | Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id. |
update | UPDATE | resourceGroupName, resourceName, subscriptionId | Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. |
find_target_resource_group | EXEC | resourceGroupName, resourceName, subscriptionId | Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request. |
SELECT
examples
Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location
- vw_custom_locations
- custom_locations
SELECT
authentication,
cluster_extension_ids,
display_name,
host_resource_id,
host_type,
identity,
location,
namespace,
provisioning_state,
resourceGroupName,
resourceName,
subscriptionId,
system_data,
tags
FROM azure.custom_locations.vw_custom_locations
WHERE subscriptionId = '{{ subscriptionId }}';
SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.custom_locations.custom_locations
WHERE subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new custom_locations
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.custom_locations.custom_locations (
resourceGroupName,
resourceName,
subscriptionId,
identity,
properties,
tags,
location
)
SELECT
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;
- name: your_resource_model_name
props:
- name: identity
value:
- name: principalId
value: string
- name: tenantId
value: string
- name: type
value: string
- name: properties
value:
- name: authentication
value:
- name: type
value: string
- name: value
value: string
- name: clusterExtensionIds
value:
- string
- name: displayName
value: string
- name: hostResourceId
value: string
- name: hostType
value: string
- name: namespace
value: string
- name: provisioningState
value: string
- name: systemData
value:
- name: createdBy
value: string
- name: createdByType
value: string
- name: createdAt
value: string
- name: lastModifiedBy
value: string
- name: lastModifiedByType
value: string
- name: lastModifiedAt
value: string
- name: tags
value: object
- name: location
value: string
UPDATE
example
Updates a custom_locations
resource.
/*+ update */
UPDATE azure.custom_locations.custom_locations
SET
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE
resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';
DELETE
example
Deletes the specified custom_locations
resource.
/*+ delete */
DELETE FROM azure.custom_locations.custom_locations
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';