Connector interface
Interface representing a Connector.
Methods
Method Details
beginCreateDryrun(string, string, string, string, DryrunResource, ConnectorCreateDryrunOptionalParams)
create a dryrun job to do necessary check before actual creation
function beginCreateDryrun(subscriptionId: string, resourceGroupName: string, location: string, dryrunName: string, parameters: DryrunResource, options?: ConnectorCreateDryrunOptionalParams): Promise<SimplePollerLike<OperationState<DryrunResource>, DryrunResource>>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- dryrunName
-
string
The name of dryrun.
- parameters
- DryrunResource
dryrun resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DryrunResource>, DryrunResource>>
beginCreateDryrunAndWait(string, string, string, string, DryrunResource, ConnectorCreateDryrunOptionalParams)
create a dryrun job to do necessary check before actual creation
function beginCreateDryrunAndWait(subscriptionId: string, resourceGroupName: string, location: string, dryrunName: string, parameters: DryrunResource, options?: ConnectorCreateDryrunOptionalParams): Promise<DryrunResource>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- dryrunName
-
string
The name of dryrun.
- parameters
- DryrunResource
dryrun resource.
The options parameters.
Returns
Promise<DryrunResource>
beginCreateOrUpdate(string, string, string, string, LinkerResource, ConnectorCreateOrUpdateOptionalParams)
Create or update Connector resource.
function beginCreateOrUpdate(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, parameters: LinkerResource, options?: ConnectorCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LinkerResource>, LinkerResource>>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- parameters
- LinkerResource
Connector details.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<LinkerResource>, LinkerResource>>
beginCreateOrUpdateAndWait(string, string, string, string, LinkerResource, ConnectorCreateOrUpdateOptionalParams)
Create or update Connector resource.
function beginCreateOrUpdateAndWait(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, parameters: LinkerResource, options?: ConnectorCreateOrUpdateOptionalParams): Promise<LinkerResource>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- parameters
- LinkerResource
Connector details.
The options parameters.
Returns
Promise<LinkerResource>
beginDelete(string, string, string, string, ConnectorDeleteOptionalParams)
Delete a Connector.
function beginDelete(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, options?: ConnectorDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- options
- ConnectorDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, ConnectorDeleteOptionalParams)
Delete a Connector.
function beginDeleteAndWait(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, options?: ConnectorDeleteOptionalParams): Promise<void>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- options
- ConnectorDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, string, LinkerPatch, ConnectorUpdateOptionalParams)
Operation to update an existing Connector.
function beginUpdate(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, parameters: LinkerPatch, options?: ConnectorUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LinkerResource>, LinkerResource>>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- parameters
- LinkerPatch
Connector details.
- options
- ConnectorUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<LinkerResource>, LinkerResource>>
beginUpdateAndWait(string, string, string, string, LinkerPatch, ConnectorUpdateOptionalParams)
Operation to update an existing Connector.
function beginUpdateAndWait(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, parameters: LinkerPatch, options?: ConnectorUpdateOptionalParams): Promise<LinkerResource>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- parameters
- LinkerPatch
Connector details.
- options
- ConnectorUpdateOptionalParams
The options parameters.
Returns
Promise<LinkerResource>
beginUpdateDryrun(string, string, string, string, DryrunPatch, ConnectorUpdateDryrunOptionalParams)
update a dryrun job to do necessary check before actual creation
function beginUpdateDryrun(subscriptionId: string, resourceGroupName: string, location: string, dryrunName: string, parameters: DryrunPatch, options?: ConnectorUpdateDryrunOptionalParams): Promise<SimplePollerLike<OperationState<DryrunResource>, DryrunResource>>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- dryrunName
-
string
The name of dryrun.
- parameters
- DryrunPatch
dryrun resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DryrunResource>, DryrunResource>>
beginUpdateDryrunAndWait(string, string, string, string, DryrunPatch, ConnectorUpdateDryrunOptionalParams)
update a dryrun job to do necessary check before actual creation
function beginUpdateDryrunAndWait(subscriptionId: string, resourceGroupName: string, location: string, dryrunName: string, parameters: DryrunPatch, options?: ConnectorUpdateDryrunOptionalParams): Promise<DryrunResource>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- dryrunName
-
string
The name of dryrun.
- parameters
- DryrunPatch
dryrun resource.
The options parameters.
Returns
Promise<DryrunResource>
beginValidate(string, string, string, string, ConnectorValidateOptionalParams)
Validate a Connector.
function beginValidate(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, options?: ConnectorValidateOptionalParams): Promise<SimplePollerLike<OperationState<ValidateOperationResult>, ValidateOperationResult>>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- options
- ConnectorValidateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ValidateOperationResult>, ValidateOperationResult>>
beginValidateAndWait(string, string, string, string, ConnectorValidateOptionalParams)
Validate a Connector.
function beginValidateAndWait(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, options?: ConnectorValidateOptionalParams): Promise<ValidateOperationResult>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- options
- ConnectorValidateOptionalParams
The options parameters.
Returns
Promise<ValidateOperationResult>
deleteDryrun(string, string, string, string, ConnectorDeleteDryrunOptionalParams)
delete a dryrun job
function deleteDryrun(subscriptionId: string, resourceGroupName: string, location: string, dryrunName: string, options?: ConnectorDeleteDryrunOptionalParams): Promise<void>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- dryrunName
-
string
The name of dryrun.
The options parameters.
Returns
Promise<void>
generateConfigurations(string, string, string, string, ConnectorGenerateConfigurationsOptionalParams)
Generate configurations for a Connector.
function generateConfigurations(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, options?: ConnectorGenerateConfigurationsOptionalParams): Promise<ConfigurationResult>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
The options parameters.
Returns
Promise<ConfigurationResult>
get(string, string, string, string, ConnectorGetOptionalParams)
Returns Connector resource for a given name.
function get(subscriptionId: string, resourceGroupName: string, location: string, connectorName: string, options?: ConnectorGetOptionalParams): Promise<LinkerResource>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- connectorName
-
string
The name of resource.
- options
- ConnectorGetOptionalParams
The options parameters.
Returns
Promise<LinkerResource>
getDryrun(string, string, string, string, ConnectorGetDryrunOptionalParams)
get a dryrun job
function getDryrun(subscriptionId: string, resourceGroupName: string, location: string, dryrunName: string, options?: ConnectorGetDryrunOptionalParams): Promise<DryrunResource>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- dryrunName
-
string
The name of dryrun.
- options
- ConnectorGetDryrunOptionalParams
The options parameters.
Returns
Promise<DryrunResource>
list(string, string, string, ConnectorListOptionalParams)
Returns list of connector which connects to the resource, which supports to config the target service during the resource provision.
function list(subscriptionId: string, resourceGroupName: string, location: string, options?: ConnectorListOptionalParams): PagedAsyncIterableIterator<LinkerResource, LinkerResource[], PageSettings>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
- options
- ConnectorListOptionalParams
The options parameters.
Returns
listDryrun(string, string, string, ConnectorListDryrunOptionalParams)
list dryrun jobs
function listDryrun(subscriptionId: string, resourceGroupName: string, location: string, options?: ConnectorListDryrunOptionalParams): PagedAsyncIterableIterator<DryrunResource, DryrunResource[], PageSettings>Parameters
- subscriptionId
-
string
The ID of the target subscription.
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of Azure region.
The options parameters.
