Share via


Marketplace Registration Definitions Without Scope - List

Gets a list of the marketplace registration definitions for the marketplace identifier.

GET https://management.azure.com/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions?api-version=2022-10-01
GET https://management.azure.com/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions?$filter={$filter}&api-version=2022-10-01

URI Parameters

Name In Required Type Description
api-version
query True

string

The API version to use for this operation.

$filter
query

string

The filter query parameter to filter managed services resources by.

Responses

Name Type Description
200 OK

MarketplaceRegistrationDefinitionList

OK - Returns a list of the marketplace registration definitions.

Other Status Codes

ErrorResponse

The error response describing why the operation failed.

Security

azure_auth

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get Marketplace Registration Definitions At Tenant Scope

Sample request

GET https://management.azure.com/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions?$filter=planIdentifier eq 'publisher.offerIdentifier.planName.version'&api-version=2022-10-01

Sample response

{
  "value": [
    {
      "properties": {
        "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc",
        "authorizations": [
          {
            "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
          },
          {
            "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "User Access Administrator",
            "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
            "delegatedRoleDefinitionIds": [
              "b24988ac-6180-42a0-ab88-20f7382dd24c"
            ]
          }
        ],
        "eligibleAuthorizations": [],
        "offerDisplayName": "Marketplace Test Offer",
        "publisherDisplayName": "Marketplace Test Publisher",
        "planDisplayName": "Test Plan"
      },
      "plan": {
        "name": "test-plan",
        "product": "test",
        "publisher": "marketplace-test",
        "version": "1.0.0"
      },
      "id": "/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/marketplace-test.test.test-plan.1.0.0",
      "type": "Microsoft.ManagedServices/marketplaceRegistrationDefinitions",
      "name": "marketplace-test.test.test-plan.1.0.0"
    }
  ]
}

Definitions

Name Description
Authorization

The Azure Active Directory principal identifier and Azure built-in role that describes the access the principal will receive on the delegated resource in the managed tenant.

EligibleApprover

Defines the Azure Active Directory principal that can approve any just-in-time access requests by the principal defined in the EligibleAuthorization.

EligibleAuthorization

The Azure Active Directory principal identifier, Azure built-in role, and just-in-time access policy that describes the just-in-time access the principal will receive on the delegated resource in the managed tenant.

ErrorDefinition

The error response indicating why the incoming request wasn’t able to be processed

ErrorResponse

Error response.

JustInTimeAccessPolicy

Just-in-time access policy setting.

MarketplaceRegistrationDefinition
MarketplaceRegistrationDefinitionList

The list of marketplace registration definitions.

MarketplaceRegistrationDefinitionProperties

The properties of the marketplace registration definition.

MultiFactorAuthProvider

The multi-factor authorization provider to be used for just-in-time access requests.

Plan

The details for the Managed Services offer’s plan in Azure Marketplace.

Authorization

The Azure Active Directory principal identifier and Azure built-in role that describes the access the principal will receive on the delegated resource in the managed tenant.

Name Type Description
delegatedRoleDefinitionIds

string[] (uuid)

The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals.

principalId

string

The identifier of the Azure Active Directory principal.

principalIdDisplayName

string

The display name of the Azure Active Directory principal.

roleDefinitionId

string

The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope.

EligibleApprover

Defines the Azure Active Directory principal that can approve any just-in-time access requests by the principal defined in the EligibleAuthorization.

Name Type Description
principalId

string

The identifier of the Azure Active Directory principal.

principalIdDisplayName

string

The display name of the Azure Active Directory principal.

EligibleAuthorization

The Azure Active Directory principal identifier, Azure built-in role, and just-in-time access policy that describes the just-in-time access the principal will receive on the delegated resource in the managed tenant.

Name Type Description
justInTimeAccessPolicy

JustInTimeAccessPolicy

The just-in-time access policy setting.

principalId

string

The identifier of the Azure Active Directory principal.

principalIdDisplayName

string

The display name of the Azure Active Directory principal.

roleDefinitionId

string

The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope.

ErrorDefinition

The error response indicating why the incoming request wasn’t able to be processed

Name Type Description
code

string

The error code.

details

ErrorDefinition[]

The internal error details.

message

string

The error message indicating why the operation failed.

ErrorResponse

Error response.

Name Type Description
error

ErrorDefinition

The error details.

JustInTimeAccessPolicy

Just-in-time access policy setting.

Name Type Default value Description
managedByTenantApprovers

EligibleApprover[]

The list of managedByTenant approvers for the eligible authorization.

maximumActivationDuration

string (duration)

PT8H

The maximum access duration in ISO 8601 format for just-in-time access requests.

multiFactorAuthProvider

MultiFactorAuthProvider

None

The multi-factor authorization provider to be used for just-in-time access requests.

MarketplaceRegistrationDefinition

Name Type Description
id

string

The fully qualified path of the marketplace registration definition.

name

string

The name of the marketplace registration definition.

plan

Plan

The details for the Managed Services offer’s plan in Azure Marketplace.

properties

MarketplaceRegistrationDefinitionProperties

The properties of the marketplace registration definition.

type

string

The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions).

MarketplaceRegistrationDefinitionList

The list of marketplace registration definitions.

Name Type Description
nextLink

string

The link to the next page of marketplace registration definitions.

value

MarketplaceRegistrationDefinition[]

The list of marketplace registration definitions.

MarketplaceRegistrationDefinitionProperties

The properties of the marketplace registration definition.

Name Type Description
authorizations

Authorization[]

The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.

eligibleAuthorizations

EligibleAuthorization[]

The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.

managedByTenantId

string

The identifier of the managedBy tenant.

offerDisplayName

string

The marketplace offer display name.

planDisplayName

string

The marketplace plan display name.

publisherDisplayName

string

The marketplace publisher display name.

MultiFactorAuthProvider

The multi-factor authorization provider to be used for just-in-time access requests.

Value Description
Azure
None

Plan

The details for the Managed Services offer’s plan in Azure Marketplace.

Name Type Description
name

string

Azure Marketplace plan name.

product

string

Azure Marketplace product code.

publisher

string

Azure Marketplace publisher ID.

version

string

Azure Marketplace plan's version.