Agents interface
Interface representing a Agents.
Methods
| begin |
Deletes an Agent resource. |
| begin |
Deletes an Agent resource. |
| create |
Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs. |
| get(string, string, string, Agents |
Gets an Agent resource. |
| list(string, string, Agents |
Lists all Agents in a Storage Mover. |
| update(string, string, string, Agent |
Creates or updates an Agent resource. |
Method Details
beginDelete(string, string, string, AgentsDeleteOptionalParams)
Deletes an Agent resource.
function beginDelete(resourceGroupName: string, storageMoverName: string, agentName: string, options?: AgentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- agentName
-
string
The name of the Agent resource.
- options
- AgentsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, AgentsDeleteOptionalParams)
Deletes an Agent resource.
function beginDeleteAndWait(resourceGroupName: string, storageMoverName: string, agentName: string, options?: AgentsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- agentName
-
string
The name of the Agent resource.
- options
- AgentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
createOrUpdate(string, string, string, Agent, AgentsCreateOrUpdateOptionalParams)
Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.
function createOrUpdate(resourceGroupName: string, storageMoverName: string, agentName: string, agent: Agent, options?: AgentsCreateOrUpdateOptionalParams): Promise<Agent>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- agentName
-
string
The name of the Agent resource.
- agent
- Agent
The Agent resource.
The options parameters.
Returns
Promise<Agent>
get(string, string, string, AgentsGetOptionalParams)
Gets an Agent resource.
function get(resourceGroupName: string, storageMoverName: string, agentName: string, options?: AgentsGetOptionalParams): Promise<Agent>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- agentName
-
string
The name of the Agent resource.
- options
- AgentsGetOptionalParams
The options parameters.
Returns
Promise<Agent>
list(string, string, AgentsListOptionalParams)
Lists all Agents in a Storage Mover.
function list(resourceGroupName: string, storageMoverName: string, options?: AgentsListOptionalParams): PagedAsyncIterableIterator<Agent, Agent[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- options
- AgentsListOptionalParams
The options parameters.
Returns
update(string, string, string, AgentUpdateParameters, AgentsUpdateOptionalParams)
Creates or updates an Agent resource.
function update(resourceGroupName: string, storageMoverName: string, agentName: string, agent: AgentUpdateParameters, options?: AgentsUpdateOptionalParams): Promise<Agent>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- storageMoverName
-
string
The name of the Storage Mover resource.
- agentName
-
string
The name of the Agent resource.
- agent
- AgentUpdateParameters
The Agent resource.
- options
- AgentsUpdateOptionalParams
The options parameters.
Returns
Promise<Agent>