Microsoft.ManagedServices (preview:2020-02-01)

2025/09/19 • 13 new, 13 deleted methods

RegistrationDefinitions_Get (new)
Description :  Gets the registration definition details.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationDefinitionId:
{
Description: The GUID of the registration definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationDefinitions_Delete (new)
Description :  Deletes the registration definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}
{
registrationDefinitionId:
{
Description: The GUID of the registration definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationDefinitions_CreateOrUpdate (new)
Description :  Creates or updates a registration definition.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}
{
registrationDefinitionId:
{
Description: The GUID of the registration definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
requestBody:
{
Description: The parameters required to create a new registration definition. ,
Required: True ,
}
{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_Get (new)
Description :  Gets the details of the specified registration assignment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationAssignmentId:
{
Description: The GUID of the registration assignment. ,
Required: True ,
}
string ,
$expandRegistrationDefinition:
{
Description: The flag indicating whether to return the registration definition details along with the registration assignment details. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_Delete (new)
Description :  Deletes the specified registration assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationAssignmentId:
{
Description: The GUID of the registration assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_CreateOrUpdate (new)
Description :  Creates or updates a registration assignment.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationAssignmentId:
{
Description: The GUID of the registration assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
requestBody:
{
Description: The parameters required to create new registration assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationDefinitions_List (new)
Description :  Gets a list of the registration definitions.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of registration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of registration definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_List (new)
Description :  Gets a list of the registration assignments.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
$expandRegistrationDefinition:
{
Description: The flag indicating whether to return the registration definition details along with the registration assignment details. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of registration assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of registration assignments. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitions_List (new)
Description :  Gets a list of the marketplace registration definitions for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter query parameter to filter marketplace registration definitions by plan identifier, publisher, version etc. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of marketplace registration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of marketplace registration definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitionsWithoutScope_List (new)
Description :  Gets a list of the marketplace registration definitions for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions
{
$filter:
{
Description: The filter query parameter to filter marketplace registration definitions by plan identifier, publisher, version etc. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of marketplace registration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of marketplace registration definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitions_Get (new)
Description :  Get the marketplace registration definition for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/{marketplaceIdentifier}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
marketplaceIdentifier:
{
Description: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitionsWithoutScope_Get (new)
Description :  Get the marketplace registration definition for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/{marketplaceIdentifier}
{
marketplaceIdentifier:
{
Description: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Gets a list of the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ManagedServices/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Microsoft.ManagedServices operations. ,
Required: False ,
}
[
{
name:
{
Description: The operation name with the format: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The service provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The operation type. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationDefinitions_Get (removed)
Description :  Gets the registration definition details.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationDefinitionId:
{
Description: The GUID of the registration definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationDefinitions_Delete (removed)
Description :  Deletes the registration definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}
{
registrationDefinitionId:
{
Description: The GUID of the registration definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationDefinitions_CreateOrUpdate (removed)
Description :  Creates or updates a registration definition.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}
{
registrationDefinitionId:
{
Description: The GUID of the registration definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
requestBody:
{
Description: The parameters required to create a new registration definition. ,
Required: True ,
}
{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_Get (removed)
Description :  Gets the details of the specified registration assignment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationAssignmentId:
{
Description: The GUID of the registration assignment. ,
Required: True ,
}
string ,
$expandRegistrationDefinition:
{
Description: The flag indicating whether to return the registration definition details along with the registration assignment details. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_Delete (removed)
Description :  Deletes the specified registration assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationAssignmentId:
{
Description: The GUID of the registration assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_CreateOrUpdate (removed)
Description :  Creates or updates a registration assignment.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
registrationAssignmentId:
{
Description: The GUID of the registration assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
requestBody:
{
Description: The parameters required to create new registration assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationDefinitions_List (removed)
Description :  Gets a list of the registration definitions.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of registration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a registration definition. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of registration definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RegistrationAssignments_List (removed)
Description :  Gets a list of the registration assignments.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
$expandRegistrationDefinition:
{
Description: The flag indicating whether to return the registration definition details along with the registration assignment details. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of registration assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a registration assignment. ,
Required: False ,
}
{
registrationDefinitionId:
{
Description: The fully qualified path of the registration definition. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration assignment. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDefinition:
{
Description: The registration definition associated with the registration assignment. ,
Required: False ,
}
{
properties:
{
Description: The properties of the registration definition associated with the registration assignment. ,
Required: False ,
}
{
description:
{
Description: The description of the registration definition. ,
Required: False ,
}
string ,
authorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
registrationDefinitionName:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the registration definition. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
manageeTenantId:
{
Description: The identifier of the managed tenant. ,
Required: False ,
}
string ,
manageeTenantName:
{
Description: The name of the managed tenant. ,
Required: False ,
}
string ,
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: False ,
}
string ,
managedByTenantName:
{
Description: The name of the managedBy tenant. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration definition. ,
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: The fully qualified path of the registration assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments). ,
Required: False ,
}
string ,
name:
{
Description: The name of the registration assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of registration assignments. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitions_List (removed)
Description :  Gets a list of the marketplace registration definitions for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter query parameter to filter marketplace registration definitions by plan identifier, publisher, version etc. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of marketplace registration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of marketplace registration definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitionsWithoutScope_List (removed)
Description :  Gets a list of the marketplace registration definitions for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions
{
$filter:
{
Description: The filter query parameter to filter marketplace registration definitions by plan identifier, publisher, version etc. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of marketplace registration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of marketplace registration definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitions_Get (removed)
Description :  Get the marketplace registration definition for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/{marketplaceIdentifier}
{
scope:
{
Description: The scope of the resource. ,
Required: True ,
}
string ,
marketplaceIdentifier:
{
Description: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceRegistrationDefinitionsWithoutScope_Get (removed)
Description :  Get the marketplace registration definition for the marketplace identifier.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/{marketplaceIdentifier}
{
marketplaceIdentifier:
{
Description: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the marketplace registration definition. ,
Required: False ,
}
{
managedByTenantId:
{
Description: The identifier of the managedBy tenant. ,
Required: True ,
}
string ,
authorizations:
{
Description: 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. ,
Required: True ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
delegatedRoleDefinitionIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
eligibleAuthorizations:
{
Description: 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. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. ,
Required: True ,
}
string ,
justInTimeAccessPolicy:
{
Description: The just-in-time access policy setting. ,
Required: False ,
}
{
multiFactorAuthProvider:
{
Description: The multi-factor authorization provider to be used for just-in-time access requests. ,
Enum:
{
Azure: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
maximumActivationDuration:
{
Description: The maximum access duration in ISO 8601 format for just-in-time access requests. ,
Format: duration ,
Required: False ,
}
string ,
managedByTenantApprovers:
{
Description: The list of managedByTenant approvers for the eligible authorization. ,
Required: False ,
}
[
{
principalId:
{
Description: The identifier of the Azure Active Directory principal. ,
Required: True ,
}
string ,
principalIdDisplayName:
{
Description: The display name of the Azure Active Directory principal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
offerDisplayName:
{
Description: The marketplace offer display name. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The marketplace publisher display name. ,
Required: False ,
}
string ,
planDisplayName:
{
Description: The marketplace plan display name. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The details for the Managed Services offer’s plan in Azure Marketplace. ,
Required: False ,
}
{
name:
{
Description: Azure Marketplace plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: Azure Marketplace publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Azure Marketplace product code. ,
Required: True ,
}
string ,
version:
{
Description: Azure Marketplace plan's version. ,
Required: True ,
}
string ,
}
,
id:
{
Description: The fully qualified path of the marketplace registration definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions). ,
Required: False ,
}
string ,
name:
{
Description: The name of the marketplace registration definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Gets a list of the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ManagedServices/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Microsoft.ManagedServices operations. ,
Required: False ,
}
[
{
name:
{
Description: The operation name with the format: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The service provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The operation type. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message indicating why the operation failed. ,
Required: True ,
}
string ,
details:
{
Description: The internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}