attached_networks
Creates, updates, deletes, gets or lists an attached_networks
resource.
Overview
Name | attached_networks |
Type | Resource |
Id | azure.dev_center.attached_networks |
Fields
The following fields are returned by SELECT
queries:
- get_by_project
- get_by_dev_center
- list_by_project
- list_by_dev_center
OK. The request has succeeded.
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 |
properties | object | Attached NetworkConnection properties. |
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" |
OK. The request has succeeded.
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 |
properties | object | Attached NetworkConnection properties. |
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" |
OK. The request has succeeded.
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 |
properties | object | Attached NetworkConnection properties. |
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" |
OK. The request has succeeded.
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 |
properties | object | Attached NetworkConnection properties. |
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_by_project | select | subscriptionId , resourceGroupName , projectName , attachedNetworkConnectionName | Gets an attached NetworkConnection. | |
get_by_dev_center | select | subscriptionId , resourceGroupName , devCenterName , attachedNetworkConnectionName | Gets an attached NetworkConnection. | |
list_by_project | select | subscriptionId , resourceGroupName , projectName | $top | Lists the attached NetworkConnections for a Project. |
list_by_dev_center | select | subscriptionId , resourceGroupName , devCenterName | $top | Lists the attached NetworkConnections for a DevCenter. |
create_or_update | insert | subscriptionId , resourceGroupName , devCenterName , attachedNetworkConnectionName | Creates or updates an attached NetworkConnection. | |
delete | delete | subscriptionId , resourceGroupName , devCenterName , attachedNetworkConnectionName | Un-attach a NetworkConnection. |
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 |
---|---|---|
attachedNetworkConnectionName | string | The name of the attached NetworkConnection. |
devCenterName | string | The name of the devcenter. |
projectName | string | The name of the project. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
$top | integer (int32) | The maximum number of resources to return from the operation. Example: '$top=10'. |
SELECT
examples
- get_by_project
- get_by_dev_center
- list_by_project
- list_by_dev_center
Gets an attached NetworkConnection.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.dev_center.attached_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND projectName = '{{ projectName }}' -- required
AND attachedNetworkConnectionName = '{{ attachedNetworkConnectionName }}' -- required
;
Gets an attached NetworkConnection.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.dev_center.attached_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND devCenterName = '{{ devCenterName }}' -- required
AND attachedNetworkConnectionName = '{{ attachedNetworkConnectionName }}' -- required
;
Lists the attached NetworkConnections for a Project.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.dev_center.attached_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND projectName = '{{ projectName }}' -- required
AND $top = '{{ $top }}'
;
Lists the attached NetworkConnections for a DevCenter.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.dev_center.attached_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND devCenterName = '{{ devCenterName }}' -- required
AND $top = '{{ $top }}'
;
INSERT
examples
- create_or_update
- Manifest
Creates or updates an attached NetworkConnection.
INSERT INTO azure.dev_center.attached_networks (
data__properties,
subscriptionId,
resourceGroupName,
devCenterName,
attachedNetworkConnectionName
)
SELECT
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ devCenterName }}',
'{{ attachedNetworkConnectionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;
# Description fields are for documentation purposes
- name: attached_networks
props:
- name: subscriptionId
value: string
description: Required parameter for the attached_networks resource.
- name: resourceGroupName
value: string
description: Required parameter for the attached_networks resource.
- name: devCenterName
value: string
description: Required parameter for the attached_networks resource.
- name: attachedNetworkConnectionName
value: string
description: Required parameter for the attached_networks resource.
- name: properties
value: object
description: |
Attached NetworkConnection properties.
DELETE
examples
- delete
Un-attach a NetworkConnection.
DELETE FROM azure.dev_center.attached_networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND devCenterName = '{{ devCenterName }}' --required
AND attachedNetworkConnectionName = '{{ attachedNetworkConnectionName }}' --required
;