registry_endpoint

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

Overview

Name	registry_endpoint
Type	Resource
Id	azure.iot_operations.registry_endpoint

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.
authentication	object	The authentication settings for the Azure Container Registry. Required.
codeSigningCas	array	The signing certificate authorities used by artifacts in the registry endpoint.
extendedLocation	object	Edge location of the resource.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
host	string	The Container Registry endpoint hostname. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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_by_instance_resource

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.
authentication	object	The authentication settings for the Azure Container Registry. Required.
codeSigningCas	array	The signing certificate authorities used by artifacts in the registry endpoint.
extendedLocation	object	Edge location of the resource.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
host	string	The Container Registry endpoint hostname. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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, instance_name, registry_endpoint_name, subscription_id		Get a RegistryEndpointResource.
list_by_instance_resource	select	resource_group_name, instance_name, subscription_id		List RegistryEndpointResource resources by InstanceResource.
create_or_update	insert	resource_group_name, instance_name, registry_endpoint_name, subscription_id		Create a RegistryEndpointResource.
create_or_update	replace	resource_group_name, instance_name, registry_endpoint_name, subscription_id		Create a RegistryEndpointResource.
delete	delete	resource_group_name, instance_name, registry_endpoint_name, subscription_id		Delete a RegistryEndpointResource.

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
instance_name	string	Name of instance. Required.
registry_endpoint_name	string	Name of RegistryEndpoint 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 a RegistryEndpointResource.

SELECT
id,
name,
authentication,
codeSigningCas,
extendedLocation,
healthState,
host,
provisioningState,
systemData,
type
FROM azure.iot_operations.registry_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND registry_endpoint_name = '{{ registry_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_instance_resource

List RegistryEndpointResource resources by InstanceResource.

SELECT
id,
name,
authentication,
codeSigningCas,
extendedLocation,
healthState,
host,
provisioningState,
systemData,
type
FROM azure.iot_operations.registry_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a RegistryEndpointResource.

INSERT INTO azure.iot_operations.registry_endpoint (
properties,
extendedLocation,
resource_group_name,
instance_name,
registry_endpoint_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ instance_name }}',
'{{ registry_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: registry_endpoint
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the registry_endpoint resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the registry_endpoint resource.
  - name: registry_endpoint_name
    value: "{{ registry_endpoint_name }}"
    description: Required parameter for the registry_endpoint resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the registry_endpoint resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      host: "{{ host }}"
      authentication:
        method: "{{ method }}"
      provisioningState: "{{ provisioningState }}"
      healthState: "{{ healthState }}"
      codeSigningCas:
        - type: "{{ type }}"
  - name: extendedLocation
    description: |
      Edge location of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

Create a RegistryEndpointResource.

REPLACE azure.iot_operations.registry_endpoint
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND registry_endpoint_name = '{{ registry_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a RegistryEndpointResource.

DELETE FROM azure.iot_operations.registry_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND registry_endpoint_name = '{{ registry_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;