oauth_providers
Creates, updates, deletes, gets or lists an oauth_providers resource.
Overview
| Name | oauth_providers |
| Type | Resource |
| Id | azure_extras.agrifood_farming.oauth_providers |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
create_or_update | insert | oauth_provider_id, endpoint | Creates or updates an oauthProvider resource. | |
create_or_update | replace | oauth_provider_id, endpoint | Creates or updates an oauthProvider resource. | |
delete | delete | oauth_provider_id, endpoint | Deletes an specified oauthProvider resource. | |
get_raw | exec | oauth_provider_id, endpoint | Get a specified oauthProvider resource. | |
list_raw | exec | endpoint | minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken | Returns a paginated list of oauthProvider resources. |
get_cascade_delete_job_details | exec | job_id, endpoint | Get cascade delete job for oauthProvider resource. | |
create_cascade_delete_job | exec | job_id, oauthProviderId, endpoint | Create cascade delete job for oauthProvider resource. |
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 | string | The service endpoint host (no scheme). (default: ) |
job_id | string | Job Id supplied by end user. Required. |
oauthProviderId | string | Id of the application data. Required. |
oauth_provider_id | string | ID of the oauthProvider resource. Required. |
maxCreatedDateTime | string (date-time) | Maximum creation date of resource (inclusive). Default value is None. |
maxLastModifiedDateTime | string (date-time) | Maximum last modified date of resource (inclusive). Default value is None. |
minCreatedDateTime | string (date-time) | Minimum creation date of resource (inclusive). Default value is None. |
minLastModifiedDateTime | string (date-time) | Minimum last modified date of resource (inclusive). Default value is None. |
skipToken | string | Skip token for getting next set of results. Default value is None. |
INSERT examples
- create_or_update
- Manifest
Creates or updates an oauthProvider resource.
INSERT INTO azure_extras.agrifood_farming.oauth_providers (
oauth_provider_id,
endpoint
)
SELECT
'{{ oauth_provider_id }}',
'{{ endpoint }}'
;
# Description fields are for documentation purposes
- name: oauth_providers
props:
- name: oauth_provider_id
value: "{{ oauth_provider_id }}"
description: Required parameter for the oauth_providers resource.
- name: endpoint
value: "{{ endpoint }}"
description: Required parameter for the oauth_providers resource.
REPLACE examples
- create_or_update
Creates or updates an oauthProvider resource.
REPLACE azure_extras.agrifood_farming.oauth_providers
SET
-- No updatable properties
WHERE
oauth_provider_id = '{{ oauth_provider_id }}' --required
AND endpoint = '{{ endpoint }}' --required;
DELETE examples
- delete
Deletes an specified oauthProvider resource.
DELETE FROM azure_extras.agrifood_farming.oauth_providers
WHERE oauth_provider_id = '{{ oauth_provider_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;
Lifecycle Methods
- get_raw
- list_raw
- get_cascade_delete_job_details
- create_cascade_delete_job
Get a specified oauthProvider resource.
EXEC azure_extras.agrifood_farming.oauth_providers.get_raw
@oauth_provider_id='{{ oauth_provider_id }}' --required,
@endpoint='{{ endpoint }}' --required
;
Returns a paginated list of oauthProvider resources.
EXEC azure_extras.agrifood_farming.oauth_providers.list_raw
@endpoint='{{ endpoint }}' --required,
@minCreatedDateTime='{{ minCreatedDateTime }}',
@maxCreatedDateTime='{{ maxCreatedDateTime }}',
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}',
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}',
@skipToken='{{ skipToken }}'
;
Get cascade delete job for oauthProvider resource.
EXEC azure_extras.agrifood_farming.oauth_providers.get_cascade_delete_job_details
@job_id='{{ job_id }}' --required,
@endpoint='{{ endpoint }}' --required
;
Create cascade delete job for oauthProvider resource.
EXEC azure_extras.agrifood_farming.oauth_providers.create_cascade_delete_job
@job_id='{{ job_id }}' --required,
@oauthProviderId='{{ oauthProviderId }}' --required,
@endpoint='{{ endpoint }}' --required
;