Search
Preparing search index...
The search index is not available
@types/azdata
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@types/azdata
AgentServicesProvider
Interface AgentServicesProvider
Hierarchy
DataProvider
AgentServicesProvider
Index
Properties
handle
provider
Id
Methods
create
Alert
create
Job
create
Job
Schedule
create
Job
Step
create
Notebook
create
Operator
create
Proxy
delete
Alert
delete
Job
delete
Job
Schedule
delete
Job
Step
delete
Materialized
Notebook
delete
Notebook
delete
Operator
delete
Proxy
get
Alerts
get
Credentials
get
Job
Defaults
get
Job
History
get
Job
Schedules
get
Jobs
get
Materialized
Notebook
get
Notebook
History
get
Notebooks
get
Operators
get
Proxies
get
Template
Notebook
job
Action
register
OnUpdated
update
Alert
update
Job
update
Job
Schedule
update
Job
Step
update
Notebook
update
Notebook
Materialized
Name
update
Notebook
Materialized
Pin
update
Operator
update
Proxy
Properties
Optional
handle
handle
:
number
Readonly
provider
Id
provider
Id
:
string
Methods
create
Alert
create
Alert
(
ownerUri
:
string
, alertInfo
:
AgentAlertInfo
)
:
Thenable
<
CreateAgentAlertResult
>
Parameters
ownerUri:
string
alertInfo:
AgentAlertInfo
Returns
Thenable
<
CreateAgentAlertResult
>
create
Job
create
Job
(
ownerUri
:
string
, jobInfo
:
AgentJobInfo
)
:
Thenable
<
CreateAgentJobResult
>
Parameters
ownerUri:
string
jobInfo:
AgentJobInfo
Returns
Thenable
<
CreateAgentJobResult
>
create
Job
Schedule
create
Job
Schedule
(
ownerUri
:
string
, scheduleInfo
:
AgentJobScheduleInfo
)
:
Thenable
<
CreateAgentJobScheduleResult
>
Parameters
ownerUri:
string
scheduleInfo:
AgentJobScheduleInfo
Returns
Thenable
<
CreateAgentJobScheduleResult
>
create
Job
Step
create
Job
Step
(
ownerUri
:
string
, stepInfo
:
AgentJobStepInfo
)
:
Thenable
<
CreateAgentJobStepResult
>
Parameters
ownerUri:
string
stepInfo:
AgentJobStepInfo
Returns
Thenable
<
CreateAgentJobStepResult
>
create
Notebook
create
Notebook
(
ownerUri
:
string
, notebook
:
AgentNotebookInfo
, templateFilePath
:
string
)
:
Thenable
<
CreateAgentNotebookResult
>
Parameters
ownerUri:
string
notebook:
AgentNotebookInfo
templateFilePath:
string
Returns
Thenable
<
CreateAgentNotebookResult
>
create
Operator
create
Operator
(
ownerUri
:
string
, operatorInfo
:
AgentOperatorInfo
)
:
Thenable
<
CreateAgentOperatorResult
>
Parameters
ownerUri:
string
operatorInfo:
AgentOperatorInfo
Returns
Thenable
<
CreateAgentOperatorResult
>
create
Proxy
create
Proxy
(
ownerUri
:
string
, proxyInfo
:
AgentProxyInfo
)
:
Thenable
<
CreateAgentOperatorResult
>
Parameters
ownerUri:
string
proxyInfo:
AgentProxyInfo
Returns
Thenable
<
CreateAgentOperatorResult
>
delete
Alert
delete
Alert
(
ownerUri
:
string
, alertInfo
:
AgentAlertInfo
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
alertInfo:
AgentAlertInfo
Returns
Thenable
<
ResultStatus
>
delete
Job
delete
Job
(
ownerUri
:
string
, jobInfo
:
AgentJobInfo
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
jobInfo:
AgentJobInfo
Returns
Thenable
<
ResultStatus
>
delete
Job
Schedule
delete
Job
Schedule
(
ownerUri
:
string
, scheduleInfo
:
AgentJobScheduleInfo
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
scheduleInfo:
AgentJobScheduleInfo
Returns
Thenable
<
ResultStatus
>
delete
Job
Step
delete
Job
Step
(
ownerUri
:
string
, stepInfo
:
AgentJobStepInfo
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
stepInfo:
AgentJobStepInfo
Returns
Thenable
<
ResultStatus
>
delete
Materialized
Notebook
delete
Materialized
Notebook
(
ownerUri
:
string
, agentNotebookHistory
:
AgentNotebookHistoryInfo
, targetDatabase
:
string
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
agentNotebookHistory:
AgentNotebookHistoryInfo
targetDatabase:
string
Returns
Thenable
<
ResultStatus
>
delete
Notebook
delete
Notebook
(
ownerUri
:
string
, notebook
:
AgentNotebookInfo
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
notebook:
AgentNotebookInfo
Returns
Thenable
<
ResultStatus
>
delete
Operator
delete
Operator
(
ownerUri
:
string
, operatorInfo
:
AgentOperatorInfo
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
operatorInfo:
AgentOperatorInfo
Returns
Thenable
<
ResultStatus
>
delete
Proxy
delete
Proxy
(
ownerUri
:
string
, proxyInfo
:
AgentProxyInfo
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
proxyInfo:
AgentProxyInfo
Returns
Thenable
<
ResultStatus
>
get
Alerts
get
Alerts
(
ownerUri
:
string
)
:
Thenable
<
AgentAlertsResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
AgentAlertsResult
>
get
Credentials
get
Credentials
(
ownerUri
:
string
)
:
Thenable
<
GetCredentialsResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
GetCredentialsResult
>
get
Job
Defaults
get
Job
Defaults
(
ownerUri
:
string
)
:
Thenable
<
AgentJobDefaultsResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
AgentJobDefaultsResult
>
get
Job
History
get
Job
History
(
ownerUri
:
string
, jobId
:
string
, jobName
:
string
)
:
Thenable
<
AgentJobHistoryResult
>
Parameters
ownerUri:
string
jobId:
string
jobName:
string
Returns
Thenable
<
AgentJobHistoryResult
>
get
Job
Schedules
get
Job
Schedules
(
ownerUri
:
string
)
:
Thenable
<
AgentJobSchedulesResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
AgentJobSchedulesResult
>
get
Jobs
get
Jobs
(
ownerUri
:
string
)
:
Thenable
<
AgentJobsResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
AgentJobsResult
>
get
Materialized
Notebook
get
Materialized
Notebook
(
ownerUri
:
string
, targetDatabase
:
string
, notebookMaterializedId
:
number
)
:
Thenable
<
AgentNotebookMaterializedResult
>
Parameters
ownerUri:
string
targetDatabase:
string
notebookMaterializedId:
number
Returns
Thenable
<
AgentNotebookMaterializedResult
>
get
Notebook
History
get
Notebook
History
(
ownerUri
:
string
, jobId
:
string
, jobName
:
string
, targetDatabase
:
string
)
:
Thenable
<
AgentNotebookHistoryResult
>
Parameters
ownerUri:
string
jobId:
string
jobName:
string
targetDatabase:
string
Returns
Thenable
<
AgentNotebookHistoryResult
>
get
Notebooks
get
Notebooks
(
ownerUri
:
string
)
:
Thenable
<
AgentNotebooksResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
AgentNotebooksResult
>
get
Operators
get
Operators
(
ownerUri
:
string
)
:
Thenable
<
AgentOperatorsResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
AgentOperatorsResult
>
get
Proxies
get
Proxies
(
ownerUri
:
string
)
:
Thenable
<
AgentProxiesResult
>
Parameters
ownerUri:
string
Returns
Thenable
<
AgentProxiesResult
>
get
Template
Notebook
get
Template
Notebook
(
ownerUri
:
string
, targetDatabase
:
string
, jobId
:
string
)
:
Thenable
<
AgentNotebookTemplateResult
>
Parameters
ownerUri:
string
targetDatabase:
string
jobId:
string
Returns
Thenable
<
AgentNotebookTemplateResult
>
job
Action
job
Action
(
ownerUri
:
string
, jobName
:
string
, action
:
string
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
jobName:
string
action:
string
Returns
Thenable
<
ResultStatus
>
register
OnUpdated
register
OnUpdated
(
handler
:
(
)
=>
any
)
:
void
Parameters
handler:
(
)
=>
any
(
)
:
any
Returns
any
Returns
void
update
Alert
update
Alert
(
ownerUri
:
string
, originalAlertName
:
string
, alertInfo
:
AgentAlertInfo
)
:
Thenable
<
UpdateAgentAlertResult
>
Parameters
ownerUri:
string
originalAlertName:
string
alertInfo:
AgentAlertInfo
Returns
Thenable
<
UpdateAgentAlertResult
>
update
Job
update
Job
(
ownerUri
:
string
, originalJobName
:
string
, jobInfo
:
AgentJobInfo
)
:
Thenable
<
UpdateAgentJobResult
>
Parameters
ownerUri:
string
originalJobName:
string
jobInfo:
AgentJobInfo
Returns
Thenable
<
UpdateAgentJobResult
>
update
Job
Schedule
update
Job
Schedule
(
ownerUri
:
string
, originalScheduleName
:
string
, scheduleInfo
:
AgentJobScheduleInfo
)
:
Thenable
<
UpdateAgentJobScheduleResult
>
Parameters
ownerUri:
string
originalScheduleName:
string
scheduleInfo:
AgentJobScheduleInfo
Returns
Thenable
<
UpdateAgentJobScheduleResult
>
update
Job
Step
update
Job
Step
(
ownerUri
:
string
, originalJobStepName
:
string
, stepInfo
:
AgentJobStepInfo
)
:
Thenable
<
UpdateAgentJobStepResult
>
Parameters
ownerUri:
string
originalJobStepName:
string
stepInfo:
AgentJobStepInfo
Returns
Thenable
<
UpdateAgentJobStepResult
>
update
Notebook
update
Notebook
(
ownerUri
:
string
, originalNotebookName
:
string
, notebook
:
AgentNotebookInfo
, templateFilePath
:
string
)
:
Thenable
<
UpdateAgentNotebookResult
>
Parameters
ownerUri:
string
originalNotebookName:
string
notebook:
AgentNotebookInfo
templateFilePath:
string
Returns
Thenable
<
UpdateAgentNotebookResult
>
update
Notebook
Materialized
Name
update
Notebook
Materialized
Name
(
ownerUri
:
string
, agentNotebookHistory
:
AgentNotebookHistoryInfo
, targetDatabase
:
string
, name
:
string
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
agentNotebookHistory:
AgentNotebookHistoryInfo
targetDatabase:
string
name:
string
Returns
Thenable
<
ResultStatus
>
update
Notebook
Materialized
Pin
update
Notebook
Materialized
Pin
(
ownerUri
:
string
, agentNotebookHistory
:
AgentNotebookHistoryInfo
, targetDatabase
:
string
, pin
:
boolean
)
:
Thenable
<
ResultStatus
>
Parameters
ownerUri:
string
agentNotebookHistory:
AgentNotebookHistoryInfo
targetDatabase:
string
pin:
boolean
Returns
Thenable
<
ResultStatus
>
update
Operator
update
Operator
(
ownerUri
:
string
, originalOperatorName
:
string
, operatorInfo
:
AgentOperatorInfo
)
:
Thenable
<
UpdateAgentOperatorResult
>
Parameters
ownerUri:
string
originalOperatorName:
string
operatorInfo:
AgentOperatorInfo
Returns
Thenable
<
UpdateAgentOperatorResult
>
update
Proxy
update
Proxy
(
ownerUri
:
string
, originalProxyName
:
string
, proxyInfo
:
AgentProxyInfo
)
:
Thenable
<
UpdateAgentOperatorResult
>
Parameters
ownerUri:
string
originalProxyName:
string
proxyInfo:
AgentProxyInfo
Returns
Thenable
<
UpdateAgentOperatorResult
>
Exports
Agent
Services
Provider
handle
provider
Id
create
Alert
create
Job
create
Job
Schedule
create
Job
Step
create
Notebook
create
Operator
create
Proxy
delete
Alert
delete
Job
delete
Job
Schedule
delete
Job
Step
delete
Materialized
Notebook
delete
Notebook
delete
Operator
delete
Proxy
get
Alerts
get
Credentials
get
Job
Defaults
get
Job
History
get
Job
Schedules
get
Jobs
get
Materialized
Notebook
get
Notebook
History
get
Notebooks
get
Operators
get
Proxies
get
Template
Notebook
job
Action
register
OnUpdated
update
Alert
update
Job
update
Job
Schedule
update
Job
Step
update
Notebook
update
Notebook
Materialized
Name
update
Notebook
Materialized
Pin
update
Operator
update
Proxy
Generated using
TypeDoc