Edit

Share via

Get-AzMarketplaceCollectionToSubscriptionMapping

  • Reference
Module:
Az.Marketplace

For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list.

Syntax

Get-AzMarketplaceCollectionToSubscriptionMapping
   -PrivateStoreId <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzMarketplaceCollectionToSubscriptionMapping
   -PrivateStoreId <String>
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzMarketplaceCollectionToSubscriptionMapping
   -PrivateStoreId <String>
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzMarketplaceCollectionToSubscriptionMapping
   -PrivateStoreId <String>
   -Payload <ICollectionsToSubscriptionsMappingPayload>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzMarketplaceCollectionToSubscriptionMapping
   -InputObject <IMarketplaceIdentity>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzMarketplaceCollectionToSubscriptionMapping
   -InputObject <IMarketplaceIdentity>
   -Payload <ICollectionsToSubscriptionsMappingPayload>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list.

Examples

Example 1: Map subscriptions to collections

$res = Get-AzMarketplaceCollectionToSubscriptionMapping -PrivateStoreId a260d38c-96cf-492d-a340-404d0c4b3ad6 -Payload @{SubscriptionId = "53425a7b-4ac1-4729-8340-e1da5046212c"}
$res.keys

e58535dc-1be3-4d2c-904c-1f97984ebe5d
fdb889a1-cf3e-49f0-95b8-2bb012fa01f1

This command For a given subscriptions list, will return a map of collections and the related subscriptions from the supplied list.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter

Type:IMarketplaceIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-JsonFilePath

Path of Json file supplied to the Collections operation

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-JsonString

Json string supplied to the Collections operation

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Payload

The subscriptions list to get the related collections

Type:ICollectionsToSubscriptionsMappingPayload
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PrivateStoreId

The store ID - must use the tenant ID

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Subscriptions ids list

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

ICollectionsToSubscriptionsMappingPayload

IMarketplaceIdentity

Outputs

ICollectionsToSubscriptionsMappingResponse