3.0.0 • Published 5 years ago

@datafire/azure_marketplace_marketplace v3.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/azure_marketplace_marketplace

Client library for Marketplace RP Service

Installation and Usage

npm install --save @datafire/azure_marketplace_marketplace
let azure_marketplace_marketplace = require('@datafire/azure_marketplace_marketplace').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

Operations_List

Lists all of the available Microsoft.Marketplace REST API operations.

azure_marketplace_marketplace.Operations_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: The API version to use for the request.

Output

PrivateStore_List

Gets the list of available private stores

azure_marketplace_marketplace.PrivateStore_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: The API version to use for the request.

Output

PrivateStore_Delete

Deletes the private store. All that is not saved will be lost.

azure_marketplace_marketplace.PrivateStore_Delete({
  "PrivateStoreId": "",
  "api-version": ""
}, context)

Input

  • input object
    • PrivateStoreId required string: The store ID - must use the tenant ID
    • api-version required string: The API version to use for the request.

Output

Output schema unknown

PrivateStore_Get

Get information about the private store

azure_marketplace_marketplace.PrivateStore_Get({
  "PrivateStoreId": "",
  "api-version": ""
}, context)

Input

  • input object
    • PrivateStoreId required string: The store ID - must use the tenant ID
    • api-version required string: The API version to use for the request.

Output

PrivateStore_CreateOrUpdate

Changes private store properties

azure_marketplace_marketplace.PrivateStore_CreateOrUpdate({
  "PrivateStoreId": "",
  "api-version": ""
}, context)

Input

  • input object
    • payload PrivateStoreProperties
    • PrivateStoreId required string: The store ID - must use the tenant ID
    • api-version required string: The API version to use for the request.

Output

PrivateStoreOffers_List

Get a list of all private offers in the given private store

azure_marketplace_marketplace.PrivateStoreOffers_List({
  "PrivateStoreId": "",
  "api-version": ""
}, context)

Input

  • input object
    • PrivateStoreId required string: The store ID - must use the tenant ID
    • api-version required string: The API version to use for the request.

Output

PrivateStoreOffer_Delete

Deletes an offer from the given private store.

azure_marketplace_marketplace.PrivateStoreOffer_Delete({
  "OfferId": "",
  "PrivateStoreId": "",
  "api-version": ""
}, context)

Input

  • input object
    • OfferId required string: The offer ID to update or delete
    • PrivateStoreId required string: The store ID - must use the tenant ID
    • api-version required string: The API version to use for the request.

Output

Output schema unknown

PrivateStoreOffer_Get

Gets information about a specific offer.

azure_marketplace_marketplace.PrivateStoreOffer_Get({
  "OfferId": "",
  "PrivateStoreId": "",
  "api-version": ""
}, context)

Input

  • input object
    • OfferId required string: The offer ID to update or delete
    • PrivateStoreId required string: The store ID - must use the tenant ID
    • api-version required string: The API version to use for the request.

Output

PrivateStoreOffer_CreateOrUpdate

Update or add an offer to the default collection of the private store.

azure_marketplace_marketplace.PrivateStoreOffer_CreateOrUpdate({
  "OfferId": "",
  "PrivateStoreId": "",
  "api-version": ""
}, context)

Input

  • input object
    • payload Offer
    • OfferId required string: The offer ID to update or delete
    • PrivateStoreId required string: The store ID - must use the tenant ID
    • api-version required string: The API version to use for the request.

Output

Definitions

ErrorResponse

  • ErrorResponse object: Error response indicates Microsoft.Marketplace service is not able to process the incoming request. The reason is provided in the error message.
    • error object: The details of the error.
      • code string: Error code.
      • message string: Error message indicating why the operation failed.

Offer

  • Offer object
    • description string: Description of offer
    • displayName string: It will be displayed prominently in the marketplace
    • eTag string: Identifier for purposes of race condition
    • id string: Offers unique id
    • longSummary string: Purpose or function of offer
    • plans array
    • publisherDisplayName string: Publisher name that will be displayed prominently in the marketplace
    • summary string: Brief purpose or function of offer

OfferListResponse

  • OfferListResponse object
    • nextLink string: URL to get the next set of offer list results if there are any.
    • value array

Operation

  • Operation object: Microsoft.Marketplace REST API operation
    • display object: The object that represents the operation.
      • operation string: Operation type: Get Amendments etc.
      • provider string: Service provider: Microsoft.Marketplace
      • resource string: Resource on which the operation is performed: Amendments
    • name string: Operation name: {provider}/{resource}/{operation}

OperationListResult

  • OperationListResult object: Result of the request to list Marketplace operations. It contains a list of operations and a URL link to get the next set of results.
    • nextLink string: URL to get the next set of operation list results if there are any.
    • value array: List of Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider.

Plan

  • Plan object
    • displayName string: Friendly name for the plan for display in the marketplace
    • planId string: Identifier for this plan

PrivateStoreList

  • PrivateStoreList object: Describes the json payload for the list of available private stores (between zero and one, inclusive)
    • nextLink string: URL to get the next set of PrivateStore list results if there are any.
    • value array

PrivateStoreProperties

  • PrivateStoreProperties object: Describes the json payload on whether or not the private store is enabled for a given tenant
    • availability string (values: enabled, disabled): Indicates private store availability
    • name string: Private Store name

offerObject

  • offerObject object
    • isAvailable required boolean

offerSkuObject

  • offerSkuObject object
    • isAvailable required boolean
datafire
@infinitebrahmanuniverse/nolb-_datafire_az@everything-registry/sub-chunk-221
3.0.0

5 years ago