@azure/arm-marketplace package

Classes

MarketplaceClient

Interfaces

AcknowledgeOfferNotificationDetails	Notification update request payload details
AcknowledgeOfferNotificationProperties	Notification update request payload
AdminRequestApprovalProperties	Admin approval request resource properties
AdminRequestApprovalsList	List of admin request approval resources
AdminRequestApprovalsResource	Admin request approval resource.
AnyExistingOffersInTheCollectionsResponse	Response object of query if are there existing offers in the collections.
BillingAccountsResponse	Billing accounts response object
BulkCollectionsDetails	Bulk collection details
BulkCollectionsPayload	Bulk collections action properties
BulkCollectionsResponse	The bulk collections response. The response contains two lists that indicate for each collection whether the operation succeeded or failed
Collection	The Collection data structure.
CollectionOffersByAllContextsPayload	Suggested subscription list
CollectionOffersByAllContextsProperties	Suggested subscription list
CollectionOffersByContext	List of offers and plans that restricted to the context
CollectionOffersByContextOffers	List of offers
CollectionProperties	The collection details
CollectionsDetails	Collection name and id.
CollectionsList	model interface CollectionsList
CollectionsSubscriptionsMappingDetails	Collection name and related subscriptions list
CollectionsToSubscriptionsMappingPayload	The subscriptions list to get the related collections
CollectionsToSubscriptionsMappingProperties	The subscriptions list to get the related collections
CollectionsToSubscriptionsMappingResponse	A map of collections subscriptions details
ContextAndPlansDetails	Object of plans per context.
ErrorResponse	Error response indicates Microsoft.Marketplace service is not able to process the incoming request. The reason is provided in the error message.
ErrorResponseError	The details of the error.
MarketplaceClientOptionalParams	Optional parameters for the client.
MultiContextAndPlansPayload	Payload object for upsert offer with multiple context and plans.
MultiContextAndPlansProperties	Object describes multiple context and plans.
NewNotifications	New plans notification details
NewPlansNotificationsList	List of all new plans notifications for public offers
NotificationsSettingsProperties	Describes the json payload for notifications settings
Offer	The privateStore offer data structure.
OfferProperties	model interface OfferProperties
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Plan	model interface Plan
PlanDetails	Return plan with request details
PlanNotificationDetails	Plan notification details
PlanRequesterDetails	Plan with requesters details
PrivateStore	The PrivateStore data structure.
PrivateStoreAcknowledgeOfferNotificationOptionalParams	Optional parameters.
PrivateStoreAdminRequestApprovalsListOptionalParams	Optional parameters.
PrivateStoreAnyExistingOffersInTheCollectionsOptionalParams	Optional parameters.
PrivateStoreBillingAccountsOptionalParams	Optional parameters.
PrivateStoreBulkCollectionsActionOptionalParams	Optional parameters.
PrivateStoreCollectionApproveAllItemsOptionalParams	Optional parameters.
PrivateStoreCollectionCreateOrUpdateOptionalParams	Optional parameters.
PrivateStoreCollectionDeleteOptionalParams	Optional parameters.
PrivateStoreCollectionDisableApproveAllItemsOptionalParams	Optional parameters.
PrivateStoreCollectionGetOptionalParams	Optional parameters.
PrivateStoreCollectionListOptionalParams	Optional parameters.
PrivateStoreCollectionOfferContextsViewOptionalParams	Optional parameters.
PrivateStoreCollectionOfferCreateOrUpdateOptionalParams	Optional parameters.
PrivateStoreCollectionOfferDeleteOptionalParams	Optional parameters.
PrivateStoreCollectionOfferGetOptionalParams	Optional parameters.
PrivateStoreCollectionOfferListByContextsOptionalParams	Optional parameters.
PrivateStoreCollectionOfferListOptionalParams	Optional parameters.
PrivateStoreCollectionOfferOperations	Interface representing a PrivateStoreCollectionOffer operations.
PrivateStoreCollectionOfferPostOptionalParams	Optional parameters.
PrivateStoreCollectionOfferUpsertOfferWithMultiContextOptionalParams	Optional parameters.
PrivateStoreCollectionOperations	Interface representing a PrivateStoreCollection operations.
PrivateStoreCollectionPostOptionalParams	Optional parameters.
PrivateStoreCollectionTransferOffersOptionalParams	Optional parameters.
PrivateStoreCollectionsToSubscriptionsMappingOptionalParams	Optional parameters.
PrivateStoreCreateApprovalRequestOptionalParams	Optional parameters.
PrivateStoreCreateOrUpdateOptionalParams	Optional parameters.
PrivateStoreDeleteOptionalParams	Optional parameters.
PrivateStoreFetchAllSubscriptionsInTenantOptionalParams	Optional parameters.
PrivateStoreGetAdminRequestApprovalOptionalParams	Optional parameters.
PrivateStoreGetApprovalRequestsListOptionalParams	Optional parameters.
PrivateStoreGetOptionalParams	Optional parameters.
PrivateStoreGetRequestApprovalOptionalParams	Optional parameters.
PrivateStoreListNewPlansNotificationsOptionalParams	Optional parameters.
PrivateStoreListOptionalParams	Optional parameters.
PrivateStoreListStopSellOffersPlansNotificationsOptionalParams	Optional parameters.
PrivateStoreListSubscriptionsContextOptionalParams	Optional parameters.
PrivateStoreNotificationsState	Get private store notifications state
PrivateStoreOperations	Interface representing a PrivateStore operations.
PrivateStoreProperties	Describes the json payload on whether or not the private store is enabled for a given tenant
PrivateStoreQueryApprovedPlansOptionalParams	Optional parameters.
PrivateStoreQueryNotificationsStateOptionalParams	Optional parameters.
PrivateStoreQueryOffersOptionalParams	Optional parameters.
PrivateStoreQueryRequestApprovalOptionalParams	Optional parameters.
PrivateStoreQueryUserOffersOptionalParams	Optional parameters.
PrivateStoreUpdateAdminRequestApprovalOptionalParams	Optional parameters.
PrivateStoreWithdrawPlanOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QueryApprovedPlans	Query approved plans details
QueryApprovedPlansDetails	Query approved plans response
QueryApprovedPlansPayload	Query approved plans payload
QueryApprovedPlansResponse	Query approved plans response
QueryOffers	List of offers
QueryRequestApproval	Gets the request plans with indication on each plan whether is approved by the admin, has pending request or not requested yet
QueryRequestApprovalProperties	The details to get the request plans statuses
QueryRulesOptionalParams	Optional parameters.
QueryUserOffersDetails	List of offers IDs and list of user's subscriptions IDs to query the user's approved offers
QueryUserOffersProperties	Query user's offers properties
QueryUserRulesDetails	List of subscriptions IDs to query the user's rules
QueryUserRulesOptionalParams	Optional parameters.
QueryUserRulesProperties	Query user's rules properties
Recipient	Describes the json payload for a notified recipient for new requests
RequestApprovalProperties	Approval request resource properties
RequestApprovalResource	Request approval resource.
RequestApprovalsDetails	Request approvals details
RequestApprovalsList	List of admin request approval resources
RequestDetails	Request details needed to get the plans statuses
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
Rule	model interface Rule
RuleListResponse	model interface RuleListResponse
SetCollectionRulesOptionalParams	Optional parameters.
SetRulesRequest	model interface SetRulesRequest
SingleOperation	Microsoft.Marketplace REST API operation
SingleOperationDisplay	The object that represents the operation.
StopSellNotifications	Stop sell notification details
StopSellOffersPlansNotificationsList	List of stop sell offers and plans notifications.
StopSellOffersPlansNotificationsListProperties	List of stop sell offers and plans notifications.
StopSellSubscriptions	Private plans subscriptions
Subscription	Subscription information.
SubscriptionsContextList	List of subscription Ids in the private store
SubscriptionsResponse	Subscription list operation response.
SystemData	Metadata pertaining to creation and last modification of the resource.
TransferOffersDetails	Transfer offers response details
TransferOffersProperties	Transfer offers properties
TransferOffersResponse	The transfer items response. The response contains two lists that indicate for each collection whether the operation succeeded or failed
UserRequestDetails	user request details
WithdrawDetails	Withdraw properties details
WithdrawProperties	Withdraw properties

Type Aliases

Accessibility	Plan accessibility KnownAccessibility can be used interchangeably with Accessibility, this enum contains the known values that the service supports. Known values supported by the service Unknown Public PrivateTenantOnLevel PrivateSubscriptionOnLevel
AdminAction	Gets or sets admin action KnownAdminAction can be used interchangeably with AdminAction, this enum contains the known values that the service supports. Known values supported by the service Approved Rejected
Availability	Indicates private store availability KnownAvailability can be used interchangeably with Availability, this enum contains the known values that the service supports. Known values supported by the service enabled disabled
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
Operation	Set the Operation for the POST method. Ping or Delete KnownOperation can be used interchangeably with Operation, this enum contains the known values that the service supports. Known values supported by the service DeletePrivateStoreOffer DeletePrivateStoreCollection DeletePrivateStoreCollectionOffer Ping
RuleType	Rule type KnownRuleType can be used interchangeably with RuleType, this enum contains the known values that the service supports. Known values supported by the service PrivateProducts TermsAndCondition
Status	Gets the plan status KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service Pending Rejected Approved None
SubscriptionState	The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. KnownSubscriptionState can be used interchangeably with SubscriptionState, this enum contains the known values that the service supports. Known values supported by the service Enabled Warned PastDue Disabled Deleted

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessibility	Plan accessibility
KnownAdminAction	Gets or sets admin action
KnownAvailability	Indicates private store availability
KnownCreatedByType	The kind of entity that created the resource.
KnownOperation	Set the Operation for the POST method. Ping or Delete
KnownRuleType	Rule type
KnownStatus	Gets the plan status
KnownSubscriptionState	The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.
KnownVersions	The available API versions.