Skip to main content

ado_oauth

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

Overview

Nameado_oauth
TypeResource
Idazure_extras.devhub.ado_oauth

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
usernamestringuser making request.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectlocation, subscription_idCallback URL to hit once authenticated with Entra ID to have the service store the OAuth token. Callback URL to hit once authenticated with Entra ID to have the service store the OAuth token.
list_rawexeclocation, subscription_idCallback URL to hit once authenticated with ADO to have the service store the OAuth token. Callback URL to hit once authenticated with ADO to have the service store the OAuth token.

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.

NameDatatypeDescription
locationstringThe location name. Required.
subscription_idstring

SELECT examples

Callback URL to hit once authenticated with Entra ID to have the service store the OAuth token. Callback URL to hit once authenticated with Entra ID to have the service store the OAuth token.

SELECT
id,
name,
systemData,
type,
username
FROM azure_extras.devhub.ado_oauth
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

Callback URL to hit once authenticated with ADO to have the service store the OAuth token. Callback URL to hit once authenticated with ADO to have the service store the OAuth token.

EXEC azure_extras.devhub.ado_oauth.list_raw 
@location='{{ location }}' --required,
@subscription_id='{{ subscription_id }}' --required
;