Azure Connectors Node.js SDK
    Preparing search index...

    Typed client for the arm connector.

    Hierarchy (View Summary)

    Index
    • Cancel a template deployment

      Parameters

      • subscriptionId: string
      • resourceGroupName: string
      • deploymentName: string
      • xMsApiVersion: string
      • options: ConnectorOperationOptions = {}

      Returns Promise<void>

      Cancel a currently running template deployment. All pending template operations will be suspended.

    • Delete template deployment

      Parameters

      • subscriptionId: string
      • resourceGroupName: string
      • deploymentName: string
      • xMsApiVersion: string
      • options: ConnectorOperationOptions = {}

      Returns Promise<void>

      Deletes a resource group template deployment. The resources will not be deleted; only the metadata about the template deployment.

    • Delete a resource

      Parameters

      • subscriptionId: string
      • resourceGroupName: string
      • resourceProviderNamespace: string
      • shortResourceId: string
      • xMsApiVersion: string
      • options: ConnectorOperationOptions = {}

      Returns Promise<void>

      Deletes a resource.

    • Delete a resource group

      Parameters

      Returns Promise<void>

      Delete a particular resource group within the subscription.

    • Delete a subscription resource tag name

      Parameters

      Returns Promise<void>

      Delete a subscription resource tag name.

    • Delete a subscription resource tag value

      Parameters

      Returns Promise<void>

      Delete a subscription resource tag value.

    • Read a template deployment operation

      Parameters

      • subscriptionId: string
      • resourceGroupName: string
      • deploymentName: string
      • operationId: string
      • xMsApiVersion: string
      • options: ConnectorOperationOptions = {}

      Returns Promise<DeploymentOperation>

      Reads a particular resource group template deployment operation. This is useful for troubleshooting failed template deployments.

    • Read resource provider

      Parameters

      • subscriptionId: string
      • resourceProviderNamespace: string
      • xMsApiVersion: string
      • options: GetProviderOptions = {}

      Returns Promise<Provider>

      Reads a particular resource provider within the subscription.

    • Register resource provider

      Parameters

      Returns Promise<Provider>

      Registers a resource provider to be used with a subscription. This will provision permissions for the service into your subscription.

    • Unregister resource provider

      Parameters

      Returns Promise<Provider>

      Unregisters provider from a subscription. This operation will fail if there are any resources from that resource provider in the subscription.

    • Create or update a resource

      Parameters

      Returns Promise<GenericResource>

      Creates or updates a resource. The response code can be used to distinguish between a create (201) or update (200).