endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	entra_id.service_principals.endpoints

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
capability	string
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
providerId	string
providerName	string
providerResourceId	string
uri	string

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
capability	string
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
providerId	string
providerName	string
providerResourceId	string
uri	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_principal_id, endpoint_id
list	select	service_principal_id
insert	insert	service_principal_id
update	update	service_principal_id, endpoint_id
delete	delete	service_principal_id, endpoint_id	If-Match

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
endpoint_id	string	The unique identifier of endpoint
service_principal_id	string	The unique identifier of servicePrincipal
If-Match	string	ETag

SELECT examples

get

Retrieved navigation property

SELECT
id,
capability,
deletedDateTime,
providerId,
providerName,
providerResourceId,
uri
FROM entra_id.service_principals.endpoints
WHERE service_principal_id = '{{ service_principal_id }}' -- required
AND endpoint_id = '{{ endpoint_id }}' -- required
;

list

Retrieved collection

SELECT
id,
capability,
deletedDateTime,
providerId,
providerName,
providerResourceId,
uri
FROM entra_id.service_principals.endpoints
WHERE service_principal_id = '{{ service_principal_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.service_principals.endpoints (
id,
deletedDateTime,
capability,
providerId,
providerName,
providerResourceId,
uri,
service_principal_id
)
SELECT 
'{{ id }}',
'{{ deletedDateTime }}',
'{{ capability }}',
'{{ providerId }}',
'{{ providerName }}',
'{{ providerResourceId }}',
'{{ uri }}',
'{{ service_principal_id }}'
RETURNING
id,
capability,
deletedDateTime,
providerId,
providerName,
providerResourceId,
uri
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
props:
  - name: service_principal_id
    value: "{{ service_principal_id }}"
    description: Required parameter for the endpoints resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: deletedDateTime
    value: "{{ deletedDateTime }}"
    description: |
      Date and time when this object was deleted. Always null when the object hasn't been deleted.
  - name: capability
    value: "{{ capability }}"
  - name: providerId
    value: "{{ providerId }}"
  - name: providerName
    value: "{{ providerName }}"
  - name: providerResourceId
    value: "{{ providerResourceId }}"
  - name: uri
    value: "{{ uri }}"

UPDATE examples

update

No description available.

UPDATE entra_id.service_principals.endpoints
SET 
id = '{{ id }}',
deletedDateTime = '{{ deletedDateTime }}',
capability = '{{ capability }}',
providerId = '{{ providerId }}',
providerName = '{{ providerName }}',
providerResourceId = '{{ providerResourceId }}',
uri = '{{ uri }}'
WHERE 
service_principal_id = '{{ service_principal_id }}' --required
AND endpoint_id = '{{ endpoint_id }}' --required
RETURNING
id,
capability,
deletedDateTime,
providerId,
providerName,
providerResourceId,
uri;

DELETE examples

delete

No description available.

DELETE FROM entra_id.service_principals.endpoints
WHERE service_principal_id = '{{ service_principal_id }}' --required
AND endpoint_id = '{{ endpoint_id }}' --required
AND If-Match = '{{ If-Match }}'
;