dscp_configuration

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

Overview

Name	dscp_configuration
Type	Resource
Id	azure.network.dscp_configuration

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
associatedNetworkInterfaces	array	Associated Network Interfaces to the DSCP Configuration.
destinationIpRanges	array	Destination IP ranges.
destinationPortRanges	array	Destination port ranges.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
markings	array	List of markings to be used in the configuration.
protocol	string	RNM supported protocol types. Known values are: "DoNotUse", "Icmp", "Tcp", "Udp", "Gre", "Esp", "Ah", "Vxlan", and "All". (DoNotUse, Icmp, Tcp, Udp, Gre, Esp, Ah, Vxlan, All)
provisioningState	string	The provisioning state of the DSCP Configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
qosCollectionId	string	Qos Collection ID generated by RNM.
qosDefinitionCollection	array	QoS object definitions.
resourceGuid	string	The resource GUID property of the DSCP Configuration resource.
sourceIpRanges	array	Source IP ranges.
sourcePortRanges	array	Sources port ranges.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
associatedNetworkInterfaces	array	Associated Network Interfaces to the DSCP Configuration.
destinationIpRanges	array	Destination IP ranges.
destinationPortRanges	array	Destination port ranges.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
markings	array	List of markings to be used in the configuration.
protocol	string	RNM supported protocol types. Known values are: "DoNotUse", "Icmp", "Tcp", "Udp", "Gre", "Esp", "Ah", "Vxlan", and "All". (DoNotUse, Icmp, Tcp, Udp, Gre, Esp, Ah, Vxlan, All)
provisioningState	string	The provisioning state of the DSCP Configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
qosCollectionId	string	Qos Collection ID generated by RNM.
qosDefinitionCollection	array	QoS object definitions.
resourceGuid	string	The resource GUID property of the DSCP Configuration resource.
sourceIpRanges	array	Source IP ranges.
sourcePortRanges	array	Sources port ranges.
tags	object	Resource tags.
type	string	Resource type.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
associatedNetworkInterfaces	array	Associated Network Interfaces to the DSCP Configuration.
destinationIpRanges	array	Destination IP ranges.
destinationPortRanges	array	Destination port ranges.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
markings	array	List of markings to be used in the configuration.
protocol	string	RNM supported protocol types. Known values are: "DoNotUse", "Icmp", "Tcp", "Udp", "Gre", "Esp", "Ah", "Vxlan", and "All". (DoNotUse, Icmp, Tcp, Udp, Gre, Esp, Ah, Vxlan, All)
provisioningState	string	The provisioning state of the DSCP Configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
qosCollectionId	string	Qos Collection ID generated by RNM.
qosDefinitionCollection	array	QoS object definitions.
resourceGuid	string	The resource GUID property of the DSCP Configuration resource.
sourceIpRanges	array	Source IP ranges.
sourcePortRanges	array	Sources port ranges.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dscp_configuration_name, subscription_id		Gets a DSCP Configuration.
list	select	resource_group_name, subscription_id		Gets a DSCP Configuration.
list_all	select	subscription_id		Gets all dscp configurations in a subscription.
create_or_update	insert	resource_group_name, dscp_configuration_name, subscription_id		Creates or updates a DSCP Configuration.
create_or_update	replace	resource_group_name, dscp_configuration_name, subscription_id		Creates or updates a DSCP Configuration.
delete	delete	resource_group_name, dscp_configuration_name, subscription_id		Deletes a DSCP Configuration.

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
dscp_configuration_name	string	The name of the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a DSCP Configuration.

SELECT
id,
name,
associatedNetworkInterfaces,
destinationIpRanges,
destinationPortRanges,
etag,
location,
markings,
protocol,
provisioningState,
qosCollectionId,
qosDefinitionCollection,
resourceGuid,
sourceIpRanges,
sourcePortRanges,
tags,
type
FROM azure.network.dscp_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dscp_configuration_name = '{{ dscp_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a DSCP Configuration.

SELECT
id,
name,
associatedNetworkInterfaces,
destinationIpRanges,
destinationPortRanges,
etag,
location,
markings,
protocol,
provisioningState,
qosCollectionId,
qosDefinitionCollection,
resourceGuid,
sourceIpRanges,
sourcePortRanges,
tags,
type
FROM azure.network.dscp_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all dscp configurations in a subscription.

SELECT
id,
name,
associatedNetworkInterfaces,
destinationIpRanges,
destinationPortRanges,
etag,
location,
markings,
protocol,
provisioningState,
qosCollectionId,
qosDefinitionCollection,
resourceGuid,
sourceIpRanges,
sourcePortRanges,
tags,
type
FROM azure.network.dscp_configuration
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a DSCP Configuration.

INSERT INTO azure.network.dscp_configuration (
id,
location,
tags,
properties,
resource_group_name,
dscp_configuration_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dscp_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dscp_configuration
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dscp_configuration resource.
  - name: dscp_configuration_name
    value: "{{ dscp_configuration_name }}"
    description: Required parameter for the dscp_configuration resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dscp_configuration resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the network interface.
    value:
      markings:
        - {{ markings }}
      sourceIpRanges:
        - startIP: "{{ startIP }}"
          endIP: "{{ endIP }}"
      destinationIpRanges:
        - startIP: "{{ startIP }}"
          endIP: "{{ endIP }}"
      sourcePortRanges:
        - start: {{ start }}
          end: {{ end }}
      destinationPortRanges:
        - start: {{ start }}
          end: {{ end }}
      protocol: "{{ protocol }}"
      qosDefinitionCollection:
        - markings: "{{ markings }}"
          sourceIpRanges: "{{ sourceIpRanges }}"
          destinationIpRanges: "{{ destinationIpRanges }}"
          sourcePortRanges: "{{ sourcePortRanges }}"
          destinationPortRanges: "{{ destinationPortRanges }}"
          protocol: "{{ protocol }}"
      qosCollectionId: "{{ qosCollectionId }}"
      associatedNetworkInterfaces:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
          tags: "{{ tags }}"
          properties:
            virtualMachine:
              id: "{{ id }}"
            networkSecurityGroup:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                flushConnection: {{ flushConnection }}
                securityRules: "{{ securityRules }}"
                defaultSecurityRules: "{{ defaultSecurityRules }}"
                networkInterfaces: "{{ networkInterfaces }}"
                subnets: "{{ subnets }}"
                flowLogs: "{{ flowLogs }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
            privateEndpoint:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                subnet: "{{ subnet }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                ipVersionType: "{{ ipVersionType }}"
                privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                customDnsConfigs: "{{ customDnsConfigs }}"
                applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                ipConfigurations: "{{ ipConfigurations }}"
                customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                billingSku: "{{ billingSku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
            ipConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  gatewayLoadBalancer: "{{ gatewayLoadBalancer }}"
                  virtualNetworkTaps: "{{ virtualNetworkTaps }}"
                  applicationGatewayBackendAddressPools: "{{ applicationGatewayBackendAddressPools }}"
                  loadBalancerBackendAddressPools: "{{ loadBalancerBackendAddressPools }}"
                  loadBalancerInboundNatRules: "{{ loadBalancerInboundNatRules }}"
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  privateIPAddressVersion: "{{ privateIPAddressVersion }}"
                  subnet: "{{ subnet }}"
                  primary: {{ primary }}
                  publicIPAddress: "{{ publicIPAddress }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  provisioningState: "{{ provisioningState }}"
                  privateLinkConnectionProperties: "{{ privateLinkConnectionProperties }}"
                etag: "{{ etag }}"
            tapConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  virtualNetworkTap: "{{ virtualNetworkTap }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            dnsSettings:
              dnsServers:
                - "{{ dnsServers }}"
              appliedDnsServers:
                - "{{ appliedDnsServers }}"
              internalDnsNameLabel: "{{ internalDnsNameLabel }}"
              internalFqdn: "{{ internalFqdn }}"
              internalDomainNameSuffix: "{{ internalDomainNameSuffix }}"
            macAddress: "{{ macAddress }}"
            primary: {{ primary }}
            vnetEncryptionSupported: {{ vnetEncryptionSupported }}
            defaultOutboundConnectivityEnabled: {{ defaultOutboundConnectivityEnabled }}
            enableAcceleratedNetworking: {{ enableAcceleratedNetworking }}
            disableTcpStateTracking: {{ disableTcpStateTracking }}
            enableIPForwarding: {{ enableIPForwarding }}
            hostedWorkloads:
              - "{{ hostedWorkloads }}"
            dscpConfiguration:
              id: "{{ id }}"
            resourceGuid: "{{ resourceGuid }}"
            provisioningState: "{{ provisioningState }}"
            workloadType: "{{ workloadType }}"
            nicType: "{{ nicType }}"
            privateLinkService:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                loadBalancerFrontendIpConfigurations: "{{ loadBalancerFrontendIpConfigurations }}"
                ipConfigurations: "{{ ipConfigurations }}"
                destinationIPAddress: "{{ destinationIPAddress }}"
                accessMode: "{{ accessMode }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointConnections: "{{ privateEndpointConnections }}"
                visibility: "{{ visibility }}"
                autoApproval: "{{ autoApproval }}"
                fqdns: "{{ fqdns }}"
                alias: "{{ alias }}"
                enableProxyProtocol: {{ enableProxyProtocol }}
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
            migrationPhase: "{{ migrationPhase }}"
            auxiliaryMode: "{{ auxiliaryMode }}"
            auxiliarySku: "{{ auxiliarySku }}"
          extendedLocation:
            name: "{{ name }}"
            type: "{{ type }}"
          etag: "{{ etag }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a DSCP Configuration.

REPLACE azure.network.dscp_configuration
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dscp_configuration_name = '{{ dscp_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a DSCP Configuration.

DELETE FROM azure.network.dscp_configuration
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dscp_configuration_name = '{{ dscp_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;