VisualStudioResourceProviderClientContext.yml

### YamlMime:TSType
name: VisualStudioResourceProviderClientContext
uid: '@azure/arm-visualstudio.VisualStudioResourceProviderClientContext'
package: '@azure/arm-visualstudio'
summary: ''
fullName: VisualStudioResourceProviderClientContext
remarks: ''
isDeprecated: false
type: class
constructors:
  - name: >-
      VisualStudioResourceProviderClientContext(ServiceClientCredentials |
      TokenCredential, string, VisualStudioResourceProviderClientOptions)
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.constructor
    package: '@azure/arm-visualstudio'
    summary: >-
      Initializes a new instance of the VisualStudioResourceProviderClient
      class.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        new VisualStudioResourceProviderClientContext(credentials:
        ServiceClientCredentials | TokenCredential, subscriptionId: string,
        options?: VisualStudioResourceProviderClientOptions)
      parameters:
        - id: credentials
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceClientCredentials" /> | <xref
            uid="@azure/core-auth.TokenCredential" />
          description: >-
            Credentials needed for the client to connect to Azure. Credentials

            implementing the TokenCredential interface from the @azure/identity
            package are recommended. For

            more information about these credentials, see

            https://www.npmjs.com/package/@azure/identity. Credentials
            implementing the

            ServiceClientCredentials interface from the older packages
            @azure/ms-rest-nodeauth and

            @azure/ms-rest-browserauth are also supported.
        - id: subscriptionId
          type: string
          description: The Azure subscription identifier.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-visualstudio.VisualStudioResourceProviderModels.VisualStudioResourceProviderClientOptions"
            />
          description: The parameter options
properties:
  - name: apiVersion
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.apiVersion
    package: '@azure/arm-visualstudio'
    summary: ''
    fullName: apiVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'apiVersion?: string'
      return:
        description: ''
        type: string
  - name: credentials
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.credentials
    package: '@azure/arm-visualstudio'
    summary: ''
    fullName: credentials
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'credentials: ServiceClientCredentials | TokenCredential'
      return:
        description: ''
        type: >-
          <xref uid="@azure/ms-rest-js.ServiceClientCredentials" /> | <xref
          uid="@azure/core-auth.TokenCredential" />
  - name: subscriptionId
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.subscriptionId
    package: '@azure/arm-visualstudio'
    summary: ''
    fullName: subscriptionId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'subscriptionId: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: acceptLanguage
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.acceptLanguage
    package: '@azure/arm-visualstudio'
    summary: ''
    fullName: acceptLanguage
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'acceptLanguage: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.acceptLanguage
  - name: longRunningOperationRetryTimeout
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.longRunningOperationRetryTimeout
    package: '@azure/arm-visualstudio'
    summary: >-
      The retry timeout in seconds for Long Running Operations. Default value is
      30.
    fullName: longRunningOperationRetryTimeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'longRunningOperationRetryTimeout?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      msRestAzure.AzureServiceClient.longRunningOperationRetryTimeout
inheritedMethods:
  - name: >-
      beginLongRunningRequest(RequestPrepareOptions | WebResource,
      RequestOptionsBase)
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.beginLongRunningRequest
    package: '@azure/arm-visualstudio'
    summary: >-
      Send the initial request of a LRO (long running operation) and get back an

      HttpLongRunningOperationResponse that provides methods for polling the LRO
      and checking if the

      LRO is finished.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginLongRunningRequest(request: RequestPrepareOptions |
        WebResource, options?: RequestOptionsBase): Promise<LROPoller>
      parameters:
        - id: request
          type: >-
            <xref uid="@azure/ms-rest-js.RequestPrepareOptions" /> | <xref
            uid="@azure/ms-rest-js.WebResource" />
          description: The request object
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: Additional options to be sent while making the request
      return:
        description: |-
          The HttpLongRunningOperationResponse
          that provides methods for interacting with the LRO.
        type: Promise&lt;<xref uid="@azure/ms-rest-azure-js.LROPoller" />&gt;
    inheritanceDescription: >-
      <b>Inherited From</b>
      msRestAzure.AzureServiceClient.beginLongRunningRequest
  - name: restoreLROPoller(LROPollState)
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.restoreLROPoller
    package: '@azure/arm-visualstudio'
    summary: >-
      Restore an LROPoller from the provided LROPollState. This method can be
      used to recreate an

      LROPoller on a different process or machine.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function restoreLROPoller(lroPollState: LROPollState): LROPoller'
      parameters:
        - id: lroPollState
          type: <xref uid="@azure/ms-rest-azure-js.LROPollState" />
          description: ''
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-azure-js.LROPoller" />
    inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.restoreLROPoller
  - name: >-
      sendLongRunningRequest(RequestPrepareOptions | WebResource,
      RequestOptionsBase)
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.sendLongRunningRequest
    package: '@azure/arm-visualstudio'
    summary: >-
      Provides a mechanism to make a request that will poll and provide the
      final result.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function sendLongRunningRequest(request: RequestPrepareOptions |
        WebResource, options?: RequestOptionsBase):
        Promise<HttpOperationResponse>
      parameters:
        - id: request
          type: >-
            <xref uid="@azure/ms-rest-js.RequestPrepareOptions" /> | <xref
            uid="@azure/ms-rest-js.WebResource" />
          description: The request object
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: Additional options to be sent while making the request
      return:
        description: >-
          The HttpOperationResponse containing the final polling request,
          response and the responseBody.
        type: Promise&lt;<xref uid="@azure/ms-rest-js.HttpOperationResponse" />&gt;
    inheritanceDescription: >-
      <b>Inherited From</b>
      msRestAzure.AzureServiceClient.sendLongRunningRequest
  - name: sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.sendLRORequest
    package: '@azure/arm-visualstudio'
    summary: >-
      Send the initial request of a LRO (long running operation) and get back an

      LROPoller that provides methods for polling the LRO and checking if the
      LRO is finished.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function sendLRORequest(operationArguments: OperationArguments,
        operationSpec: OperationSpec, options?: RequestOptionsBase):
        Promise<LROPoller>
      parameters:
        - id: operationArguments
          type: <xref uid="@azure/ms-rest-js.OperationArguments" />
          description: The arguments to the operation.
        - id: operationSpec
          type: <xref uid="@azure/ms-rest-js.OperationSpec" />
          description: The specification for the operation.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: Additional options to be sent while making the request.
      return:
        description: >-
          The LROPoller object that provides methods for interacting with the
          LRO.
        type: Promise&lt;<xref uid="@azure/ms-rest-azure-js.LROPoller" />&gt;
    inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.sendLRORequest
  - name: >-
      sendOperationRequest(OperationArguments, OperationSpec,
      ServiceCallback<any>)
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.sendOperationRequest
    package: '@azure/arm-visualstudio'
    summary: Send an HTTP request that is populated using the provided OperationSpec.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function sendOperationRequest(operationArguments: OperationArguments,
        operationSpec: OperationSpec, callback?: ServiceCallback<any>):
        Promise<RestResponse>
      parameters:
        - id: operationArguments
          type: <xref uid="@azure/ms-rest-js.OperationArguments" />
          description: >-
            The arguments that the HTTP request's templated values will be
            populated from.
        - id: operationSpec
          type: <xref uid="@azure/ms-rest-js.OperationSpec" />
          description: The OperationSpec to use to populate the httpRequest.
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;any&gt;
          description: The callback to call when the response is received.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/ms-rest-js.RestResponse" />&gt;
    inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.sendOperationRequest
  - name: sendRequest(RequestPrepareOptions | WebResourceLike)
    uid: >-
      @azure/arm-visualstudio.VisualStudioResourceProviderClientContext.sendRequest
    package: '@azure/arm-visualstudio'
    summary: Send the provided httpRequest.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function sendRequest(options: RequestPrepareOptions | WebResourceLike):
        Promise<HttpOperationResponse>
      parameters:
        - id: options
          type: >-
            <xref uid="@azure/ms-rest-js.RequestPrepareOptions" /> | <xref
            uid="@azure/ms-rest-js.WebResourceLike" />
          description: ''
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/ms-rest-js.HttpOperationResponse" />&gt;
    inheritanceDescription: <b>Inherited From</b> msRestAzure.AzureServiceClient.sendRequest
extends: <xref uid="@azure/ms-rest-azure-js.AzureServiceClient" />