java_components

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

Overview

Name	java_components
Type	Resource
Id	azure.app_containers.java_components

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.
componentType	string	Type of the Java Component. Required. Known values are: "SpringBootAdmin", "SpringCloudEureka", and "SpringCloudConfig".
configurations	array	List of Java Components configuration properties.
provisioningState	string	Provisioning state of the Java Component. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "InProgress". (Succeeded, Failed, Canceled, Deleting, InProgress)
scale	object	Java component scaling configurations.
serviceBinds	array	List of Java Components that are bound to the Java component.
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.
componentType	string	Type of the Java Component. Required. Known values are: "SpringBootAdmin", "SpringCloudEureka", and "SpringCloudConfig".
configurations	array	List of Java Components configuration properties.
provisioningState	string	Provisioning state of the Java Component. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "InProgress". (Succeeded, Failed, Canceled, Deleting, InProgress)
scale	object	Java component scaling configurations.
serviceBinds	array	List of Java Components that are bound to the Java component.
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, name, subscription_id		Get a Java Component. Get a Java Component.
list	select	resource_group_name, environment_name, subscription_id		Get the Java Components for a managed environment. Get the Java Components for a managed environment.
create_or_update	insert	resource_group_name, environment_name, name, subscription_id		Creates or updates a Java Component. Creates or updates a Java Component in a Managed Environment.
update	update	resource_group_name, environment_name, name, subscription_id		Update properties of a Java Component. Patches a Java Component using JSON Merge Patch.
create_or_update	replace	resource_group_name, environment_name, name, subscription_id		Creates or updates a Java Component. Creates or updates a Java Component in a Managed Environment.
delete	delete	resource_group_name, environment_name, name, subscription_id		Delete. Delete a Java Component.

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 managed environment. Required.
name	string	Name of the Java Component. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Java Component. Get a Java Component.

SELECT
id,
name,
componentType,
configurations,
provisioningState,
scale,
serviceBinds,
systemData,
type
FROM azure.app_containers.java_components
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get the Java Components for a managed environment. Get the Java Components for a managed environment.

SELECT
id,
name,
componentType,
configurations,
provisioningState,
scale,
serviceBinds,
systemData,
type
FROM azure.app_containers.java_components
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

Creates or updates a Java Component. Creates or updates a Java Component in a Managed Environment.

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

Manifest

# Description fields are for documentation purposes
- name: java_components
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the java_components resource.
  - name: environment_name
    value: "{{ environment_name }}"
    description: Required parameter for the java_components resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the java_components resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the java_components resource.
  - name: properties
    description: |
      Java Component resource specific properties.
    value:
      componentType: "{{ componentType }}"
      provisioningState: "{{ provisioningState }}"
      configurations:
        - propertyName: "{{ propertyName }}"
          value: "{{ value }}"
      scale:
        minReplicas: {{ minReplicas }}
        maxReplicas: {{ maxReplicas }}
      serviceBinds:
        - name: "{{ name }}"
          serviceId: "{{ serviceId }}"

UPDATE examples

update

Update properties of a Java Component. Patches a Java Component using JSON Merge Patch.

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

REPLACE examples

create_or_update

Creates or updates a Java Component. Creates or updates a Java Component in a Managed Environment.

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

DELETE examples

delete

Delete. Delete a Java Component.

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