http_route_config

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

Overview

Name	http_route_config
Type	Resource
Id	azure.app_containers.http_route_config

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.
customDomains	array	Custom domain bindings for http Routes' hostnames.
fqdn	string	FQDN of the route resource.
provisioningErrors	array	List of errors when trying to reconcile http routes.
provisioningState	string	The provisioning state of the Http Route Config in cluster. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "Updating", "Deleting", and "Pending". (Succeeded, Failed, Canceled, Waiting, Updating, Deleting, Pending)
rules	array	Routing Rules for http route resource.
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".

list

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.
customDomains	array	Custom domain bindings for http Routes' hostnames.
fqdn	string	FQDN of the route resource.
provisioningErrors	array	List of errors when trying to reconcile http routes.
provisioningState	string	The provisioning state of the Http Route Config in cluster. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "Updating", "Deleting", and "Pending". (Succeeded, Failed, Canceled, Waiting, Updating, Deleting, Pending)
rules	array	Routing Rules for http route resource.
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	resource_group_name, environment_name, http_route_name, subscription_id		Get the specified Http Route Config. Get the specified Managed Http Route Config.
list	select	resource_group_name, environment_name, subscription_id		List the Http Route Configs in a given managed environment. Get the Managed Http Routes in a given managed environment.
create_or_update	insert	resource_group_name, environment_name, http_route_name, subscription_id		Create or Update a Http Route Config. Create or Update a Http Route Config.
update	update	resource_group_name, environment_name, http_route_name, subscription_id		Update tags of a Http Route Config object. Patches an http route config resource. Only patching of tags is supported.
create_or_update	replace	resource_group_name, environment_name, http_route_name, subscription_id		Create or Update a Http Route Config. Create or Update a Http Route Config.
delete	delete	resource_group_name, environment_name, http_route_name, subscription_id		Deletes the specified Http Route Config. Deletes the specified Managed Http Route.

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
environment_name	string	Name of the Environment. Required.
http_route_name	string	Name of the Http Route Config Resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the specified Http Route Config. Get the specified Managed Http Route Config.

SELECT
id,
name,
customDomains,
fqdn,
provisioningErrors,
provisioningState,
rules,
systemData,
type
FROM azure.app_containers.http_route_config
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND http_route_name = '{{ http_route_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List the Http Route Configs in a given managed environment. Get the Managed Http Routes in a given managed environment.

SELECT
id,
name,
customDomains,
fqdn,
provisioningErrors,
provisioningState,
rules,
systemData,
type
FROM azure.app_containers.http_route_config
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update a Http Route Config. Create or Update a Http Route Config.

INSERT INTO azure.app_containers.http_route_config (
properties,
resource_group_name,
environment_name,
http_route_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ http_route_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: http_route_config
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the http_route_config resource.
  - name: environment_name
    value: "{{ environment_name }}"
    description: Required parameter for the http_route_config resource.
  - name: http_route_name
    value: "{{ http_route_name }}"
    description: Required parameter for the http_route_config resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the http_route_config resource.
  - name: properties
    description: |
      Http Route Config properties.
    value:
      provisioningState: "{{ provisioningState }}"
      provisioningErrors:
        - timestamp: "{{ timestamp }}"
          message: "{{ message }}"
      fqdn: "{{ fqdn }}"
      customDomains:
        - name: "{{ name }}"
          bindingType: "{{ bindingType }}"
          certificateId: "{{ certificateId }}"
      rules:
        - targets: "{{ targets }}"
          routes: "{{ routes }}"
          description: "{{ description }}"

UPDATE examples

update

Update tags of a Http Route Config object. Patches an http route config resource. Only patching of tags is supported.

UPDATE azure.app_containers.http_route_config
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND http_route_name = '{{ http_route_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or Update a Http Route Config. Create or Update a Http Route Config.

REPLACE azure.app_containers.http_route_config
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND http_route_name = '{{ http_route_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified Http Route Config. Deletes the specified Managed Http Route.

DELETE FROM azure.app_containers.http_route_config
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND http_route_name = '{{ http_route_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;